Skip to main content

Plugin mtcli para cálculo e exibição de Volume Profile no terminal

Project description

mtcli-volume

Plugin do mtcli para cálculo e visualização de Volume Profile diretamente no terminal, com foco em:

  • Precisão técnica (distribuição High–Low)
  • Leitura profissional de mercado
  • Total acessibilidade (screen reader friendly)
  • Integração com MetaTrader 5

Principais recursos

  • Volume Profile por faixa High–Low

    • O volume de cada candle é distribuído uniformemente entre todas as faixas de preço tocadas entre o LOW e o HIGH
    • Modelo mais próximo do Volume Profile clássico (VAP)
  • Estatísticas de Market Profile

    • POC (Point of Control)
    • Área de Valor (70%)
    • HVNs e LVNs com critérios profissionais
  • ⚙️ Critérios avançados para HVN/LVN

    • Baseado na média (multiplicadores)
    • Baseado em percentis (ex: 80% / 20%)
  • 100% acessível

    • Saída textual linear
    • Compatível com NVDA, JAWS e leitores de tela
    • Sem dependência de cores ou gráficos visuais
  • Arquitetura MVC

    • Model: cálculos e dados
    • Controller: fluxo de negócio
    • View: apresentação no terminal
    • CLI: interface de linha de comando

Instalação

Via PyPI:

pip install mtcli-volume

Ou com Poetry:

poetry add mtcli-volume

⚠️ Requer MetaTrader 5 instalado e configurado corretamente no sistema.


Uso básico

Após a instalação, o comando é registrado automaticamente no mtcli:

mt vp

Exemplo completo:

mt vp \
  --symbol WING26 \
  --period m1 \
  --limit 500 \
  --range 100 \
  --volume tick \
  --hvn-criterio media \
  --verbose

🔧 Opções disponíveis

Opção Descrição
--symbol, -s Símbolo do ativo (ex: WIN, WDO, PETR4)
--period, -p Timeframe (m1, m5, m15, h1, etc.)
--limit, -l Quantidade de candles analisados
--range, -r Tamanho da faixa de preço
--volume, -v Tipo de volume (tick ou real)
--inicio, -i Data/hora inicial (YYYY-MM-DD HH:MM)
--fim, -f Data/hora final (YYYY-MM-DD HH:MM)
--timezone, -tz Fuso horário para exibição
--hvn-criterio Critério de HVN/LVN (media ou percentil)
--verbose, -vv Exibe informações detalhadas

Metodologia de cálculo

Volume Profile

  • Cada candle contribui volume para todas as faixas de preço entre seu low e high
  • O volume é distribuído uniformemente
  • Evita o viés de concentrar volume apenas no preço de fechamento

HVN / LVN

Critérios disponíveis:

  • Média

    • HVN: volume ≥ média × multiplicador
    • LVN: volume ≤ média × multiplicador
  • Percentil

    • HVN: acima do percentil superior (ex: 80%)
    • LVN: abaixo do percentil inferior (ex: 20%)

Acessibilidade

Este plugin foi projetado para uso total com leitores de tela:

  • Tabelas em texto puro
  • Distribuição expressa em percentuais
  • Estatísticas narráveis
  • Sem gráficos ASCII ruidosos

Funciona corretamente com:

  • NVDA
  • JAWS
  • VoiceOver (terminal)

Arquitetura

mtcli_volume/
├── cli.py         # Interface de linha de comando
├── controller.py  # Orquestração do fluxo
├── model.py       # Cálculos e acesso ao MT5
├── view.py        # Apresentação acessível
├── conf.py        # Configurações padrão
└── plugin.py      # Registro no mtcli

Exemplo de saída

Volume Profile — WING26

Preço           | Volume        | Distribuição
-------------------------------------------------------
186300.00       | 18.250        | 72.4% do máximo
186200.00       | 25.190        | 100.0% do máximo
186100.00       | 14.880        | 59.1% do máximo

Estatísticas
POC             : 186200.00
Área de Valor   : 185900.00 → 186300.00
HVNs            : 186200.00, 186100.00
LVNs            : 185700.00

Testes

O plugin foi projetado para facilitar testes unitários do cálculo no model.py, permitindo validação independente do MetaTrader 5.


Contribuição

Pull requests são bem-vindos, especialmente para:

  • Novos critérios de HVN/LVN
  • Value Area expandida a partir do POC
  • Modo TPO
  • Integração com VWAP e Footprint

Licença

GPL License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mtcli_volume-2.4.3.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mtcli_volume-2.4.3-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file mtcli_volume-2.4.3.tar.gz.

File metadata

  • Download URL: mtcli_volume-2.4.3.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.13.7 Windows/11

File hashes

Hashes for mtcli_volume-2.4.3.tar.gz
Algorithm Hash digest
SHA256 fffe9855c30a74b6e207b399bb5f3e46f64c25d51455ba594b7e19d940c4529e
MD5 04888fad5d9c546222af489db029005c
BLAKE2b-256 1c68a967763f162cc37d3f6bd367bc28055399f1347f2d8fb02295e99162215d

See more details on using hashes here.

File details

Details for the file mtcli_volume-2.4.3-py3-none-any.whl.

File metadata

  • Download URL: mtcli_volume-2.4.3-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.13.7 Windows/11

File hashes

Hashes for mtcli_volume-2.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 de98f4435763ad5bd2eb2cb9a3f9465f4a803924723a0373c7464244e7e92d71
MD5 9d686489abb432c7764c3a3bf049a9ac
BLAKE2b-256 111cd8a2ceda6f20ccce2710777021192d8761c56f16fafe5888ddff9259dd4e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page