Skip to main content

Plugin mtcli para exibição do market profile

Project description

mtcli-market

Plugin para o mtcli que calcula e exibe o Market Profile de um ativo no MetaTrader 5 (MT5), em formato totalmente textual e acessível — ideal para uso com leitores de tela como NVDA ou JAWS.

O plugin segue rigorosamente o padrão MVC (Model–View–Controller):

  • O Model realiza todos os cálculos técnicos (TPO, POC, Value Area, HVN, LVN, IB etc.);
  • O Controller apenas orquestra o fluxo de dados;
  • A View apresenta o resultado em texto puro, sem caracteres gráficos.

📦 Instalação

Assumindo que o mtcli e seus módulos estão instalados no mesmo ambiente Python:

pip install -e .

Ou, se o projeto estiver em repositório separado:

pip install git+https://github.com/seuusuario/mtcli-market.git

🚀 Uso

O comando principal é mtcli-market profile (ou python -m mtcli_market.profile).

Exemplo:

mtcli market --symbol WINZ25 --bars 500 --by volume --block 5 --timeframe 15m

Exemplo em modo verboso (detalhado):

mtcli market --symbol WDOZ25 --by ticks --timeframe H1 --verbose

Exemplo em modo compacto (ideal para automação ou leitura programática):

mtcli market --symbol PETR4 --by volume --compact

⚙️ Opções disponíveis

Opção Descrição Padrão
--symbol, -s Código do ativo (ex: WINZ25, WDOZ25, PETR4) Configuração em mtcli_market.conf
--bars, -b Número de candles a considerar 100
--block, -k Tamanho do bloco de preço (em pontos) 5
--by Base de cálculo: time, ticks ou volume time
--timeframe Timeframe: M1, M5, H1, D1 ou customizado (2m, 45m, 2h, 3d) M1
--ib-minutes Duração do Initial Balance (em minutos) 30
--va-percent Percentual da Value Area (0.7 = 70%) 0.7
--compact/--verbose Saída compacta (curta) ou detalhada False

📊 Métricas Calculadas

O Market Profile textual exibe as seguintes informações:

Sigla Nome Descrição
POC Point of Control Nível de preço com maior volume ou TPO
TPO Time Price Opportunity Quantidade de vezes que o preço foi negociado
VAH / VAL Value Area High / Low Faixa de preços que cobre cerca de 70% da atividade
HVN High Volume Nodes Áreas de alto volume — zonas de aceitação
LVN Low Volume Nodes Áreas de baixo volume — zonas de rejeição
IB Initial Balance Faixa de preço dos primeiros minutos definidos (ex: 30 minutos)

♿ Acessibilidade

  • Todo o output é texto puro (sem gráficos ou caracteres de formatação).
  • Compatível com NVDA, JAWS e outros leitores de tela.
  • Ideal para usuários com deficiência visual que operam no mercado financeiro via terminal.

🧱 Estrutura do Projeto

mtcli_market/
├── profile.py                # CLI principal
├── controllers/
│   └── profile_controller.py # Orquestra o fluxo MVC
├── models/
│   └── profile_model.py      # Cálculos de POC, VA, HVN, LVN, IB, etc.
└── views/
    └── profile_view.py       # Saída textual e acessível

🧩 Integração com outros plugins

O mtcli-market pode ser combinado com outros plugins do ecossistema mtcli, como:

  • mtcli-rvo: volume relativo
  • mtcli-trade: execução e controle de posições
  • mtcli-volume: análise de volume e saldo de agressão

🧪 Testes

O projeto usa pytest:

pytest -v

Testes simulam conexões MT5 e validam cálculos de POC, VA, HVN, LVN e IB.


📄 Licença

Este projeto é licenciado sob a GPL-3.0.


🧠 Autor

Desenvolvido por Valmir França — parte do projeto mtcli, uma suíte de ferramentas em linha de comando para análise e automação no MetaTrader 5.


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_market-1.1.0.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

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

mtcli_market-1.1.0-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file mtcli_market-1.1.0.tar.gz.

File metadata

  • Download URL: mtcli_market-1.1.0.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.10 Windows/11

File hashes

Hashes for mtcli_market-1.1.0.tar.gz
Algorithm Hash digest
SHA256 9b8fef9d1bddcb743ab284fcfe6b23f3ea8f2112e4eb9b6441b26ee35f2e61c4
MD5 06d5d9a55917dff08ac5013d2bd8245a
BLAKE2b-256 4f679cf4e21196d18bd7da517be2d9340b453cbdd81c0895fe45b2a6744e77a8

See more details on using hashes here.

File details

Details for the file mtcli_market-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: mtcli_market-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.10 Windows/11

File hashes

Hashes for mtcli_market-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36a309bd26c26776f37b29a31a7a51b614f49c8c9c6ea0958c6ae3423ab28918
MD5 f7af939223ca916f47eb36af0e60c149
BLAKE2b-256 2016dd07c2cfbb3564a1080606a7d8365a93832a5792eac3e3e2b8c5a3b1faba

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