QuantBrasil
Documentação
CLI

JSON e automações

Saída estruturada, códigos de erro e boas práticas para scripts e agentes.

Use --json quando outro programa for consumir a resposta:

quantbrasil market price PETR4 --json
quantbrasil holdings list --json

A estrutura de cada resposta está documentada na seção "Saída (--json)" da página do comando, na referência. Relatórios extensos, como o de backtests run, também aceitam --compact, uma visão reduzida da mesma resposta.

Erros

Em caso de falha, a CLI escreve o erro no stderr e encerra com código diferente de zero. Com --json, o erro também sai como uma estrutura estável:

{
  "ok": false,
  "error": {
    "code": "rate_limited",
    "message": "Limite de uso atingido. Tente novamente em instantes.",
    "category": "backend",
    "exit_code": 1,
    "status": 429,
    "retry_after_seconds": 42
  }
}

O campo code identifica o tipo de falha e serve para decidir o tratamento no script. Quando a API aplica os limites de uso, o payload traz retry_after_seconds com o tempo de espera antes da próxima tentativa.

Descoberta programática

Consulte quantbrasil capabilities --json para descobrir a superfície pública de forma programática, com rota, parâmetros e exemplos de cada operação.