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.5.1.tar.gz (20.1 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.5.1-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mtcli_volume-2.5.1.tar.gz
  • Upload date:
  • Size: 20.1 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.5.1.tar.gz
Algorithm Hash digest
SHA256 3721beb7b6e139742741bfc1afd6861c4151ee6549481c8911bb36174da76d08
MD5 78a219a60bf5e95a7ed0b012784c6d6e
BLAKE2b-256 64fe9083ac6df1a1c51c55e2dfa3dc7aea54bf74c5caf86e3b66fed8e9742293

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mtcli_volume-2.5.1-py3-none-any.whl
  • Upload date:
  • Size: 22.7 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.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 058201d6a158c20679bf4f01325704ae2c4be8a4a669718a005e4272f9658dea
MD5 73b8e223b8868e74c42c38ded12c3561
BLAKE2b-256 dd1290a84d05f9336f0a87d078a4fabe5c9cb44e83f2196b898fde8351f0f233

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