Dicionário de campos da API
Carregando conteúdo...
FOR LLMs: add .md to any documentation URL to get the page as Markdown. Example: /docs/acoes/dividendos.md. The index of all pages is at /llms.txt.
Carregando documentação...
Lista os campos da API com nome em português, descrição, fórmula de cálculo, tipo, unidade, categoria e os endpoints onde cada campo aparece.
Use para gerar rótulos e tooltips, formatar valores pela unidade e entender um campo antes de usar.
category filtra por área, como fii, treasury ou balance-sheet.
search busca em chave, nome, descrição, categoria e endpoints. Os dois
funcionam juntos. Endpoint público, sem token.
Texto buscado em key, label, description, category e endpoints. Ignora maiúsculas.
Categoria exata do campo. Ex.: fii, treasury, quote, balance-sheet.
application/json
curl -X GET "https://example.com/api/v2/dictionary"{ "fields": [ { "key": "symbol", "label": "Símbolo", "description": "Código de negociação do ativo brasileiro (ex: PETR4, VALE3)", "calculation": null, "endpoints": [ "/api/quote/{tickers}", "/api/quote/list" ], "category": "quote", "type": "string", "unit": null }, { "key": "shortName", "label": "Nome Curto", "description": "Nome resumido do ativo", "calculation": null, "endpoints": [ "/api/quote/{tickers}", "/api/quote/list" ], "category": "quote", "type": "string", "unit": null }, { "key": "longName", "label": "Nome Completo", "description": "Nome completo da empresa ou fundo", "calculation": null, "endpoints": [ "/api/quote/{tickers}" ], "category": "quote", "type": "string", "unit": null } ], "requestedAt": "2026-02-08T16:25:35.000Z", "took": 2}| Categoria | Campos de | Exemplo de endpoint |
|---|---|---|
quote | Cotação de ações, FIIs, ETFs e BDRs | /api/quote/{tickers} |
historical | Histórico de preços e volume | /api/quote/{tickers} |
financial-data | Receita, EBITDA e margens | /api/quote/{tickers}?modules=financialData |
balance-sheet | Balanço patrimonial | /api/quote/{tickers}?modules=balanceSheetHistory |
income-statement | DRE | /api/quote/{tickers}?modules=incomeStatementHistory |
cash-flow | Fluxo de caixa | /api/quote/{tickers}?modules=cashflowHistory |
value-added | DVA | /api/quote/{tickers}?modules=valueAddedHistory |
statistics | P/L, ROE e valor de mercado | /api/quote/{tickers}?modules=defaultKeyStatistics |
dividends | Dividendos e JCP | /api/quote/{tickers}?dividends=true |
fii | Indicadores de FIIs | /api/v2/fii/indicators |
fii-reports | Informes mensais de FIIs | /api/v2/fii/reports |
fii-portfolio | Carteira de FIIs | /api/v2/fii/portfolio |
fii-properties | Imóveis de FIIs | /api/v2/fii/properties |
treasury | Taxas e preços do Tesouro Direto | /api/v2/treasury/indicators |
options | Métricas de opções | /api/v2/options/analytics |
futures | Contratos futuros | /api/v2/futures/quote |
future-options | Opções sobre futuros | /api/v2/futures/options/chain |
crypto | Criptomoedas | /api/v2/crypto |
currency | Câmbio | /api/v2/currency |
inflation | Inflação | /api/v2/inflation |
prime-rate | Selic | /api/v2/prime-rate |
Um campo vem como null quando o dado não existe para aquele ativo ou período.
Os casos mais comuns:
costOfRevenue, grossProfit, inventories e accountsReceivable não se
aplicam a eles. Campos como deposits e loansNet só existem para bancos.^BVSP não têm balanço de empresa. Campos como
grossProfit e ebitda vêm como null. Para FIIs, use as categorias que
começam com fii.calculation é null nos campos que não são calculados.