O endpoint legado /api/quote/{tickers} continua funcionando e não tem data de
remoção. Ainda assim, integrações novas ficam melhores nos endpoints v2, onde
descoberta de ticker, cotação, histórico, dividendos e fundamentos são chamadas
separadas. Você pede só o dado que vai usar, e a resposta chega menor.
/api/v2/tickers para buscar, filtrar e validar símbolos./api/v2/tickers/resolve quando o usuário informar um ticker antigo./api/v2/tickers/renames para mostrar histórico de mudanças de código./api/v2/tickers/coverage para decidir qual endpoint consultar.| Legado | V2 recomendado |
|---|---|
/api/quote/list | /api/v2/tickers |
/api/quote/PETR4 | /api/v2/stocks/quote?symbols=PETR4 |
/api/quote/PETR4,VALE3 | /api/v2/stocks/quote?symbols=PETR4,VALE3 |
/api/quote/PETR4?range=1y&interval=1d | /api/v2/stocks/historical?symbols=PETR4&range=1y&interval=1d |
/api/quote/PETR4?startDate=2024-01-01&endDate=2024-12-31 | /api/v2/stocks/historical?symbols=PETR4&startDate=2024-01-01&endDate=2024-12-31 |
/api/quote/PETR4?dividends=true | /api/v2/stocks/dividends?symbols=PETR4 |
Rendimentos de FII continuam em /api/v2/fii/dividends. A fonte e o calendário
são diferentes dos de ações, então /api/v2/stocks/dividends não serve para
fundos imobiliários.
O envelope { results, requestedAt, took } continua igual. Muda o que vem
dentro de results[].data.
| V2 | Campo principal |
|---|---|
/api/v2/stocks/quote | results[].data.regularMarketPrice, results[].data.regularMarketChangePercent, results[].data.marketCap |
/api/v2/stocks/historical | results[].data.historicalDataPrice |
/api/v2/stocks/dividends | results[].data.cashDividends, results[].data.stockDividends, results[].data.subscriptions |
/api/v2/stocks/profile | results[].data |
/api/v2/stocks/statistics | results[].data |
/api/v2/stocks/financial-data | results[].data |
/api/v2/stocks/balance-sheet | results[].data |
/api/v2/stocks/income-statement | results[].data |
/api/v2/stocks/cash-flow | results[].data |
/api/v2/stocks/value-added | results[].data |
Quando a brapi resolve um ticker antigo, o item traz requestedSymbol, symbol
e changed. Use esses campos para avisar o usuário que o código mudou.
| Módulo legado | V2 recomendado |
|---|---|
summaryProfile | /api/v2/stocks/profile?symbols=PETR4 |
defaultKeyStatistics | /api/v2/stocks/statistics?symbols=PETR4&mode=current |
defaultKeyStatisticsHistory | /api/v2/stocks/statistics?symbols=PETR4&mode=history&period=annual |
defaultKeyStatisticsHistoryQuarterly | /api/v2/stocks/statistics?symbols=PETR4&mode=history&period=quarterly |
financialData | /api/v2/stocks/financial-data?symbols=PETR4&mode=current |
financialDataHistory | /api/v2/stocks/financial-data?symbols=PETR4&mode=history&period=annual |
financialDataHistoryQuarterly | /api/v2/stocks/financial-data?symbols=PETR4&mode=history&period=quarterly |
balanceSheetHistory | /api/v2/stocks/balance-sheet?symbols=PETR4&period=annual |
balanceSheetHistoryQuarterly | /api/v2/stocks/balance-sheet?symbols=PETR4&period=quarterly |
incomeStatementHistory | /api/v2/stocks/income-statement?symbols=PETR4&period=annual |
incomeStatementHistoryQuarterly | /api/v2/stocks/income-statement?symbols=PETR4&period=quarterly |
cashflowHistory | /api/v2/stocks/cash-flow?symbols=PETR4&period=annual |
cashflowHistoryQuarterly | /api/v2/stocks/cash-flow?symbols=PETR4&period=quarterly |
valueAddedHistory | /api/v2/stocks/value-added?symbols=PETR4&period=annual |
valueAddedHistoryQuarterly | /api/v2/stocks/value-added?symbols=PETR4&period=quarterly |
Se a integração já roda e o contrato não pode mudar, fique em
/api/quote/{tickers}. Ele não vai sumir sem aviso, e a
política de versionamento descreve como um aviso desses
chegaria.