Schema OpenAPI
A especificação completa da API brapi está disponível no formato OpenAPI 3.0 (anteriormente conhecido como Swagger). Esta documentação técnica contém todos os endpoints, parâmetros, schemas de resposta e exemplos de uso.
Download e Visualização
Você pode baixar o arquivo JSON da especificação ou visualizar o arquivo JSON online.
Schema Completa
Especificação completa da API brapi em formato OpenAPI 3.0 para dados de ações, moedas, criptomoedas, inflação, etc.
{
"openapi": "3.0.0",
"info": {
"title": "Brapi - API do Mercado Financeiro Brasileiro",
"version": "3.0.0",
"description": "Acesso instantâneo a dados do mercado financeiro brasileiro e internacional.\n\n**Recursos Principais:**\n\n* **Cotações:** Obtenha valores de cotação e históricos para ações (B3), fundos imobiliários (FIIs), BDRs, índices e ETFs.\n* **Criptomoedas:** Consulte cotações e dados históricos de diversas criptomoedas em várias moedas fiduciárias.\n* **Moedas:** Acesse taxas de câmbio entre diferentes moedas.\n* **Dados Fundamentalistas:** Obtenha dados financeiros detalhados de empresas listadas (requer módulos específicos).\n* **Dividendos:** Consulte informações sobre pagamentos de dividendos e JCP.\n* **Inflação:** Acesse índices de inflação históricos para diferentes países.\n\nUtilize esta API para integrar dados financeiros robustos em suas aplicações, dashboards ou análises.\n\n**Website Oficial:** [https://brapi.dev](https://brapi.dev)",
"contact": {
"name": "Brapi",
"url": "https://brapi.dev",
"email": "contact@brapi.dev"
}
},
"servers": [
{
"url": "https://brapi.dev",
"description": "Servidor principal da API Brapi"
},
{
"url": "http://localhost:3000",
"description": "Servidor local para desenvolvimento"
}
],
"paths": {
"/api/quote/{tickers}": {
"get": {
"summary": "Buscar Cotação Detalhada de Ativos Financeiros",
"description": "Este endpoint é a principal forma de obter informações detalhadas sobre um ou mais ativos financeiros (ações, FIIs, ETFs, BDRs, índices) listados na B3, identificados pelos seus respectivos **tickers**.\n\n### Funcionalidades Principais:\n\n* **Cotação Atual:** Retorna o preço mais recente, variação diária, máximas, mínimas, volume, etc.\n* **Dados Históricos:** Permite solicitar séries históricas de preços usando os parâmetros `range` e `interval`.\n* **Dados Fundamentalistas:** Opcionalmente, inclui dados fundamentalistas básicos (P/L, LPA) com o parâmetro `fundamental=true`.\n* **Dividendos:** Opcionalmente, inclui histórico de dividendos e JCP com `dividends=true`.\n* **Módulos Adicionais:** Permite requisitar conjuntos de dados financeiros mais aprofundados através do parâmetro `modules` (veja detalhes abaixo).\n\n### 🧪 Ações de Teste (Sem Autenticação):\n\nPara facilitar o desenvolvimento e teste, as seguintes **4 ações têm acesso irrestrito** e **não requerem autenticação**:\n\n* **PETR4** (Petrobras PN)\n* **MGLU3** (Magazine Luiza ON) \n* **VALE3** (Vale ON)\n* **ITUB4** (Itaú Unibanco PN)\n\n**Importante:** Você pode consultar essas ações sem token e com acesso a todos os recursos (históricos, módulos, dividendos). Porém, se misturar essas ações com outras na mesma requisição, a autenticação será obrigatória.\n\n### Autenticação:\n\nPara **outras ações** (além das 4 de teste), é **obrigatório** fornecer um token de autenticação válido, seja via query parameter `token` ou via header `Authorization: Bearer seu_token`.\n\n### Exemplos de Requisição:\n\n**1. Cotação simples de PETR4 e VALE3 (ações de teste - sem token):**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/quote/PETR4,VALE3\"\n```\n\n**2. Cotação de MGLU3 com dados históricos do último mês (ação de teste - sem token):**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/quote/MGLU3?range=1mo&interval=1d\"\n```\n\n**3. Cotação de ITUB4 incluindo dividendos e dados fundamentalistas (ação de teste - sem token):**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/quote/ITUB4?fundamental=true÷nds=true\"\n```\n\n**4. Cotação de WEGE3 com Resumo da Empresa e Balanço Patrimonial Anual (via módulos - requer token):**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/quote/WEGE3?modules=summaryProfile,balanceSheetHistory&token=SEU_TOKEN\"\n```\n\n**5. Exemplo de requisição mista (requer token):**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/quote/PETR4,BBAS3?token=SEU_TOKEN\"\n```\n\n*Nota: Como BBAS3 não é uma ação de teste, toda a requisição requer autenticação, mesmo contendo PETR4.*\n\n### Parâmetro `modules` (Detalhado):\n\nO parâmetro `modules` é extremamente poderoso para enriquecer a resposta com dados financeiros detalhados. Você pode solicitar um ou mais módulos, separados por vírgula.\n\n**Módulos Disponíveis:**\n\n* `summaryProfile`: Informações cadastrais da empresa (endereço, setor, descrição do negócio, website, número de funcionários).\n* `balanceSheetHistory`: Histórico **anual** do Balanço Patrimonial.\n* `balanceSheetHistoryQuarterly`: Histórico **trimestral** do Balanço Patrimonial.\n* `defaultKeyStatistics`: Principais estatísticas da empresa (Valor de Mercado, P/L, ROE, Dividend Yield, etc.) - **TTM (Trailing Twelve Months)**.\n* `defaultKeyStatisticsHistory`: Histórico **anual** das Principais Estatísticas.\n* `defaultKeyStatisticsHistoryQuarterly`: Histórico **trimestral** das Principais Estatísticas.\n* `incomeStatementHistory`: Histórico **anual** da Demonstração do Resultado do Exercício (DRE).\n* `incomeStatementHistoryQuarterly`: Histórico **trimestral** da Demonstração do Resultado do Exercício (DRE).\n* `financialData`: Dados financeiros selecionados (Receita, Lucro Bruto, EBITDA, Dívida Líquida, Fluxo de Caixa Livre, Margens) - **TTM (Trailing Twelve Months)**.\n* `financialDataHistory`: Histórico **anual** dos Dados Financeiros.\n* `financialDataHistoryQuarterly`: Histórico **trimestral** dos Dados Financeiros.\n* `valueAddedHistory`: Histórico **anual** da Demonstração do Valor Adicionado (DVA).\n* `valueAddedHistoryQuarterly`: Histórico **trimestral** da Demonstração do Valor Adicionado (DVA).\n* `cashflowHistory`: Histórico **anual** da Demonstração do Fluxo de Caixa (DFC).\n* `cashflowHistoryQuarterly`: Histórico **trimestral** da Demonstração do Fluxo de Caixa (DFC).\n\n**Exemplo de Uso do `modules`:**\n\nPara obter a cotação de BBDC4 junto com seu DRE trimestral e Fluxo de Caixa anual:\n\n```bash\ncurl -X GET \"https://brapi.dev/api/quote/BBDC4?modules=incomeStatementHistoryQuarterly,cashflowHistory&token=SEU_TOKEN\"\n```\n\n### Resposta:\n\nA resposta é um objeto JSON contendo a chave `results`, que é um array. Cada elemento do array corresponde a um ticker solicitado e contém os dados da cotação e os módulos adicionais requisitados.\n\n* **Sucesso (200 OK):** Retorna os dados conforme solicitado.\n* **Bad Request (400 Bad Request):** Ocorre se um parâmetro for inválido (ex: `range=invalid`) ou se a formatação estiver incorreta.\n* **Unauthorized (401 Unauthorized):** Token inválido ou ausente.\n* **Payment Required (402 Payment Required):** Limite de requisições do plano atual excedido.\n* **Not Found (404 Not Found):** Um ou mais tickers solicitados não foram encontrados.\n",
"operationId": "getQuote",
"tags": [
"Ações"
],
"parameters": [
{
"name": "tickers",
"in": "path",
"required": true,
"description": "**Obrigatório.** Um ou mais tickers de ativos financeiros (ações, FIIs, índices, etc.) que você deseja consultar. \n\n* **Múltiplos Tickers:** Separe-os por vírgula (`,`).\n* **Exemplos:** `PETR4`, `ITSA4,MGLU3`, `^BVSP` (para o índice Ibovespa).",
"schema": {
"type": "string",
"example": "PETR4,MGLU3"
}
},
{
"$ref": "#/components/parameters/Token"
},
{
"name": "range",
"in": "query",
"required": false,
"description": "**Opcional.** Define o período para os dados históricos de preço (`historicalDataPrice`). Se omitido, apenas a cotação mais recente é retornada (a menos que `interval` seja usado).\n\n**Valores Possíveis:**\n\n* `1d`: Último dia de pregão (intraday se `interval` for minutos/horas).\n* `5d`: Últimos 5 dias.\n* `1mo`: Último mês.\n* `3mo`: Últimos 3 meses.\n* `6mo`: Últimos 6 meses.\n* `1y`: Último ano.\n* `2y`: Últimos 2 anos.\n* `5y`: Últimos 5 anos.\n* `10y`: Últimos 10 anos.\n* `ytd`: Desde o início do ano atual (Year-to-Date).\n* `max`: Todo o período histórico disponível.",
"schema": {
"type": "string",
"enum": [
"1d",
"5d",
"1mo",
"3mo",
"6mo",
"1y",
"2y",
"5y",
"10y",
"ytd",
"max"
],
"example": "5d"
}
},
{
"name": "interval",
"in": "query",
"required": false,
"description": "**Opcional.** Define a granularidade (intervalo) dos dados históricos de preço (`historicalDataPrice`). Requer que `range` também seja especificado.\n\n**Valores Possíveis:**\n\n* `1m`, `2m`, `5m`, `15m`, `30m`, `60m`, `90m`, `1h`: Intervalos intraday (minutos/horas). **Atenção:** Disponibilidade pode variar conforme o `range` e o ativo.\n* `1d`: Diário (padrão se `range` for especificado e `interval` omitido).\n* `5d`: 5 dias.\n* `1wk`: Semanal.\n* `1mo`: Mensal.\n* `3mo`: Trimestral.",
"schema": {
"type": "string",
"enum": [
"1m",
"2m",
"5m",
"15m",
"30m",
"60m",
"90m",
"1h",
"1d",
"5d",
"1wk",
"1mo",
"3mo"
],
"example": "1d"
}
},
{
"name": "fundamental",
"in": "query",
"required": false,
"description": "**Opcional.** Booleano (`true` ou `false`). Se `true`, inclui dados fundamentalistas básicos na resposta, como Preço/Lucro (P/L) e Lucro Por Ação (LPA). \n\n**Nota:** Para dados fundamentalistas mais completos, utilize o parâmetro `modules`.",
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "dividends",
"in": "query",
"required": false,
"description": "**Opcional.** Booleano (`true` ou `false`). Se `true`, inclui informações sobre dividendos e JCP (Juros sobre Capital Próprio) pagos historicamente pelo ativo na chave `dividendsData`.",
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "modules",
"in": "query",
"required": false,
"description": "**Opcional.** Uma lista de módulos de dados adicionais, separados por vírgula (`,`), para incluir na resposta. Permite buscar dados financeiros detalhados.\n\n**Exemplos:**\n\n* `modules=summaryProfile` (retorna perfil da empresa)\n* `modules=balanceSheetHistory,incomeStatementHistory` (retorna histórico anual do BP e DRE)\n\nVeja a descrição principal do endpoint para a lista completa de módulos e seus conteúdos.",
"schema": {
"type": "array",
"description": "Uma lista de módulos de dados adicionais, separados por vírgula (`,`), para incluir na resposta. Permite buscar dados financeiros detalhados.",
"explode": false,
"items": {
"type": "string",
"enum": [
"summaryProfile",
"balanceSheetHistory",
"defaultKeyStatistics",
"balanceSheetHistoryQuarterly",
"incomeStatementHistory",
"incomeStatementHistoryQuarterly",
"financialData",
"financialDataHistory",
"financialDataHistoryQuarterly",
"defaultKeyStatisticsHistory",
"defaultKeyStatisticsHistoryQuarterly",
"valueAddedHistory",
"valueAddedHistoryQuarterly",
"cashflowHistory",
"cashflowHistoryQuarterly"
]
},
"example": [
"summaryProfile",
"balanceSheetHistory",
"financialData"
]
},
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"description": "**Sucesso.** A requisição foi bem-sucedida e os dados dos ativos solicitados foram retornados. A estrutura da resposta inclui um array `results` com os detalhes de cada ativo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteResponse"
},
"example": {
"results": [
{
"currency": "BRL",
"marketCap": 416355902930,
"shortName": "PETROBRAS PN EDJ N2",
"longName": "Petróleo Brasileiro S.A. - Petrobras",
"regularMarketChange": 0.17,
"regularMarketChangePercent": 0.5499999999999999,
"regularMarketTime": "2025-08-29T20:07:36.000Z",
"regularMarketPrice": 31.1,
"regularMarketDayHigh": 31.35,
"regularMarketDayRange": "30.85 - 31.35",
"regularMarketDayLow": 30.85,
"regularMarketVolume": 27631700,
"regularMarketPreviousClose": 30.93,
"regularMarketOpen": 30.54,
"fiftyTwoWeekRange": "28.86 - 40.76",
"fiftyTwoWeekLow": 28.86,
"fiftyTwoWeekHigh": 40.76,
"symbol": "PETR4",
"logourl": "https://icons.brapi.dev/icons/PETR4.svg",
"usedInterval": "1d",
"usedRange": "5d",
"historicalDataPrice": [
{
"date": 1756126800,
"open": 30.47,
"high": 30.78,
"low": 30.42,
"close": 30.65,
"volume": 21075300,
"adjustedClose": 30.65
},
{
"date": 1756213200,
"open": 30.48,
"high": 30.58,
"low": 30.23,
"close": 30.43,
"volume": 21789700,
"adjustedClose": 30.43
},
{
"date": 1756299600,
"open": 30.45,
"high": 30.68,
"low": 30.36,
"close": 30.66,
"volume": 16349100,
"adjustedClose": 30.66
},
{
"date": 1756386000,
"open": 30.78,
"high": 31.13,
"low": 30.71,
"close": 30.93,
"volume": 25802500,
"adjustedClose": 30.93
},
{
"date": 1756472400,
"open": 30.93,
"high": 31.35,
"low": 30.85,
"close": 31.1,
"volume": 27713400,
"adjustedClose": 31.1
}
],
"validRanges": [
"1d",
"2d",
"5d",
"7d",
"1mo",
"3mo",
"6mo",
"1y",
"2y",
"5y",
"10y",
"ytd",
"max"
],
"validIntervals": [
"1m",
"2m",
"5m",
"15m",
"30m",
"60m",
"90m",
"1h",
"1d",
"5d",
"1wk",
"1mo",
"3mo"
],
"balanceSheetHistory": [
{
"symbol": "PETR4",
"type": "yearly",
"endDate": "2024-12-31",
"cash": 20254000000,
"shortTermInvestments": 26397000000,
"netReceivables": 22080000000,
"inventory": 41550000000,
"otherCurrentAssets": 12756000000,
"totalCurrentAssets": 135212000000,
"longTermInvestments": 4081000000,
"propertyPlantEquipment": 843917000000,
"otherAssets": 989585000000,
"totalAssets": 1124797000000,
"accountsPayable": 37659000000,
"shortLongTermDebt": 68783000000,
"otherCurrentLiab": 4418000000,
"longTermDebt": 304684000000,
"otherLiab": 3284000000,
"totalCurrentLiabilities": 194808000000,
"totalLiab": 1124797000000,
"commonStock": 205432000000,
"retainedEarnings": null,
"treasuryStock": null,
"otherStockholderEquity": -2457000000,
"totalStockholderEquity": 367514000000,
"netTangibleAssets": null,
"goodWill": null,
"intangibleAssets": 13961000000,
"deferredLongTermAssetCharges": null,
"deferredLongTermLiab": 9100000000,
"minorityInterest": 1508000000,
"capitalSurplus": null,
"taxesToRecover": 12175000000,
"longTermAssets": 989585000000,
"longTermRealizableAssets": 127626000000,
"longTermReceivables": 7777000000,
"longTermDeferredTaxes": 28011000000,
"otherNonCurrentAssets": 88233000000,
"nonCurrentAssets": 1359748000000,
"provisions": 15501000000,
"shareholdersEquity": 367514000000,
"realizedShareCapital": 205432000000,
"capitalReserves": -2457000000,
"profitReserves": 95193000000,
"otherComprehensiveResults": 67838000000,
"currentLiabilities": 194808000000,
"socialAndLaborObligations": 9336000000,
"providers": 37659000000,
"taxObligations": 8671000000,
"loansAndFinancing": 68783000000,
"leaseFinancing": 52896000000,
"otherObligations": 3256000000,
"otherCurrentLiabilities": 4418000000,
"nonCurrentLiabilities": 562475000000,
"longTermLoansAndFinancing": 304684000000,
"longTermLeaseFinancing": 177145000000,
"otherLongTermObligations": 3284000000,
"longTermProvisions": 245407000000,
"updatedAt": "2024-12-31"
}
],
"summaryProfile": {
"symbol": "PETR4",
"address1": "Avenida RepUblica do Chile, 65",
"address2": "Centro",
"address3": null,
"city": "Rio De Janeiro",
"state": "RJ",
"zip": "20031-912",
"country": "Brazil",
"phone": "55 21 96940 2116",
"fax": null,
"website": "https://petrobras.com.br",
"industry": "Oil & Gas Integrated",
"industryKey": "oil-gas-integrated",
"industryDisp": "Oil & Gas Integrated",
"sector": "Energy",
"sectorKey": "energy",
"sectorDisp": "Energy",
"longBusinessSummary": "Petróleo Brasileiro S.A. - Petrobras explores, produces, and sells oil and gas in Brazil and internationally. The company operates through Exploration and Production; Refining, Transportation and Marketing; and Gas and Power. It also engages in prospecting, drilling, refining, processing, trading, and transporting crude oil from producing onshore and offshore oil fields, and shale or other rocks, as well as oil products, natural gas, and other liquid hydrocarbons. The Exploration and Production segment explores, develops, and produces crude oil, natural gas liquids, and natural gas primarily for supplies to the domestic refineries. The Refining, Transportation and Marketing segment engages in the refining, logistics, transport, marketing, and trading of crude oil and oil products; exportation of ethanol; and extraction and processing of shale, as well as holding interests in petrochemical companies. The Gas and Power segment is involved in the logistic and trading of natural gas and electricity; transportation and trading of LNG; generation of electricity through thermoelectric power plants; holding interests in transportation and distribution of natural gas; and fertilizer production and natural gas processing business. In addition, the company produces biodiesel and its co-products, and ethanol; and distributes oil products. Further, it engages in research, development, production, transport, distribution, and trading of energy. Petróleo Brasileiro S.A. - Petrobras was incorporated in 1953 and is headquartered in Rio de Janeiro, Brazil.",
"fullTimeEmployees": 45149,
"companyOfficers": [],
"twitter": null,
"name": null,
"startDate": null,
"description": null,
"updatedAt": "2024-01-09T23:54:52.487Z"
},
"financialData": {
"symbol": "PETR4",
"currentPrice": 35.5,
"ebitda": 204234000000,
"quickRatio": 0.23947,
"currentRatio": 0.69408,
"debtToEquity": 101.6198,
"revenuePerShare": 38.08202,
"returnOnAssets": 0.0329,
"returnOnEquity": 0.1007,
"earningsGrowth": -0.71767,
"revenueGrowth": -0.05016,
"grossMargins": 0.50213,
"ebitdaMargins": 0.4161,
"operatingMargins": 0.27953,
"profitMargins": 0.0754,
"totalCash": 20254000000,
"totalCashPerShare": 1.57145,
"totalDebt": 194808000000,
"totalRevenue": 490829000000,
"grossProfits": 246462000000,
"operatingCashflow": 204037000000,
"freeCashflow": 131674000000,
"financialCurrency": "BRL",
"updatedAt": "2025-03-14",
"type": "ttm"
},
"priceEarnings": 5.180656660725292,
"earningsPerShare": 6.0030727,
"dividendsData": {
"cashDividends": [
{
"assetIssued": "BRPETRACNPR6",
"paymentDate": "2025-02-20T00:00:00.000Z",
"rate": 0.66,
"relatedTo": "1º Trimestre/2025",
"approvedOn": null,
"isinCode": "BRPETRACNPR6",
"label": "JCP",
"lastDatePrior": "2024-12-23T00:00:00.000Z",
"remarks": ""
},
{
"assetIssued": "BRPETRACNPR6",
"paymentDate": "2024-12-19T00:00:00.000Z",
"rate": 0.53,
"relatedTo": "Dezembro/2024",
"approvedOn": "2024-08-07T00:00:00.000Z",
"isinCode": "BRPETRACNPR6",
"label": "DIVIDENDO",
"lastDatePrior": "2024-08-20T00:00:00.000Z",
"remarks": ""
}
],
"stockDividends": [
{
"assetIssued": "BRPETRACNPR6",
"factor": 2,
"completeFactor": "2 para 1",
"approvedOn": "2008-03-24T00:00:00.000Z",
"isinCode": "BRPETRACNPR6",
"label": "DESDOBRAMENTO",
"lastDatePrior": "2008-03-24T00:00:00.000Z",
"remarks": ""
}
],
"subscriptions": []
}
},
{
"currency": "BRL",
"marketCap": 5470189898,
"shortName": "MAGAZ LUIZA ON NM",
"longName": "Magazine Luiza S.A.",
"regularMarketChange": 0.35,
"regularMarketChangePercent": 4.4639999999999995,
"regularMarketTime": "2025-08-29T20:07:54.000Z",
"regularMarketPrice": 8.19,
"regularMarketDayHigh": 8.4,
"regularMarketDayRange": "7.68 - 8.4",
"regularMarketDayLow": 7.68,
"regularMarketVolume": 29307200,
"regularMarketPreviousClose": 7.84,
"regularMarketOpen": 6.97,
"fiftyTwoWeekRange": "5.71 - 12.51",
"fiftyTwoWeekLow": 5.71,
"fiftyTwoWeekHigh": 12.51,
"symbol": "MGLU3",
"logourl": "https://icons.brapi.dev/icons/MGLU3.svg",
"usedInterval": "1d",
"usedRange": "5d",
"historicalDataPrice": [
{
"date": 1756126800,
"open": 6.96,
"high": 7.24,
"low": 6.93,
"close": 7.12,
"volume": 15853100,
"adjustedClose": 7.12
},
{
"date": 1756213200,
"open": 7.07,
"high": 7.24,
"low": 6.98,
"close": 7,
"volume": 16124700,
"adjustedClose": 7
},
{
"date": 1756299600,
"open": 6.97,
"high": 7.18,
"low": 6.88,
"close": 7.18,
"volume": 17737000,
"adjustedClose": 7.18
},
{
"date": 1756386000,
"open": 7.2,
"high": 7.97,
"low": 7.2,
"close": 7.84,
"volume": 43622600,
"adjustedClose": 7.84
},
{
"date": 1756472400,
"open": 7.77,
"high": 8.4,
"low": 7.68,
"close": 8.19,
"volume": 29438600,
"adjustedClose": 8.19
}
],
"validRanges": [
"1d",
"2d",
"5d",
"7d",
"1mo",
"3mo",
"6mo",
"1y",
"2y",
"5y",
"10y",
"ytd",
"max"
],
"validIntervals": [
"1m",
"2m",
"5m",
"15m",
"30m",
"60m",
"90m",
"1h",
"1d",
"5d",
"1wk",
"1mo",
"3mo"
],
"balanceSheetHistory": [
{
"symbol": "MGLU3",
"type": "yearly",
"endDate": "2024-12-31",
"cash": 1827197000,
"shortTermInvestments": 337894000,
"netReceivables": 5833528000,
"inventory": 7611132000,
"otherCurrentAssets": 1986827000,
"totalCurrentAssets": 19550824000,
"longTermInvestments": 971862000,
"propertyPlantEquipment": 5070097000,
"otherAssets": 17761034000,
"totalAssets": 37311858000,
"accountsPayable": 10283119000,
"shortLongTermDebt": 1402168000,
"longTermDebt": 3179992000,
"otherLiab": 3217524000,
"totalCurrentLiabilities": 16710550000,
"totalLiab": 37311858000,
"commonStock": 13602498000,
"retainedEarnings": null,
"treasuryStock": null,
"otherStockholderEquity": -3060268000,
"totalStockholderEquity": 11319262000,
"netTangibleAssets": null,
"goodWill": null,
"intangibleAssets": 4482287000,
"deferredLongTermAssetCharges": null,
"deferredLongTermLiab": 74242000,
"capitalSurplus": null,
"taxesToRecover": 1954246000,
"longTermAssets": 17761034000,
"longTermRealizableAssets": 7236788000,
"longTermReceivables": 48553000,
"longTermDeferredTaxes": 3285792000,
"shareholdings": 971862000,
"otherNonCurrentAssets": 3902443000,
"nonCurrentAssets": 17747007000,
"shareholdersEquity": 11319262000,
"realizedShareCapital": 13602498000,
"capitalReserves": -3060268000,
"profitReserves": 905996000,
"otherComprehensiveResults": -128964000,
"currentLiabilities": 16710550000,
"socialAndLaborObligations": 558572000,
"providers": 10283119000,
"nationalSuppliers": 10283119000,
"taxObligations": 363003000,
"loansAndFinancing": 1402168000,
"otherObligations": 3272073000,
"nonCurrentLiabilities": 9282046000,
"longTermLoansAndFinancing": 3179992000,
"otherLongTermObligations": 3217524000,
"longTermProvisions": 1857353000,
"profitsAndRevenuesToBeAppropriated": 952935000,
"updatedAt": "2024-12-31"
},
{
"symbol": "MGLU3",
"type": "yearly",
"endDate": "2023-12-31",
"cash": 2593346000,
"shortTermInvestments": 779072000,
"netReceivables": 5885450000,
"inventory": 7497299000,
"otherCurrentAssets": 1608461000,
"totalCurrentAssets": 20221163000,
"longTermInvestments": 322516000,
"propertyPlantEquipment": 5184576000,
"otherAssets": 17233904000,
"totalAssets": 37455067000,
"accountsPayable": 9324072000,
"shortLongTermDebt": 2954347000,
"longTermDebt": 4400508000,
"otherLiab": 3208852000,
"totalCurrentLiabilities": 17408127000,
"totalLiab": 37455067000,
"commonStock": 12352498000,
"retainedEarnings": null,
"treasuryStock": null,
"otherStockholderEquity": -3077861000,
"totalStockholderEquity": 9610534000,
"netTangibleAssets": null,
"goodWill": null,
"intangibleAssets": 4504807000,
"deferredLongTermAssetCharges": null,
"deferredLongTermLiab": 105122000,
"capitalSurplus": null,
"taxesToRecover": 1857535000,
"longTermAssets": 17233904000,
"longTermRealizableAssets": 7222005000,
"longTermReceivables": 72691000,
"longTermDeferredTaxes": 2836852000,
"shareholdings": 322516000,
"otherNonCurrentAssets": 4312462000,
"nonCurrentAssets": 17302182000,
"shareholdersEquity": 9610534000,
"realizedShareCapital": 12352498000,
"capitalReserves": -3077861000,
"profitReserves": 457279000,
"otherComprehensiveResults": -121382000,
"currentLiabilities": 17408127000,
"socialAndLaborObligations": 401867000,
"providers": 9324072000,
"nationalSuppliers": 9324072000,
"taxObligations": 359971000,
"loansAndFinancing": 2954347000,
"otherObligations": 3152706000,
"nonCurrentLiabilities": 10436406000,
"longTermLoansAndFinancing": 4400508000,
"otherLongTermObligations": 3208852000,
"longTermProvisions": 1619166000,
"profitsAndRevenuesToBeAppropriated": 1102758000,
"updatedAt": "2023-12-31"
}
],
"summaryProfile": {
"symbol": "MGLU3",
"address1": "Rua Voluntários da, nº 1.465",
"address2": "Centro",
"address3": null,
"city": "Franca",
"state": "SP",
"zip": null,
"country": "Brazil",
"phone": null,
"fax": null,
"website": "https://www.magazineluiza.com.br",
"industry": "Specialty Retail",
"industryKey": "specialty-retail",
"industryDisp": "Specialty Retail",
"sector": "Consumer Cyclical",
"sectorKey": "consumer-cyclical",
"sectorDisp": "Consumer Cyclical",
"longBusinessSummary": "Magazine Luiza S.A. engages in the retail sale of consumer goods. It operates through Retail, Financial Operations, Insurance Operations, and Other Services segments. The company also grants credit and provides extended warranties for its products. In addition, it is involved in the provision of consortium management services; and e-commerce of perfumes, cosmetics, sports, and fashion products, as well as product delivery management and software development services. Further, the company provides integration, logistics, and technological solutions; and manages relation between merchants and marketplaces. The company was founded in 1957 and is headquartered in Franca, Brazil. Magazine Luiza S.A. operates as a subsidiary of LTD Administração e Participação S.A.",
"fullTimeEmployees": null,
"companyOfficers": [],
"twitter": null,
"name": null,
"startDate": null,
"description": null,
"updatedAt": "2024-01-10T01:41:50.950Z"
},
"financialData": {
"symbol": "MGLU3",
"currentPrice": 9.6,
"ebitda": 2895720000,
"quickRatio": 0.12956,
"currentRatio": 1.16997,
"debtToEquity": 40.48108,
"revenuePerShare": 51.47268,
"returnOnAssets": 0.01203,
"returnOnEquity": 0.03964,
"earningsGrowth": 0.42651,
"revenueGrowth": 0.02278,
"grossMargins": 0.30567,
"ebitdaMargins": 0.07613,
"operatingMargins": 0.04108,
"profitMargins": 0.0118,
"totalCash": 1827197000,
"totalCashPerShare": 2.47254,
"totalDebt": 16710550000,
"totalRevenue": 38038068000,
"grossProfits": 11627256000,
"operatingCashflow": 15835331000,
"freeCashflow": 14544725000,
"financialCurrency": "BRL",
"updatedAt": "2025-03-14",
"type": "ttm"
},
"priceEarnings": 15.656662206079142,
"earningsPerShare": 0.5238851,
"dividendsData": {
"cashDividends": [
{
"assetIssued": "BRMGLUACNOR2",
"paymentDate": "2022-05-06T00:00:00.000Z",
"rate": 0.02,
"relatedTo": "2º Trimestre/2022",
"approvedOn": "2022-04-26T00:00:00.000Z",
"isinCode": "BRMGLUACNOR2",
"label": "JCP",
"lastDatePrior": "2021-07-05T00:00:00.000Z",
"remarks": ""
},
{
"assetIssued": "BRMGLUACNOR2",
"paymentDate": "2022-05-05T00:00:00.000Z",
"rate": 0.02,
"relatedTo": "2º Trimestre/2022",
"approvedOn": "2021-06-29T00:00:00.000Z",
"isinCode": "BRMGLUACNOR2",
"label": "JCP",
"lastDatePrior": "2021-07-04T00:00:00.000Z",
"remarks": ""
}
],
"stockDividends": [
{
"assetIssued": "BRMGLUACNOR2",
"factor": 0.1,
"completeFactor": "1 para 10",
"approvedOn": "2024-05-27T00:00:00.000Z",
"isinCode": "BRMGLUACNOR2",
"label": "GRUPAMENTO",
"lastDatePrior": "2024-05-27T00:00:00.000Z",
"remarks": ""
}
],
"subscriptions": []
}
}
],
"requestedAt": "2025-08-30T15:53:07.499Z",
"took": "0ms"
}
}
}
},
"400": {
"description": "**Bad Request.** A requisição foi malformada ou continha parâmetros inválidos. Verifique a sintaxe dos tickers e os valores dos parâmetros `range`, `interval`, `fundamental`, `dividends` e `modules`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "Campo 'range' inválido. Ranges válidos: 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"402": {
"description": "**Payment Required.** O limite de requisições associado ao seu token/plano foi atingido. Considere um upgrade ou aguarde a renovação do limite.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "Você atingiu o limite de requisições para o seu plano. Por favor, considere fazer um upgrade para um plano melhor em brapi.dev/dashboard"
}
}
}
},
"404": {
"description": "**Not Found.** Um ou mais tickers informados no path não correspondem a nenhum ativo conhecido pela API.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "Não encontramos a ação G3X"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/api/quote/list": {
"get": {
"tags": [
"Ações"
],
"summary": "Listar e Filtrar Cotações de Ativos",
"description": "Obtenha uma lista paginada de cotações de diversos ativos (ações, FIIs, BDRs) negociados na B3, com opções avançadas de busca, filtragem e ordenação.\n\n### Funcionalidades:\n\n* **Busca por Ticker:** Filtre por parte do ticker usando `search`.\n* **Filtragem por Tipo:** Restrinja a lista a `stock`, `fund` (FII) ou `bdr` com o parâmetro `type`.\n* **Filtragem por Setor:** Selecione ativos de um setor específico usando `sector`.\n* **Ordenação:** Ordene os resultados por diversos campos (preço, variação, volume, etc.) usando `sortBy` e `sortOrder`.\n* **Paginação:** Controle o número de resultados por página (`limit`) e a página desejada (`page`).\n\n### Autenticação:\n\nRequer token de autenticação via `token` (query) ou `Authorization` (header).\n\n### Exemplo de Requisição:\n\n**Listar as 10 ações do setor Financeiro com maior volume, ordenadas de forma decrescente:**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/quote/list?sector=Finance&sortBy=volume&sortOrder=desc&limit=10&page=1&token=SEU_TOKEN\"\n```\n\n**Buscar por ativos cujo ticker contenha 'ITUB' e ordenar por nome ascendente:**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/quote/list?search=ITUB&sortBy=name&sortOrder=asc&token=SEU_TOKEN\"\n```\n\n### Resposta:\n\nA resposta contém a lista de `stocks` (e `indexes` relevantes), informações sobre os filtros aplicados, detalhes da paginação (`currentPage`, `totalPages`, `itemsPerPage`, `totalCount`, `hasNextPage`) e listas de setores (`availableSectors`) e tipos (`availableStockTypes`) disponíveis para filtragem.",
"operationId": "getQuoteList",
"parameters": [
{
"name": "search",
"in": "query",
"description": "**Opcional.** Termo para buscar ativos por ticker (correspondência parcial). Ex: `PETR` encontrará `PETR4`, `PETR3`.",
"required": false,
"schema": {
"type": "string"
},
"example": "PETR"
},
{
"name": "sortBy",
"in": "query",
"description": "**Opcional.** Campo pelo qual os resultados serão ordenados.",
"required": false,
"schema": {
"type": "string",
"enum": [
"name",
"close",
"change",
"change_abs",
"volume",
"market_cap_basic",
"sector"
],
"description": "Campos disponíveis para ordenação:\n* `name`: Nome do ativo.\n* `close`: Preço de fechamento.\n* `change`: Variação percentual.\n* `change_abs`: Variação absoluta (valor).\n* `volume`: Volume negociado.\n* `market_cap_basic`: Capitalização de mercado.\n* `sector`: Setor de atuação."
},
"example": "close"
},
{
"name": "sortOrder",
"in": "query",
"description": "**Opcional.** Direção da ordenação: `asc` (ascendente) ou `desc` (descendente). Requer que `sortBy` seja especificado.",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"example": "desc"
},
{
"name": "limit",
"in": "query",
"description": "**Opcional.** Número máximo de ativos a serem retornados por página. O valor padrão pode variar.",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
},
"example": 10
},
{
"name": "page",
"in": "query",
"description": "**Opcional.** Número da página dos resultados a ser retornada, considerando o `limit` especificado. Começa em 1.",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
},
"example": 1
},
{
"name": "type",
"in": "query",
"description": "**Opcional.** Filtra os resultados por tipo de ativo.",
"required": false,
"schema": {
"type": "string",
"enum": [
"stock",
"fund",
"bdr"
],
"description": "Tipos de ativos:\n* `stock`: Ação.\n* `fund`: Fundo (geralmente FII - Fundo de Investimento Imobiliário).\n* `bdr`: Brazilian Depositary Receipt."
},
"example": "stock"
},
{
"name": "sector",
"in": "query",
"description": "**Opcional.** Filtra os resultados por setor de atuação da empresa. Utilize um dos valores retornados em `availableSectors`.",
"required": false,
"schema": {
"type": "string",
"enum": [
"Retail Trade",
"Energy Minerals",
"Health Services",
"Utilities",
"Finance",
"Consumer Services",
"Consumer Non-Durables",
"Non-Energy Minerals",
"Commercial Services",
"Distribution Services",
"Transportation",
"Technology Services",
"Process Industries",
"Communications",
"Producer Manufacturing",
"Miscellaneous",
"Electronic Technology",
"Industrial Services",
"Health Technology",
"Consumer Durables"
],
"description": "Nome exato do setor (sensível a maiúsculas/minúsculas e espaços). Consulte a chave `availableSectors` na resposta para obter a lista completa e atualizada."
},
"example": "Energy Minerals"
},
{
"$ref": "#/components/parameters/Token"
}
],
"responses": {
"200": {
"description": "**Sucesso.** Retorna a lista paginada e filtrada de ativos, juntamente com metadados de paginação e filtros disponíveis.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteListResponse"
},
"examples": {
"success": {
"value": {
"indexes": [
{
"stock": "^BVSP",
"name": "IBOVESPA"
}
],
"stocks": [
{
"stock": "PETR4",
"name": "PETROBRAS PN",
"close": 36.71,
"change": 3.26,
"volume": 87666300,
"market_cap": 497695817728,
"logo": "https://icons.brapi.dev/icons/PETR4.svg",
"sector": "Energy Minerals",
"type": "stock"
}
],
"availableSectors": [
"Energy Minerals",
"Finance",
"..."
],
"availableStockTypes": [
"stock",
"fund",
"bdr"
],
"currentPage": 1,
"totalPages": 5,
"itemsPerPage": 10,
"totalCount": 45,
"hasNextPage": true
}
},
"empty": {
"value": {
"indexes": [],
"stocks": [],
"availableSectors": [],
"availableStockTypes": [],
"currentPage": 1,
"totalPages": 0,
"itemsPerPage": 10,
"totalCount": 0,
"hasNextPage": false
},
"summary": "Nenhum ativo encontrado com os filtros aplicados"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"417": {
"description": "**Expectation Failed.** Requisição malformada ou parâmetro inválido. Geralmente ocorre se um valor inválido for fornecido para `sortBy`, `sortOrder`, `type`, `sector` ou se `limit`/`page` não forem números inteiros positivos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "Campo 'sortBy' inválido. sortBy válidos: name, close, change, change_abs, volume, market_cap_basic, sector"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/api/available": {
"get": {
"tags": [
"Ações"
],
"summary": "Listar Todos os Tickers Disponíveis na API",
"description": "Obtenha uma lista completa de todos os tickers (identificadores) de ativos financeiros (ações, FIIs, BDRs, ETFs, índices) que a API Brapi tem dados disponíveis para consulta no endpoint `/api/quote/{tickers}`.\n\n### Funcionalidade:\n\n* Retorna arrays separados para `indexes` (índices) e `stocks` (outros ativos).\n* Pode ser filtrado usando o parâmetro `search` para encontrar tickers específicos.\n\n### Autenticação:\n\nRequer token de autenticação via `token` (query) ou `Authorization` (header).\n\n### Exemplo de Requisição:\n\n**Listar todos os tickers disponíveis:**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/available?token=SEU_TOKEN\"\n```\n\n**Buscar tickers que contenham 'BBDC':**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/available?search=BBDC&token=SEU_TOKEN\"\n```\n\n### Resposta:\n\nA resposta é um objeto JSON com duas chaves:\n\n* `indexes`: Array de strings contendo os tickers dos índices disponíveis (ex: `[\"^BVSP\", \"^IFIX\"]`).\n* `stocks`: Array de strings contendo os tickers das ações, FIIs, BDRs e ETFs disponíveis (ex: `[\"PETR4\", \"VALE3\", \"ITSA4\", \"MXRF11\"]`).",
"operationId": "getAvailableTickers",
"parameters": [
{
"name": "search",
"in": "query",
"description": "**Opcional.** Termo para filtrar a lista de tickers (correspondência parcial, case-insensitive). Se omitido, retorna todos os tickers.",
"required": false,
"schema": {
"type": "string"
},
"example": "PETR"
},
{
"$ref": "#/components/parameters/Token"
}
],
"responses": {
"200": {
"description": "**Sucesso.** Retorna a lista de tickers disponíveis, possivelmente filtrada pelo parâmetro `search`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AvailableTickersResponse"
},
"examples": {
"success": {
"value": {
"indexes": [
"^BVSP"
],
"stocks": [
"PETR4",
"PETR3",
"VALE3"
]
}
},
"empty": {
"value": {
"indexes": [],
"stocks": []
},
"summary": "Nenhum ticker encontrado para o critério de busca"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/api/v2/crypto": {
"get": {
"tags": [
"Criptomoedas"
],
"summary": "Buscar Cotação Detalhada de Criptomoedas",
"description": "Obtenha cotações atualizadas e dados históricos para uma ou mais criptomoedas.\n\n### Funcionalidades:\n\n* **Cotação Múltipla:** Consulte várias criptomoedas em uma única requisição usando o parâmetro `coin`.\n* **Moeda de Referência:** Especifique a moeda fiduciária para a cotação com `currency` (padrão: BRL).\n* **Dados Históricos:** Solicite séries históricas usando `range` e `interval` (similar ao endpoint de ações).\n\n### Autenticação:\n\nRequer token de autenticação via `token` (query) ou `Authorization` (header).\n\n### Exemplo de Requisição:\n\n**Cotação de Bitcoin (BTC) e Ethereum (ETH) em Dólar Americano (USD):**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/v2/crypto?coin=BTC,ETH¤cy=USD&token=SEU_TOKEN\"\n```\n\n**Cotação de Cardano (ADA) em Real (BRL) com histórico do último mês (intervalo diário):**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/v2/crypto?coin=ADA¤cy=BRL&range=1mo&interval=1d&token=SEU_TOKEN\"\n```\n\n### Resposta:\n\nA resposta contém um array `coins`, onde cada objeto representa uma criptomoeda solicitada, incluindo sua cotação atual, dados de mercado e, opcionalmente, a série histórica (`historicalDataPrice`).",
"operationId": "getCryptoQuote",
"parameters": [
{
"name": "coin",
"in": "query",
"description": "**Obrigatório.** Uma ou mais siglas (tickers) de criptomoedas que você deseja consultar. Separe múltiplas siglas por vírgula (`,`). \n\n* **Exemplos:** `BTC`, `ETH,ADA`, `SOL`.",
"required": true,
"schema": {
"type": "string"
},
"example": "BTC,ETH"
},
{
"name": "currency",
"in": "query",
"description": "**Opcional.** A sigla da moeda fiduciária na qual a cotação da(s) criptomoeda(s) deve ser retornada. Se omitido, o padrão é `BRL` (Real Brasileiro).",
"required": false,
"schema": {
"type": "string",
"default": "BRL"
},
"example": "USD"
},
{
"name": "range",
"in": "query",
"description": "**Opcional.** Define o período para os dados históricos de preço (`historicalDataPrice`). Funciona de forma análoga ao endpoint de ações. Se omitido, apenas a cotação mais recente é retornada (a menos que `interval` seja usado).\n\n* Valores: `1d`, `5d`, `1mo`, `3mo`, `6mo`, `1y`, `2y`, `5y`, `10y`, `ytd`, `max`.",
"required": false,
"schema": {
"type": "string",
"enum": [
"1d",
"5d",
"1mo",
"3mo",
"6mo",
"1y",
"2y",
"5y",
"10y",
"ytd",
"max"
]
},
"example": "1mo"
},
{
"name": "interval",
"in": "query",
"description": "**Opcional.** Define a granularidade (intervalo) dos dados históricos de preço (`historicalDataPrice`). Requer que `range` também seja especificado. Funciona de forma análoga ao endpoint de ações.\n\n* Valores: `1m`, `2m`, `5m`, `15m`, `30m`, `60m`, `90m`, `1h`, `1d`, `5d`, `1wk`, `1mo`, `3mo`.",
"required": false,
"schema": {
"type": "string",
"enum": [
"1m",
"2m",
"5m",
"15m",
"30m",
"60m",
"90m",
"1h",
"1d",
"5d",
"1wk",
"1mo",
"3mo"
]
},
"example": "1d"
},
{
"$ref": "#/components/parameters/Token"
}
],
"responses": {
"200": {
"description": "**Sucesso.** Retorna os dados das criptomoedas solicitadas, incluindo cotação e, opcionalmente, dados históricos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CryptoResponse"
}
}
}
},
"400": {
"description": "**Bad Request.** A requisição pode estar malformada, um parâmetro `range` ou `interval` pode ser inválido, ou uma das criptomoedas (`coin`) solicitadas pode não ser suportada ou encontrada.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "Something went wrong while fetching the data"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"417": {
"description": "**Expectation Failed.** Parâmetro obrigatório ausente. Geralmente ocorre se o parâmetro `coin` não for fornecido.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "Missing required parameter: `coin`"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/api/v2/crypto/available": {
"get": {
"tags": [
"Criptomoedas"
],
"summary": "Listar Todas as Criptomoedas Disponíveis",
"description": "Obtenha a lista completa de todas as siglas (tickers) de criptomoedas que a API Brapi suporta para consulta no endpoint `/api/v2/crypto`.\n\n### Funcionalidade:\n\n* Retorna um array `coins` com as siglas.\n* Pode ser filtrado usando o parâmetro `search`.\n\n### Autenticação:\n\nRequer token de autenticação via `token` (query) ou `Authorization` (header).\n\n### Exemplo de Requisição:\n\n**Listar todas as criptomoedas disponíveis:**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/v2/crypto/available?token=SEU_TOKEN\"\n```\n\n**Buscar criptomoedas cujo ticker contenha 'DOGE':**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/v2/crypto/available?search=DOGE&token=SEU_TOKEN\"\n```\n\n### Resposta:\n\nA resposta é um objeto JSON com a chave `coins`, contendo um array de strings com as siglas das criptomoedas (ex: `[\"BTC\", \"ETH\", \"LTC\", \"XRP\"]`).",
"operationId": "getAvailableCrypto",
"parameters": [
{
"name": "search",
"in": "query",
"description": "**Opcional.** Termo para filtrar a lista de siglas de criptomoedas (correspondência parcial, case-insensitive). Se omitido, retorna todas as siglas.",
"required": false,
"schema": {
"type": "string"
},
"example": "BTC"
},
{
"$ref": "#/components/parameters/Token"
}
],
"responses": {
"200": {
"description": "**Sucesso.** Retorna a lista de siglas de criptomoedas disponíveis, possivelmente filtrada.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CryptoAvailableResponse"
},
"example": {
"coins": [
"BTC",
"ETH",
"LTC"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "**Not Found.** Nenhuma criptomoeda encontrada correspondendo ao critério de busca (`search`) informado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"example": {
"message": "Coin not found"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/api/v2/currency": {
"get": {
"tags": [
"Moedas"
],
"summary": "Buscar Cotação de Pares de Moedas Fiduciárias",
"description": "Obtenha cotações atualizadas para um ou mais pares de moedas fiduciárias (ex: USD-BRL, EUR-USD).\n\n### Funcionalidades:\n\n* **Cotação Múltipla:** Consulte vários pares de moedas em uma única requisição usando o parâmetro `currency`.\n* **Dados Retornados:** Inclui nome do par, preços de compra (bid) e venda (ask), variação, máximas e mínimas, e timestamp da atualização.\n\n### Parâmetros:\n\n* **`currency` (Obrigatório):** Uma lista de pares de moedas separados por vírgula, no formato `MOEDA_ORIGEM-MOEDA_DESTINO` (ex: `USD-BRL`, `EUR-USD`). Consulte os pares disponíveis em [`/api/v2/currency/available`](#/Moedas/getAvailableCurrencies).\n* **`token` (Obrigatório):** Seu token de autenticação.\n\n### Autenticação:\n\nRequer token de autenticação válido via `token` (query) ou `Authorization` (header).\n\n",
"operationId": "getCurrencyQuote",
"parameters": [
{
"name": "currency",
"in": "query",
"description": "**Obrigatório.** Uma lista de um ou mais pares de moedas a serem consultados, separados por vírgula (`,`). \n\n* **Formato:** `MOEDA_ORIGEM-MOEDA_DESTINO` (ex: `USD-BRL`).\n* **Disponibilidade:** Consulte os pares válidos usando o endpoint [`/api/v2/currency/available`](#/Moedas/getAvailableCurrencies).\n* **Exemplo:** `USD-BRL,EUR-BRL,BTC-BRL`",
"required": true,
"schema": {
"type": "string",
"example": "USD-BRL,EUR-USD"
}
},
{
"$ref": "#/components/parameters/Token"
}
],
"responses": {
"200": {
"description": "**Sucesso (OK).** A requisição foi bem-sucedida e as cotações dos pares de moedas solicitados foram retornadas no array `currency`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyResponse"
}
}
}
},
"400": {
"description": "**Bad Request (Requisição Inválida).** A requisição foi malformada, um par de moeda no parâmetro `currency` é inválido, não existe ou houve outro erro ao buscar os dados.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "Algo deu errado ao buscar essa moeda"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"417": {
"description": "**Expectation Failed (Falha na Expectativa).** O parâmetro obrigatório `currency` não foi fornecido na requisição.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "Não foi possível encontrar o parâmetro obrigatório: 'currency', exemplo: https://brapi.dev/api/v2/currency?currency=USD-BRL"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/api/v2/currency/available": {
"get": {
"tags": [
"Moedas"
],
"summary": "Listar Todas as Moedas Fiduciárias Disponíveis",
"description": "Obtenha a lista completa de todas as moedas fiduciárias suportadas pela API, geralmente utilizadas no parâmetro `currency` de outros endpoints (como o de criptomoedas) ou para futuras funcionalidades de conversão.\n\n### Funcionalidade:\n\n* Retorna um array `currencies` com os nomes das moedas.\n* Pode ser filtrado usando o parâmetro `search`.\n\n### Autenticação:\n\nRequer token de autenticação via `token` (query) ou `Authorization` (header).\n\n### Exemplo de Requisição:\n\n**Listar todas as moedas disponíveis:**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/v2/currency/available?token=SEU_TOKEN\"\n```\n\n**Buscar moedas cujo nome contenha 'Euro':**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/v2/currency/available?search=Euro&token=SEU_TOKEN\"\n```\n\n### Resposta:\n\nA resposta é um objeto JSON com a chave `currencies`, contendo um array de objetos. Cada objeto possui uma chave `currency` com o nome completo da moeda (ex: `\"Dólar Americano/Real Brasileiro\"`). **Nota:** O formato do nome pode indicar um par de moedas, dependendo do contexto interno da API.",
"operationId": "getAvailableCurrencies",
"parameters": [
{
"name": "search",
"in": "query",
"description": "**Opcional.** Termo para filtrar a lista pelo nome da moeda (correspondência parcial, case-insensitive).",
"required": false,
"schema": {
"type": "string"
},
"example": "Real"
},
{
"$ref": "#/components/parameters/Token"
}
],
"responses": {
"200": {
"description": "**Sucesso.** Retorna a lista de moedas disponíveis, possivelmente filtrada.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyAvailableResponse"
},
"example": {
"currencies": [
{
"name": "USD-BRL",
"currency": "Dólar Americano/Real Brasileiro"
},
{
"name": "EUR-BRL",
"currency": "Euro/Real Brasileiro"
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "**Not Found.** Nenhuma moeda encontrada correspondendo ao critério de busca (`search`) informado.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "Currency not found"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/api/v2/inflation": {
"get": {
"tags": [
"Inflação"
],
"summary": "Buscar Dados Históricos de Inflação por País",
"description": "Obtenha dados históricos sobre índices de inflação para um país específico.\n\n### Funcionalidades:\n\n* **Seleção de País:** Especifique o país desejado com o parâmetro `country` (padrão: `brazil`).\n* **Filtragem por Período:** Defina um intervalo de datas com `start` e `end` (formato DD/MM/YYYY).\n* **Inclusão de Histórico:** O parâmetro `historical` (booleano) parece controlar a inclusão de dados históricos (verificar comportamento exato, pode ser redundante com `start`/`end`).\n* **Ordenação:** Ordene os resultados por data (`date`) ou valor (`value`) usando `sortBy` e `sortOrder`.\n\n### Autenticação:\n\nRequer token de autenticação via `token` (query) ou `Authorization` (header).\n\n### Exemplo de Requisição:\n\n**Buscar dados de inflação do Brasil para o ano de 2022, ordenados por valor ascendente:**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/v2/inflation?country=brazil&start=01/01/2022&end=31/12/2022&sortBy=value&sortOrder=asc&token=SEU_TOKEN\"\n```\n\n**Buscar os dados mais recentes de inflação (sem período definido, ordenação padrão):**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/v2/inflation?country=brazil&token=SEU_TOKEN\"\n```\n\n### Resposta:\n\nA resposta contém um array `inflation`, onde cada objeto representa um ponto de dado de inflação com sua `date` (DD/MM/YYYY), `value` (o índice de inflação como string) e `epochDate` (timestamp UNIX).",
"operationId": "getInflation",
"parameters": [
{
"name": "country",
"in": "query",
"description": "**Opcional.** Nome do país para o qual buscar os dados de inflação. Use nomes em minúsculas. O padrão é `brazil`. Consulte `/api/v2/inflation/available` para a lista de países suportados.",
"required": false,
"schema": {
"type": "string",
"default": "brazil"
},
"example": "brazil"
},
{
"name": "historical",
"in": "query",
"description": "**Opcional.** Booleano (`true` ou `false`). Define se dados históricos devem ser incluídos. O comportamento exato em conjunto com `start`/`end` deve ser verificado. Padrão: `false`.",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"example": true
},
{
"name": "start",
"in": "query",
"description": "**Opcional.** Data de início do período desejado para os dados históricos, no formato `DD/MM/YYYY`. Requerido se `end` for especificado.",
"required": false,
"schema": {
"type": "string",
"format": "date",
"pattern": "^\\d{2}/\\d{2}/\\d{4}$"
},
"example": "01/01/2020"
},
{
"name": "end",
"in": "query",
"description": "**Opcional.** Data final do período desejado para os dados históricos, no formato `DD/MM/YYYY`. Requerido se `start` for especificado.",
"required": false,
"schema": {
"type": "string",
"format": "date",
"pattern": "^\\d{2}/\\d{2}/\\d{4}$"
},
"example": "31/12/2020"
},
{
"name": "sortBy",
"in": "query",
"description": "**Opcional.** Campo pelo qual os resultados da inflação serão ordenados.",
"required": false,
"schema": {
"type": "string",
"enum": [
"date",
"value"
],
"default": "date",
"description": "Campos disponíveis:\n* `date`: Data da medição.\n* `value`: Valor do índice de inflação."
},
"example": "value"
},
{
"name": "sortOrder",
"in": "query",
"description": "**Opcional.** Direção da ordenação: `asc` (ascendente) ou `desc` (descendente). Padrão: `desc`. Requer que `sortBy` seja especificado.",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"example": "asc"
},
{
"$ref": "#/components/parameters/Token"
}
],
"responses": {
"200": {
"description": "**Sucesso.** Retorna os dados históricos de inflação para o país e período solicitados.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InflationResponse"
}
}
}
},
"400": {
"description": "**Bad Request.** A requisição pode estar malformada, um parâmetro como `start`/`end` pode ter formato inválido, ou o país solicitado pode não ser encontrado.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "Something went wrong while fetching the data"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"417": {
"description": "**Expectation Failed.** Valor de parâmetro inválido. Geralmente ocorre se um valor inválido for fornecido para `sortBy` ou `sortOrder`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "this query value is not available, please use one of the following: asc,desc"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/api/v2/inflation/available": {
"get": {
"tags": [
"Inflação"
],
"summary": "Listar Países com Dados de Inflação Disponíveis",
"description": "Obtenha a lista completa de todos os países para os quais a API Brapi possui dados de inflação disponíveis para consulta no endpoint `/api/v2/inflation`.\n\n### Funcionalidade:\n\n* Retorna um array `countries` com os nomes dos países (em minúsculas).\n* Pode ser filtrado usando o parâmetro `search`.\n\n### Autenticação:\n\nRequer token de autenticação via `token` (query) ou `Authorization` (header).\n\n### Exemplo de Requisição:\n\n**Listar todos os países com dados de inflação:**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/v2/inflation/available?token=SEU_TOKEN\"\n```\n\n**Buscar países cujo nome contenha 'arg':**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/v2/inflation/available?search=arg&token=SEU_TOKEN\"\n```\n\n### Resposta:\n\nA resposta é um objeto JSON com a chave `countries`, contendo um array de strings com os nomes dos países (ex: `[\"brazil\", \"argentina\", \"usa\"]`).",
"operationId": "getAvailableInflationCountries",
"parameters": [
{
"name": "search",
"in": "query",
"description": "**Opcional.** Termo para filtrar a lista pelo nome do país (correspondência parcial, case-insensitive). Se omitido, retorna todos os países.",
"required": false,
"schema": {
"type": "string"
},
"example": "bra"
},
{
"$ref": "#/components/parameters/Token"
}
],
"responses": {
"200": {
"description": "**Sucesso.** Retorna a lista de países disponíveis, possivelmente filtrada.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InflationAvailableResponse"
},
"example": {
"countries": [
"brazil"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "**Not Found.** Nenhum país encontrado correspondendo ao critério de busca (`search`) informado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"example": {
"message": "Country not found"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/api/v2/prime-rate": {
"get": {
"tags": [
"Taxa de Juros"
],
"summary": "Buscar Taxa Básica de Juros (SELIC) de um País por um Período Determinado",
"description": "Obtenha informações atualizadas sobre a taxa básica de juros (SELIC) de um país por um período determinado.\n\n### Funcionalidades:\n\n* **Seleção por País:** Especifique o país desejado usando o parâmetro `country` (padrão: brazil).\n* **Período Customizado:** Defina datas de início e fim com `start` e `end` para consultar um intervalo específico.\n* **Ordenação:** Ordene os resultados por data ou valor com os parâmetros `sortBy` e `sortOrder`.\n* **Dados Históricos:** Solicite o histórico completo ou apenas o valor mais recente com o parâmetro `historical`.\n\n### Autenticação:\n\nRequer token de autenticação via `token` (query) ou `Authorization` (header).\n\n### Exemplo de Requisição:\n\n**Taxa de juros do Brasil entre dezembro/2021 e janeiro/2022:**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/v2/prime-rate?country=brazil&start=01/12/2021&end=01/01/2022&sortBy=date&sortOrder=desc&token=SEU_TOKEN\"\n```",
"operationId": "getPrimeRate",
"parameters": [
{
"name": "country",
"in": "query",
"description": "**Opcional.** O país do qual você deseja obter informações sobre a taxa básica de juros. Por padrão, o país é definido como brazil. Você pode consultar a lista de países disponíveis através do endpoint `/api/v2/prime-rate/available`.",
"required": false,
"schema": {
"type": "string",
"default": "brazil"
},
"example": "brazil"
},
{
"name": "historical",
"in": "query",
"description": "**Opcional.** Define se os dados históricos serão retornados. Se definido como `true`, retorna a série histórica completa. Se `false` (padrão) ou omitido, retorna apenas o valor mais recente.",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"example": true
},
{
"name": "start",
"in": "query",
"description": "**Opcional.** Data inicial do período para busca no formato DD/MM/YYYY. Útil quando `historical=true` para restringir o período da série histórica.",
"required": false,
"schema": {
"type": "string",
"format": "date"
},
"example": "01/12/2021"
},
{
"name": "end",
"in": "query",
"description": "**Opcional.** Data final do período para busca no formato DD/MM/YYYY. Por padrão é a data atual. Útil quando `historical=true` para restringir o período da série histórica.",
"required": false,
"schema": {
"type": "string",
"format": "date"
},
"example": "01/01/2022"
},
{
"name": "sortBy",
"in": "query",
"description": "**Opcional.** Campo pelo qual os resultados serão ordenados. Por padrão, ordena por `date` (data).",
"required": false,
"schema": {
"type": "string",
"enum": [
"date",
"value"
],
"default": "date"
},
"example": "date"
},
{
"name": "sortOrder",
"in": "query",
"description": "**Opcional.** Define se a ordenação será crescente (`asc`) ou decrescente (`desc`). Por padrão, é `desc` (decrescente).",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"example": "desc"
},
{
"$ref": "#/components/parameters/Token"
}
],
"responses": {
"200": {
"description": "**Sucesso.** Retorna os dados da taxa básica de juros (SELIC) conforme os parâmetros fornecidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrimeRateResponse"
}
}
}
},
"400": {
"description": "**Bad Request.** A requisição está malformada ou um dos parâmetros fornecidos é inválido.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "Something went wrong while fetching the data"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"417": {
"description": "**Expectation Failed.** Um valor de parâmetro fornecido é inválido ou não está disponível.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "this query value is not available, please use one of the following: asc,desc"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/api/v2/prime-rate/available": {
"get": {
"tags": [
"Taxa de Juros"
],
"summary": "Listar Todos Os Possíveis Países com Taxa Básica de Juros (SELIC) Suportados",
"description": "Liste todos os países disponíveis com dados de taxa básica de juros (SELIC) na API brapi. Este endpoint facilita a descoberta de quais países possuem dados disponíveis para consulta através do endpoint principal `/api/v2/prime-rate`.\n\n### Funcionalidades:\n\n* **Busca Filtrada:** Utilize o parâmetro `search` para filtrar países por nome ou parte do nome.\n* **Ideal para Autocomplete:** Perfeito para implementar campos de busca com autocompletar em interfaces de usuário.\n\n### Autenticação:\n\nRequer token de autenticação via `token` (query) ou `Authorization` (header).\n\n### Exemplo de Requisição:\n\n**Listar países que contenham \"BR\" no nome:**\n\n```bash\ncurl -X GET \"https://brapi.dev/api/v2/prime-rate/available?search=BR&token=SEU_TOKEN\"\n```",
"operationId": "getPrimeRateAvailableCountries",
"parameters": [
{
"name": "search",
"in": "query",
"description": "**Opcional.** Termo para filtrar a lista de países por nome. Retorna países cujos nomes contenham o termo especificado (case insensitive).",
"required": false,
"schema": {
"type": "string"
},
"example": "BR"
},
{
"$ref": "#/components/parameters/Token"
}
],
"responses": {
"200": {
"description": "**Sucesso.** Retorna a lista de países com dados de taxa básica de juros disponíveis, possivelmente filtrada pelo termo de busca.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrimeRateAvailableResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"description": "**Not Found.** Não foi encontrado nenhum país correspondente ao termo de busca fornecido.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "Country not found"
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}
}
},
"components": {
"schemas": {
"ErrorResponse": {
"type": "object",
"description": "Schema padrão para respostas de erro da API.",
"properties": {
"error": {
"type": "boolean",
"description": "Indica se a requisição resultou em erro. Sempre `true` para este schema.",
"example": true
},
"message": {
"type": "string",
"description": "Mensagem descritiva do erro ocorrido."
}
},
"required": [
"error",
"message"
]
},
"AvailableTickersResponse": {
"type": "object",
"description": "Resposta do endpoint que lista todos os tickers disponíveis.",
"properties": {
"indexes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Lista de tickers de **índices** disponíveis (ex: `^BVSP`, `^IFIX`)."
},
"stocks": {
"type": "array",
"items": {
"type": "string"
},
"description": "Lista de tickers de **ações, FIIs, BDRs e ETFs** disponíveis (ex: `PETR4`, `VALE3`, `MXRF11`)."
}
},
"required": [
"indexes",
"stocks"
]
},
"IndexSummary": {
"type": "object",
"description": "Resumo de informações de um índice, geralmente retornado em listas.",
"properties": {
"stock": {
"type": "string",
"description": "Ticker do índice (ex: `^BVSP`)."
},
"name": {
"type": "string",
"description": "Nome do índice (ex: `IBOVESPA`)."
}
}
},
"StockSummary": {
"type": "object",
"description": "Resumo de informações de um ativo (ação, FII, BDR), geralmente retornado em listas.",
"properties": {
"stock": {
"type": "string",
"description": "Ticker do ativo (ex: `PETR4`, `MXRF11`)."
},
"name": {
"type": "string",
"description": "Nome do ativo ou empresa (ex: `PETROBRAS PN`)."
},
"close": {
"type": "number",
"format": "float",
"description": "Preço de fechamento mais recente ou último preço negociado."
},
"change": {
"type": "number",
"format": "float",
"description": "Variação percentual do preço em relação ao fechamento anterior."
},
"volume": {
"type": "integer",
"format": "int64",
"description": "Volume financeiro negociado no último pregão ou dia atual."
},
"market_cap": {
"type": "number",
"format": "float",
"description": "Capitalização de mercado (Preço x Quantidade de Ações). Pode ser nulo para FIIs ou outros tipos.",
"nullable": true
},
"logo": {
"type": "string",
"format": "url",
"description": "URL para a imagem do logo da empresa/ativo."
},
"sector": {
"type": "string",
"description": "Setor de atuação da empresa (ex: `Energy Minerals`, `Finance`). Pode ser nulo ou variar para FIIs.",
"nullable": true
},
"type": {
"type": "string",
"enum": [
"stock",
"fund",
"bdr"
],
"description": "Tipo do ativo: `stock` (Ação), `fund` (Fundo Imobiliário/FII), `bdr` (Brazilian Depositary Receipt)."
}
}
},
"QuoteListResponse": {
"type": "object",
"description": "Resposta do endpoint de listagem de cotações (`/api/quote/list`).",
"properties": {
"indexes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndexSummary"
},
"description": "Lista resumida de índices relevantes (geralmente inclui IBOVESPA)."
},
"stocks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StockSummary"
},
"description": "Lista paginada e filtrada dos ativos solicitados."
},
"availableSectors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Lista de todos os setores disponíveis que podem ser usados no parâmetro de filtro `sector`."
},
"availableStockTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"stock",
"fund",
"bdr"
]
},
"description": "Lista dos tipos de ativos (`stock`, `fund`, `bdr`) disponíveis que podem ser usados no parâmetro de filtro `type`."
},
"currentPage": {
"type": "integer",
"description": "Número da página atual retornada nos resultados."
},
"totalPages": {
"type": "integer",
"description": "Número total de páginas existentes para a consulta/filtros aplicados."
},
"itemsPerPage": {
"type": "integer",
"description": "Número de itens (ativos) retornados por página (conforme `limit` ou padrão)."
},
"totalCount": {
"type": "integer",
"description": "Número total de ativos encontrados que correspondem aos filtros aplicados (sem considerar a paginação)."
},
"hasNextPage": {
"type": "boolean",
"description": "Indica se existe uma próxima página de resultados (`true`) ou se esta é a última página (`false`)."
}
}
},
"HistoricalDataPrice": {
"type": "object",
"description": "Representa um ponto na série histórica de preços de um ativo.",
"properties": {
"date": {
"type": "integer",
"format": "int64",
"description": "Data do pregão ou do ponto de dados, representada como um timestamp UNIX (número de segundos desde 1970-01-01 UTC)."
},
"open": {
"type": "number",
"format": "float",
"description": "Preço de abertura do ativo no intervalo (dia, semana, mês, etc.)."
},
"high": {
"type": "number",
"format": "float",
"description": "Preço máximo atingido pelo ativo no intervalo."
},
"low": {
"type": "number",
"format": "float",
"description": "Preço mínimo atingido pelo ativo no intervalo."
},
"close": {
"type": "number",
"format": "float",
"description": "Preço de fechamento do ativo no intervalo."
},
"volume": {
"type": "integer",
"format": "int64",
"description": "Volume financeiro negociado no intervalo."
},
"adjustedClose": {
"type": "number",
"format": "float",
"description": "Preço de fechamento ajustado para proventos (dividendos, JCP, bonificações, etc.) e desdobramentos/grupamentos."
}
}
},
"CashDividend": {
"type": "object",
"description": "Detalhes sobre um pagamento de provento em dinheiro (Dividendo ou JCP).",
"properties": {
"assetIssued": {
"type": "string",
"description": "Ticker do ativo que pagou o provento (ex: `ITSA4`). Pode incluir sufixos específicos relacionados ao evento."
},
"paymentDate": {
"type": "string",
"format": "date-time",
"description": "Data efetiva em que o pagamento foi realizado (ou está previsto). Formato ISO 8601.",
"nullable": true
},
"rate": {
"type": "number",
"format": "float",
"description": "Valor bruto do provento pago por unidade do ativo (por ação, por cota)."
},
"relatedTo": {
"type": "string",
"description": "Descrição do período ou evento ao qual o provento se refere (ex: `1º Trimestre/2023`, `Resultado 2022`).",
"nullable": true
},
"approvedOn": {
"type": "string",
"format": "date-time",
"description": "Data em que o pagamento do provento foi aprovado pela empresa. Pode ser uma estimativa em alguns casos. Formato ISO 8601."
},
"isinCode": {
"type": "string",
"description": "Código ISIN (International Securities Identification Number) do ativo relacionado ao provento.",
"nullable": true
},
"label": {
"type": "string",
"description": "Tipo do provento em dinheiro. Geralmente `DIVIDENDO` ou `JCP` (Juros sobre Capital Próprio)."
},
"lastDatePrior": {
"type": "string",
"format": "date-time",
"description": "Data Com (Ex-Date). Último dia em que era necessário possuir o ativo para ter direito a receber este provento. Pode ser uma estimativa. Formato ISO 8601."
},
"remarks": {
"type": "string",
"description": "Observações adicionais ou informações relevantes sobre o provento.",
"nullable": true
}
}
},
"StockDividend": {
"type": "object",
"description": "Detalhes sobre um evento corporativo que afeta a quantidade de ações (Desdobramento/Split, Grupamento/Inplit, Bonificação).",
"properties": {
"assetIssued": {
"type": "string",
"description": "Ticker do ativo afetado pelo evento."
},
"factor": {
"type": "number",
"format": "float",
"description": "Fator numérico do evento. \n* **Bonificação:** Percentual (ex: 0.1 para 10%).\n* **Desdobramento/Grupamento:** Fator multiplicativo ou divisor."
},
"completeFactor": {
"type": "string",
"description": "Descrição textual do fator (ex: `1 / 10`, `10 / 1`)."
},
"approvedOn": {
"type": "string",
"format": "date-time",
"description": "Data em que o evento foi aprovado. Formato ISO 8601."
},
"isinCode": {
"type": "string",
"description": "Código ISIN do ativo.",
"nullable": true
},
"label": {
"type": "string",
"description": "Tipo do evento: `DESDOBRAMENTO`, `GRUPAMENTO`, `BONIFICACAO`."
},
"lastDatePrior": {
"type": "string",
"format": "date-time",
"description": "Data Com (Ex-Date). Último dia para possuir o ativo nas condições antigas. Formato ISO 8601."
},
"remarks": {
"type": "string",
"description": "Observações adicionais sobre o evento.",
"nullable": true
}
}
},
"DividendsData": {
"type": "object",
"description": "Agrupa informações sobre proventos e eventos corporativos. Retornado quando `dividends=true` é solicitado.",
"properties": {
"cashDividends": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CashDividend"
},
"description": "Lista de proventos pagos em dinheiro (Dividendos e JCP)."
},
"stockDividends": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StockDividend"
},
"description": "Lista de eventos corporativos (Desdobramento, Grupamento, Bonificação)."
},
"subscriptions": {
"type": "array",
"items": {
"type": "object"
},
"description": "Lista de eventos de subscrição de ações (estrutura não detalhada aqui)."
}
}
},
"SummaryProfile": {
"type": "object",
"description": "Contém informações cadastrais e descritivas sobre a empresa. Retornado via `modules=summaryProfile`.",
"properties": {
"address1": {
"type": "string",
"description": "Linha 1 do endereço da sede da empresa.",
"nullable": true
},
"address2": {
"type": "string",
"nullable": true,
"description": "Linha 2 do endereço da sede da empresa (complemento)."
},
"city": {
"type": "string",
"description": "Cidade da sede da empresa.",
"nullable": true
},
"state": {
"type": "string",
"description": "Estado ou província da sede da empresa.",
"nullable": true
},
"zip": {
"type": "string",
"description": "Código Postal (CEP) da sede da empresa.",
"nullable": true
},
"country": {
"type": "string",
"description": "País da sede da empresa.",
"nullable": true
},
"phone": {
"type": "string",
"description": "Número de telefone principal da empresa.",
"nullable": true
},
"website": {
"type": "string",
"description": "URL do website oficial da empresa.",
"nullable": true
},
"industry": {
"type": "string",
"description": "Nome da indústria em que a empresa atua.",
"nullable": true
},
"industryKey": {
"type": "string",
"description": "Chave interna ou código para a indústria.",
"nullable": true
},
"industryDisp": {
"type": "string",
"description": "Nome de exibição formatado para a indústria.",
"nullable": true
},
"sector": {
"type": "string",
"description": "Nome do setor de atuação da empresa.",
"nullable": true
},
"sectorKey": {
"type": "string",
"description": "Chave interna ou código para o setor.",
"nullable": true
},
"sectorDisp": {
"type": "string",
"description": "Nome de exibição formatado para o setor.",
"nullable": true
},
"longBusinessSummary": {
"type": "string",
"description": "Descrição longa e detalhada sobre as atividades e o negócio da empresa.",
"nullable": true
},
"fullTimeEmployees": {
"type": "integer",
"description": "Número estimado de funcionários em tempo integral.",
"nullable": true
},
"companyOfficers": {
"type": "array",
"items": {
"type": "object"
},
"description": "Lista de diretores e executivos principais da empresa (estrutura interna do objeto não detalhada aqui).",
"nullable": true
}
}
},
"BalanceSheetEntry": {
"type": "object",
"description": "Representa os dados de um Balanço Patrimonial para um período específico (anual ou trimestral).",
"properties": {
"symbol": {
"type": "string",
"description": "Ticker do ativo ao qual o balanço se refere."
},
"type": {
"type": "string",
"enum": [
"yearly",
"quarterly"
],
"description": "Indica a periodicidade do balanço: `yearly` (anual) ou `quarterly` (trimestral)."
},
"endDate": {
"type": "string",
"format": "date",
"description": "Data de término do período fiscal ao qual o balanço se refere (YYYY-MM-DD)."
},
"cash": {
"type": "number",
"format": "int64",
"description": "Caixa e equivalentes de caixa.",
"nullable": true
},
"shortTermInvestments": {
"type": "number",
"format": "int64",
"description": "Aplicações financeiras de curto prazo.",
"nullable": true
},
"netReceivables": {
"type": "number",
"format": "int64",
"description": "Contas a receber líquidas (clientes).",
"nullable": true
},
"inventory": {
"type": "number",
"format": "int64",
"description": "Estoques.",
"nullable": true
},
"otherCurrentAssets": {
"type": "number",
"format": "int64",
"description": "Outros ativos circulantes.",
"nullable": true
},
"totalCurrentAssets": {
"type": "number",
"format": "int64",
"description": "Total do ativo circulante.",
"nullable": true
},
"longTermInvestments": {
"type": "number",
"format": "int64",
"description": "Investimentos de longo prazo.",
"nullable": true
},
"propertyPlantEquipment": {
"type": "number",
"format": "int64",
"description": "Imobilizado (propriedades, instalações e equipamentos).",
"nullable": true
},
"otherAssets": {
"type": "number",
"format": "int64",
"description": "Outros ativos não circulantes.",
"nullable": true
},
"totalAssets": {
"type": "number",
"format": "int64",
"description": "Total do ativo.",
"nullable": true
},
"accountsPayable": {
"type": "number",
"format": "int64",
"description": "Contas a pagar (fornecedores).",
"nullable": true
},
"shortLongTermDebt": {
"type": "number",
"format": "int64",
"description": "Dívida de curto prazo (empréstimos e financiamentos circulantes).",
"nullable": true
},
"otherCurrentLiab": {
"type": "number",
"format": "int64",
"description": "Outros passivos circulantes.",
"nullable": true
},
"longTermDebt": {
"type": "number",
"format": "int64",
"description": "Dívida de longo prazo (empréstimos e financiamentos não circulantes).",
"nullable": true
},
"otherLiab": {
"type": "number",
"format": "int64",
"description": "Outros passivos não circulantes.",
"nullable": true
},
"totalCurrentLiabilities": {
"type": "number",
"format": "int64",
"description": "Total do passivo circulante.",
"nullable": true
},
"totalLiab": {
"type": "number",
"format": "int64",
"description": "Total do passivo (circulante + não circulante).",
"nullable": true
},
"commonStock": {
"type": "number",
"format": "int64",
"description": "Capital social realizado.",
"nullable": true
},
"retainedEarnings": {
"type": "number",
"format": "int64",
"description": "Lucros/Prejuízos acumulados.",
"nullable": true
},
"treasuryStock": {
"type": "number",
"format": "int64",
"description": "Ações em tesouraria.",
"nullable": true
},
"otherStockholderEquity": {
"type": "number",
"format": "int64",
"description": "Outros componentes do patrimônio líquido.",
"nullable": true
},
"totalStockholderEquity": {
"type": "number",
"format": "int64",
"description": "Total do patrimônio líquido.",
"nullable": true
},
"netTangibleAssets": {
"type": "number",
"format": "int64",
"description": "Ativos tangíveis líquidos (Ativo Total - Intangíveis - Passivo Total).",
"nullable": true
},
"goodWill": {
"type": "number",
"format": "int64",
"description": "Ágio por expectativa de rentabilidade futura (Goodwill).",
"nullable": true
},
"intangibleAssets": {
"type": "number",
"format": "int64",
"description": "Ativos intangíveis (marcas, patentes, etc.).",
"nullable": true
},
"deferredLongTermAssetCharges": {
"type": "number",
"format": "int64",
"description": "Encargos diferidos de ativos de longo prazo.",
"nullable": true
},
"deferredLongTermLiab": {
"type": "number",
"format": "int64",
"description": "Passivos fiscais diferidos (longo prazo).",
"nullable": true
},
"minorityInterest": {
"type": "number",
"format": "int64",
"description": "Participação de não controladores (no patrimônio líquido).",
"nullable": true
},
"capitalSurplus": {
"type": "number",
"format": "int64",
"description": "Reservas de capital.",
"nullable": true
},
"taxesToRecover": {
"type": "number",
"format": "int64",
"description": "Impostos a recuperar.",
"nullable": true
},
"longTermAssets": {
"type": "number",
"format": "int64",
"description": "Total do ativo não circulante (agregado).",
"nullable": true
},
"longTermRealizableAssets": {
"type": "number",
"format": "int64",
"description": "Ativo realizável a longo prazo.",
"nullable": true
},
"longTermReceivables": {
"type": "number",
"format": "int64",
"description": "Contas a receber de longo prazo.",
"nullable": true
},
"longTermDeferredTaxes": {
"type": "number",
"format": "int64",
"description": "Tributos diferidos (Ativo Não Circulante).",
"nullable": true
},
"otherNonCurrentAssets": {
"type": "number",
"format": "int64",
"description": "Outros ativos não circulantes (detalhamento).",
"nullable": true
},
"nonCurrentAssets": {
"type": "number",
"format": "int64",
"description": "Total do ativo não circulante (sinônimo de `longTermAssets`).",
"nullable": true
},
"provisions": {
"type": "number",
"format": "int64",
"description": "Provisões (passivo).",
"nullable": true
},
"shareholdersEquity": {
"type": "number",
"format": "int64",
"description": "Patrimônio líquido (sinônimo de `totalStockholderEquity`).",
"nullable": true
},
"realizedShareCapital": {
"type": "number",
"format": "int64",
"description": "Capital social realizado (sinônimo de `commonStock`).",
"nullable": true
},
"capitalReserves": {
"type": "number",
"format": "int64",
"description": "Reservas de capital (sinônimo de `capitalSurplus`).",
"nullable": true
},
"profitReserves": {
"type": "number",
"format": "int64",
"description": "Reservas de lucros.",
"nullable": true
},
"otherComprehensiveResults": {
"type": "number",
"format": "int64",
"description": "Outros resultados abrangentes.",
"nullable": true
},
"currentLiabilities": {
"type": "number",
"format": "int64",
"description": "Total do passivo circulante (sinônimo de `totalCurrentLiabilities`).",
"nullable": true
},
"socialAndLaborObligations": {
"type": "number",
"format": "int64",
"description": "Obrigações sociais e trabalhistas.",
"nullable": true
},
"providers": {
"type": "number",
"format": "int64",
"description": "Fornecedores (sinônimo de `accountsPayable`).",
"nullable": true
},
"taxObligations": {
"type": "number",
"format": "int64",
"description": "Obrigações fiscais (passivo circulante).",
"nullable": true
},
"loansAndFinancing": {
"type": "number",
"format": "int64",
"description": "Empréstimos e financiamentos (circulante).",
"nullable": true
},
"leaseFinancing": {
"type": "number",
"format": "int64",
"description": "Financiamento por arrendamento mercantil (circulante).",
"nullable": true
},
"otherObligations": {
"type": "number",
"format": "int64",
"description": "Outras obrigações (circulante).",
"nullable": true
},
"otherCurrentLiabilities": {
"type": "number",
"format": "int64",
"description": "Outros passivos circulantes (sinônimo de `otherCurrentLiab`).",
"nullable": true
},
"nonCurrentLiabilities": {
"type": "number",
"format": "int64",
"description": "Total do passivo não circulante.",
"nullable": true
},
"longTermLoansAndFinancing": {
"type": "number",
"format": "int64",
"description": "Empréstimos e financiamentos (não circulante).",
"nullable": true
},
"longTermLeaseFinancing": {
"type": "number",
"format": "int64",
"description": "Financiamento por arrendamento mercantil (não circulante).",
"nullable": true
},
"otherLongTermObligations": {
"type": "number",
"format": "int64",
"description": "Outras obrigações (passivo não circulante).",
"nullable": true
},
"longTermProvisions": {
"type": "number",
"format": "int64",
"description": "Provisões (passivo não circulante).",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date",
"description": "Data da última atualização deste registro (YYYY-MM-DD).",
"nullable": true
},
"financialAssets": {
"type": "number",
"format": "int64",
"description": "Ativos financeiros (agregado de instrumentos financeiros no ativo).",
"nullable": true
},
"centralBankCompulsoryDeposit": {
"type": "number",
"format": "int64",
"description": "Depósitos compulsórios no Banco Central.",
"nullable": true
},
"financialAssetsMeasuredAtFairValueThroughProfitOrLoss": {
"type": "number",
"format": "int64",
"description": "Ativos financeiros mensurados a valor justo por meio do resultado (FVTPL).",
"nullable": true
},
"currentAndDeferredTaxes": {
"type": "number",
"format": "int64",
"description": "Tributos correntes e diferidos no ativo.",
"nullable": true
},
"investments": {
"type": "number",
"format": "int64",
"description": "Investimentos (participações e outros).",
"nullable": true
},
"financialAssetsMeasuredAtFairValueThroughOtherComprehensiveIncome": {
"type": "number",
"format": "int64",
"description": "Ativos financeiros mensurados a valor justo por outros resultados abrangentes (FVOCI).",
"nullable": true
},
"financialAssetsAtAmortizedCost": {
"type": "number",
"format": "int64",
"description": "Ativos financeiros ao custo amortizado.",
"nullable": true
},
"accountsReceivableFromClients": {
"type": "number",
"format": "int64",
"description": "Contas a receber de clientes (bruto).",
"nullable": true
},
"otherAccountsReceivable": {
"type": "number",
"format": "int64",
"description": "Outras contas a receber.",
"nullable": true
},
"biologicalAssets": {
"type": "number",
"format": "int64",
"description": "Ativos biológicos.",
"nullable": true
},
"prepaidExpenses": {
"type": "number",
"format": "int64",
"description": "Despesas antecipadas.",
"nullable": true
},
"longTermAccountsReceivableFromClients": {
"type": "number",
"format": "int64",
"description": "Contas a receber de clientes - longo prazo.",
"nullable": true
},
"longTermInventory": {
"type": "number",
"format": "int64",
"description": "Estoques de longo prazo.",
"nullable": true
},
"longTermBiologicalAssets": {
"type": "number",
"format": "int64",
"description": "Ativos biológicos de longo prazo.",
"nullable": true
},
"longTermPrepaidExpenses": {
"type": "number",
"format": "int64",
"description": "Despesas antecipadas de longo prazo.",
"nullable": true
},
"creditsWithRelatedParties": {
"type": "number",
"format": "int64",
"description": "Créditos com partes relacionadas.",
"nullable": true
},
"shareholdings": {
"type": "number",
"format": "int64",
"description": "Participações societárias.",
"nullable": true
},
"investmentProperties": {
"type": "number",
"format": "int64",
"description": "Propriedades para investimento.",
"nullable": true
},
"otherLongTermReceivables": {
"type": "number",
"format": "int64",
"description": "Outros créditos/recebíveis de longo prazo.",
"nullable": true
},
"creditsFromOperations": {
"type": "number",
"format": "int64",
"description": "Créditos oriundos de operações (instituições financeiras/seguradoras).",
"nullable": true
},
"securitiesAndCreditsReceivable": {
"type": "number",
"format": "int64",
"description": "Títulos e créditos a receber.",
"nullable": true
},
"otherValuesAndAssets": {
"type": "number",
"format": "int64",
"description": "Outros valores e bens.",
"nullable": true
},
"compulsoryLoansAndDeposits": {
"type": "number",
"format": "int64",
"description": "Empréstimos e depósitos compulsórios.",
"nullable": true
},
"deferredSellingExpenses": {
"type": "number",
"format": "int64",
"description": "Despesas de comercialização diferidas.",
"nullable": true
},
"longTermFinancialInvestmentsMeasuredAtFairValueThroughIncome": {
"type": "number",
"format": "int64",
"description": "Investimentos financeiros de longo prazo mensurados a valor justo por meio do resultado.",
"nullable": true
},
"financialInvestmentsMeasuredAtFairValueThroughOtherComprehensiveIncome": {
"type": "number",
"format": "int64",
"description": "Investimentos financeiros mensurados a valor justo por outros resultados abrangentes.",
"nullable": true
},
"financialInvestmentsMeasuredAtAmortizedCost": {
"type": "number",
"format": "int64",
"description": "Investimentos financeiros mensurados ao custo amortizado.",
"nullable": true
},
"intangibleAsset": {
"type": "number",
"format": "int64",
"description": "Ativo intangível (valor agregado).",
"nullable": true
},
"deferredTaxes": {
"type": "number",
"format": "int64",
"description": "Tributos diferidos no ativo.",
"nullable": true
},
"otherOperations": {
"type": "number",
"format": "int64",
"description": "Outras contas operacionais no ativo.",
"nullable": true
},
"totalLiabilities": {
"type": "number",
"format": "int64",
"description": "Total do passivo.",
"nullable": true
},
"financialLiabilitiesMeasuredAtFairValueThroughIncome": {
"type": "number",
"format": "int64",
"description": "Passivos financeiros mensurados a valor justo por meio do resultado.",
"nullable": true
},
"financialLiabilitiesAtAmortizedCost": {
"type": "number",
"format": "int64",
"description": "Passivos financeiros ao custo amortizado.",
"nullable": true
},
"taxLiabilities": {
"type": "number",
"format": "int64",
"description": "Obrigações fiscais (passivo).",
"nullable": true
},
"otherLiabilities": {
"type": "number",
"format": "int64",
"description": "Outros passivos.",
"nullable": true
},
"controllerShareholdersEquity": {
"type": "number",
"format": "int64",
"description": "Patrimônio líquido atribuível aos controladores.",
"nullable": true
},
"nonControllingShareholdersEquity": {
"type": "number",
"format": "int64",
"description": "Participação dos não controladores no patrimônio líquido.",
"nullable": true
},
"revaluationReserves": {
"type": "number",
"format": "int64",
"description": "Reservas de reavaliação.",
"nullable": true
},
"accumulatedProfitsOrLosses": {
"type": "number",
"format": "int64",
"description": "Lucros ou prejuízos acumulados.",
"nullable": true
},
"equityValuationAdjustments": {
"type": "number",
"format": "int64",
"description": "Ajustes de avaliação patrimonial.",
"nullable": true
},
"cumulativeConversionAdjustments": {
"type": "number",
"format": "int64",
"description": "Ajustes acumulados de conversão.",
"nullable": true
},
"nationalSuppliers": {
"type": "number",
"format": "int64",
"description": "Fornecedores nacionais.",
"nullable": true
},
"foreignSuppliers": {
"type": "number",
"format": "int64",
"description": "Fornecedores estrangeiros.",
"nullable": true
},
"loansAndFinancingInNationalCurrency": {
"type": "number",
"format": "int64",
"description": "Empréstimos e financiamentos em moeda nacional (circulante).",
"nullable": true
},
"loansAndFinancingInForeignCurrency": {
"type": "number",
"format": "int64",
"description": "Empréstimos e financiamentos em moeda estrangeira (circulante).",
"nullable": true
},
"debentures": {
"type": "number",
"format": "int64",
"description": "Debêntures (passivo circulante).",
"nullable": true
},
"longTermLoansAndFinancingInNationalCurrency": {
"type": "number",
"format": "int64",
"description": "Empréstimos e financiamentos em moeda nacional (não circulante).",
"nullable": true
},
"longTermLoansAndFinancingInForeignCurrency": {
"type": "number",
"format": "int64",
"description": "Empréstimos e financiamentos em moeda estrangeira (não circulante).",
"nullable": true
},
"longTermDebentures": {
"type": "number",
"format": "int64",
"description": "Debêntures (passivo não circulante).",
"nullable": true
},
"otherNonCurrentLiabilities": {
"type": "number",
"format": "int64",
"description": "Outros passivos não circulantes.",
"nullable": true
},
"profitsAndRevenuesToBeAppropriated": {
"type": "number",
"format": "int64",
"description": "Lucros e receitas a apropriar.",
"nullable": true
},
"debitsFromOperations": {
"type": "number",
"format": "int64",
"description": "Débitos oriundos de operações.",
"nullable": true
},
"debitsFromInsuranceAndReinsurance": {
"type": "number",
"format": "int64",
"description": "Débitos de operações de seguros e resseguros.",
"nullable": true
},
"debitsFromComplementaryPension": {
"type": "number",
"format": "int64",
"description": "Débitos de operações de previdência complementar.",
"nullable": true
},
"thirdPartyDeposits": {
"type": "number",
"format": "int64",
"description": "Depósitos de terceiros.",
"nullable": true
},
"technicalProvisions": {
"type": "number",
"format": "int64",
"description": "Provisões técnicas (seguradoras/previdência).",
"nullable": true
},
"insuranceAndReinsurance": {
"type": "number",
"format": "int64",
"description": "Provisões/obrigações de seguros e resseguros.",
"nullable": true
},
"complementaryPension": {
"type": "number",
"format": "int64",
"description": "Obrigações de previdência complementar.",
"nullable": true
},
"capitalization": {
"type": "number",
"format": "int64",
"description": "Obrigações de capitalização.",
"nullable": true
},
"otherDebits": {
"type": "number",
"format": "int64",
"description": "Outros débitos.",
"nullable": true
},
"longTermLiabilities": {
"type": "number",
"format": "int64",
"description": "Total do passivo de longo prazo.",
"nullable": true
},
"longTermAccountsPayable": {
"type": "number",
"format": "int64",
"description": "Fornecedores/contas a pagar de longo prazo.",
"nullable": true
},
"longTermDebitsFromOperations": {
"type": "number",
"format": "int64",
"description": "Débitos de operações (longo prazo).",
"nullable": true
},
"longTermTechnicalProvisions": {
"type": "number",
"format": "int64",
"description": "Provisões técnicas de longo prazo.",
"nullable": true
},
"longTermInsuranceAndReinsurance": {
"type": "number",
"format": "int64",
"description": "Obrigações de seguros e resseguros de longo prazo.",
"nullable": true
},
"longTermComplementaryPension": {
"type": "number",
"format": "int64",
"description": "Obrigações de previdência complementar de longo prazo.",
"nullable": true
},
"longTermCapitalization": {
"type": "number",
"format": "int64",
"description": "Obrigações de capitalização de longo prazo.",
"nullable": true
},
"otherLongTermProvisions": {
"type": "number",
"format": "int64",
"description": "Outras provisões de longo prazo.",
"nullable": true
},
"debitsFromCapitalization": {
"type": "number",
"format": "int64",
"description": "Débitos de operações de capitalização.",
"nullable": true
},
"debitsFromOtherOperations": {
"type": "number",
"format": "int64",
"description": "Débitos de outras operações.",
"nullable": true
},
"otherProvisions": {
"type": "number",
"format": "int64",
"description": "Outras provisões (diversas).",
"nullable": true
},
"advanceForFutureCapitalIncrease": {
"type": "number",
"format": "int64",
"description": "Adiantamento para futuro aumento de capital (AFAC).",
"nullable": true
}
}
},
"BalanceSheetHistory": {
"type": "object",
"description": "Contém o histórico **anual** do Balanço Patrimonial. Retornado via `modules=balanceSheetHistory`.",
"properties": {
"balanceSheetHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BalanceSheetEntry"
},
"description": "Lista de Balanços Patrimoniais anuais, ordenados geralmente do mais recente para o mais antigo."
}
}
},
"BalanceSheetHistoryQuarterly": {
"type": "object",
"description": "Contém o histórico **trimestral** do Balanço Patrimonial. Retornado via `modules=balanceSheetHistoryQuarterly`.",
"properties": {
"balanceSheetHistoryQuarterly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BalanceSheetEntry"
},
"description": "Lista de Balanços Patrimoniais trimestrais, ordenados geralmente do mais recente para o mais antigo."
}
}
},
"DefaultKeyStatisticsEntry": {
"type": "object",
"description": "Representa um conjunto de principais indicadores e estatísticas financeiras para um período (TTM, anual ou trimestral).",
"properties": {
"type": {
"type": "string",
"enum": [
"yearly",
"quarterly",
"ttm"
],
"description": "Periodicidade dos dados: `yearly` (anual), `quarterly` (trimestral), `ttm` (Trailing Twelve Months - últimos 12 meses)."
},
"symbol": {
"type": "string",
"description": "Ticker do ativo ao qual as estatísticas se referem."
},
"enterpriseValue": {
"type": "number",
"format": "float",
"description": "Valor da Firma (Enterprise Value - EV): Market Cap + Dívida Total - Caixa.",
"nullable": true
},
"forwardPE": {
"type": "number",
"format": "float",
"description": "Preço / Lucro Projetado (Forward P/E): Preço da Ação / LPA estimado para o próximo período.",
"nullable": true
},
"profitMargins": {
"type": "number",
"format": "float",
"description": "Margem de Lucro Líquida (Lucro Líquido / Receita Líquida). Geralmente em base TTM ou anual.",
"nullable": true
},
"floatShares": {
"type": "number",
"format": "int64",
"description": "Ações em livre circulação (free float).",
"nullable": true
},
"sharesOutstanding": {
"type": "number",
"format": "int64",
"description": "Número total de ações ordinárias em circulação.",
"nullable": true
},
"heldPercentInsiders": {
"type": "number",
"format": "float",
"description": "Percentual de ações detidas por insiders (administradores, controladores).",
"nullable": true
},
"heldPercentInstitutions": {
"type": "number",
"format": "float",
"description": "Percentual de ações detidas por instituições (fundos, investidores institucionais).",
"nullable": true
},
"beta": {
"type": "number",
"format": "float",
"description": "Beta da ação (sensibilidade em relação ao mercado).",
"nullable": true
},
"impliedSharesOutstanding": {
"type": "number",
"format": "int64",
"description": "Ações implícitas em circulação (considerando diluição/derivativos).",
"nullable": true
},
"bookValue": {
"type": "number",
"format": "float",
"description": "Valor Patrimonial por Ação (VPA): Patrimônio Líquido / Ações em Circulação.",
"nullable": true
},
"priceToBook": {
"type": "number",
"format": "float",
"description": "Preço sobre Valor Patrimonial (P/VP): Preço da Ação / VPA.",
"nullable": true
},
"lastFiscalYearEnd": {
"type": "string",
"format": "date",
"description": "Data de encerramento do último ano fiscal (YYYY-MM-DD).",
"nullable": true
},
"nextFiscalYearEnd": {
"type": "string",
"format": "date",
"description": "Data de encerramento do próximo ano fiscal (YYYY-MM-DD).",
"nullable": true
},
"mostRecentQuarter": {
"type": "string",
"format": "date",
"description": "Data de término do trimestre mais recente considerado nos cálculos (YYYY-MM-DD).",
"nullable": true
},
"earningsQuarterlyGrowth": {
"type": "number",
"format": "float",
"description": "Crescimento percentual do lucro líquido no último trimestre em relação ao mesmo trimestre do ano anterior (YoY).",
"nullable": true
},
"earningsAnnualGrowth": {
"type": "number",
"format": "float",
"description": "Crescimento percentual do lucro líquido no último ano fiscal completo em relação ao ano anterior.",
"nullable": true
},
"netIncomeToCommon": {
"type": "number",
"format": "int64",
"description": "Lucro Líquido atribuível aos acionistas ordinários (controladores).",
"nullable": true
},
"trailingEps": {
"type": "number",
"format": "float",
"description": "Lucro Por Ação (LPA) dos Últimos 12 Meses (TTM).",
"nullable": true
},
"forwardEps": {
"type": "number",
"format": "float",
"description": "Lucro Por Ação projetado (próximo período).",
"nullable": true
},
"pegRatio": {
"type": "number",
"format": "float",
"description": "Índice PEG (P/E dividido pelo crescimento esperado dos lucros).",
"nullable": true
},
"lastSplitFactor": {
"type": "string",
"description": "Fator do último desdobramento/grupamento (ex.: 2:1, 1:10).",
"nullable": true
},
"lastSplitDate": {
"type": "number",
"format": "int64",
"description": "Data do último desdobramento/grupamento (timestamp UNIX em segundos).",
"nullable": true
},
"enterpriseToRevenue": {
"type": "number",
"format": "float",
"description": "Múltiplo EV/Receita (Enterprise Value / Receita Líquida TTM).",
"nullable": true
},
"enterpriseToEbitda": {
"type": "number",
"format": "float",
"description": "Múltiplo EV/EBITDA (Enterprise Value / EBITDA TTM).",
"nullable": true
},
"52WeekChange": {
"type": "number",
"format": "float",
"description": "Variação percentual do preço da ação nas últimas 52 semanas.",
"nullable": true
},
"SandP52WeekChange": {
"type": "number",
"format": "float",
"description": "Variação percentual do índice S&P 500 nas últimas 52 semanas (para referência).",
"nullable": true
},
"lastDividendValue": {
"type": "number",
"format": "float",
"description": "Valor do último dividendo ou JCP pago por ação.",
"nullable": true
},
"lastDividendDate": {
"type": "string",
"format": "date",
"description": "Data de pagamento (ou 'Data Com') do último dividendo/JCP (YYYY-MM-DD).",
"nullable": true
},
"dividendYield": {
"type": "number",
"format": "float",
"description": "Dividend Yield (provento anualizado sobre o preço atual).",
"nullable": true
},
"ytdReturn": {
"type": "number",
"format": "float",
"description": "Retorno percentual do preço da ação desde o início do ano atual (Year-to-Date).",
"nullable": true
},
"totalAssets": {
"type": "number",
"format": "int64",
"description": "Valor total dos ativos registrado no último balanço (anual ou trimestral).",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date",
"description": "Data da última atualização deste registro específico na fonte de dados (YYYY-MM-DD).",
"nullable": true
}
}
},
"DefaultKeyStatistics": {
"type": "object",
"description": "Contém as principais estatísticas financeiras atuais ou TTM (Trailing Twelve Months). Retornado via `modules=defaultKeyStatistics`.",
"properties": {
"defaultKeyStatistics": {
"$ref": "#/components/schemas/DefaultKeyStatisticsEntry",
"description": "Objeto contendo as principais estatísticas."
}
}
},
"DefaultKeyStatisticsHistory": {
"type": "object",
"description": "Contém o histórico **anual** das principais estatísticas financeiras. Retornado via `modules=defaultKeyStatisticsHistory`.",
"properties": {
"defaultKeyStatisticsHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DefaultKeyStatisticsEntry"
},
"description": "Lista das principais estatísticas anuais, ordenadas geralmente do mais recente para o mais antigo."
}
}
},
"DefaultKeyStatisticsHistoryQuarterly": {
"type": "object",
"description": "Contém o histórico **trimestral** das principais estatísticas financeiras. Retornado via `modules=defaultKeyStatisticsHistoryQuarterly`.",
"properties": {
"defaultKeyStatisticsHistoryQuarterly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DefaultKeyStatisticsEntry"
},
"description": "Lista das principais estatísticas trimestrais, ordenadas geralmente do mais recente para o mais antigo."
}
}
},
"IncomeStatementEntry": {
"type": "object",
"description": "Representa os dados de uma Demonstração do Resultado do Exercício (DRE) para um período específico (anual ou trimestral).",
"properties": {
"id": {
"type": "string",
"description": "Identificador único deste registro de DRE (interno)."
},
"symbol": {
"type": "string",
"description": "Ticker do ativo ao qual a DRE se refere."
},
"type": {
"type": "string",
"enum": [
"yearly",
"quarterly"
],
"description": "Indica a periodicidade da DRE: `yearly` (anual) ou `quarterly` (trimestral)."
},
"endDate": {
"type": "string",
"format": "date",
"description": "Data de término do período fiscal ao qual a DRE se refere (YYYY-MM-DD)."
},
"totalRevenue": {
"type": "number",
"format": "int64",
"description": "Receita Operacional Líquida.",
"nullable": true
},
"costOfRevenue": {
"type": "number",
"format": "int64",
"description": "Custo dos Produtos Vendidos (CPV) ou Custo dos Serviços Prestados (CSP).",
"nullable": true
},
"grossProfit": {
"type": "number",
"format": "int64",
"description": "Lucro Bruto (Receita Líquida - CPV/CSP).",
"nullable": true
},
"researchDevelopment": {
"type": "number",
"format": "int64",
"description": "Despesas com Pesquisa e Desenvolvimento.",
"nullable": true
},
"sellingGeneralAdministrative": {
"type": "number",
"format": "int64",
"description": "Despesas com Vendas, Gerais e Administrativas.",
"nullable": true
},
"nonRecurring": {
"type": "number",
"format": "int64",
"description": "Itens Não Recorrentes (pode incluir outras despesas/receitas operacionais).",
"nullable": true
},
"otherOperatingExpenses": {
"type": "number",
"format": "int64",
"description": "Outras Despesas Operacionais.",
"nullable": true
},
"totalOperatingExpenses": {
"type": "number",
"format": "int64",
"description": "Total das Despesas Operacionais (P&D + SG&A + Outras).",
"nullable": true
},
"operatingIncome": {
"type": "number",
"format": "int64",
"description": "Lucro Operacional (EBIT - Earnings Before Interest and Taxes). Lucro Bruto - Despesas Operacionais.",
"nullable": true
},
"totalOtherIncomeExpenseNet": {
"type": "number",
"format": "int64",
"description": "Resultado Financeiro Líquido + Outras Receitas/Despesas.",
"nullable": true
},
"ebit": {
"type": "number",
"format": "int64",
"description": "Lucro Antes dos Juros e Impostos (LAJIR ou EBIT). Geralmente igual a `operatingIncome`.",
"nullable": true
},
"interestExpense": {
"type": "number",
"format": "int64",
"description": "Despesas Financeiras (Juros pagos). Note que este campo é negativo.",
"nullable": true
},
"incomeBeforeTax": {
"type": "number",
"format": "int64",
"description": "Lucro Antes do Imposto de Renda e Contribuição Social (LAIR). EBIT + Resultado Financeiro.",
"nullable": true
},
"incomeTaxExpense": {
"type": "number",
"format": "int64",
"description": "Imposto de Renda e Contribuição Social sobre o Lucro.",
"nullable": true
},
"minorityInterest": {
"type": "number",
"format": "int64",
"description": "Participação de Acionistas Não Controladores (no Lucro Líquido).",
"nullable": true
},
"netIncomeFromContinuingOps": {
"type": "number",
"format": "int64",
"description": "Lucro Líquido das Operações Continuadas.",
"nullable": true
},
"discontinuedOperations": {
"type": "number",
"format": "int64",
"description": "Resultado Líquido das Operações Descontinuadas.",
"nullable": true
},
"extraordinaryItems": {
"type": "number",
"format": "int64",
"description": "Itens Extraordinários.",
"nullable": true
},
"effectOfAccountingCharges": {
"type": "number",
"format": "int64",
"description": "Efeito de Mudanças Contábeis.",
"nullable": true
},
"otherItems": {
"type": "number",
"format": "int64",
"description": "Outros Itens.",
"nullable": true
},
"netIncome": {
"type": "number",
"format": "int64",
"description": "Lucro Líquido Consolidado do Período.",
"nullable": true
},
"netIncomeApplicableToCommonShares": {
"type": "number",
"format": "int64",
"description": "Lucro Líquido Atribuível aos Acionistas Controladores (Ações Ordinárias).",
"nullable": true
},
"salesExpenses": {
"type": "number",
"format": "int64",
"description": "Despesas com Vendas (detalhamento, pode estar contido em SG&A).",
"nullable": true
},
"lossesDueToNonRecoverabilityOfAssets": {
"type": "number",
"format": "int64",
"description": "Perdas por Não Recuperabilidade de Ativos (Impairment).",
"nullable": true
},
"otherOperatingIncome": {
"type": "number",
"format": "int64",
"description": "Outras Receitas Operacionais (detalhamento).",
"nullable": true
},
"equityIncomeResult": {
"type": "number",
"format": "int64",
"description": "Resultado de Equivalência Patrimonial.",
"nullable": true
},
"financialResult": {
"type": "number",
"format": "int64",
"description": "Resultado Financeiro Líquido.",
"nullable": true
},
"financialIncome": {
"type": "number",
"format": "int64",
"description": "Receitas Financeiras.",
"nullable": true
},
"financialExpenses": {
"type": "number",
"format": "int64",
"description": "Despesas Financeiras (valor positivo aqui, diferente de `interestExpense`).",
"nullable": true
},
"currentTaxes": {
"type": "number",
"format": "int64",
"description": "Imposto de Renda e Contribuição Social Correntes.",
"nullable": true
},
"deferredTaxes": {
"type": "number",
"format": "int64",
"description": "Imposto de Renda e Contribuição Social Diferidos.",
"nullable": true
},
"incomeBeforeStatutoryParticipationsAndContributions": {
"type": "number",
"format": "int64",
"description": "Resultado Antes das Participações Estatutárias.",
"nullable": true
},
"basicEarningsPerCommonShare": {
"type": "number",
"format": "float",
"description": "Lucro Básico por Ação Ordinária (ON).",
"nullable": true
},
"dilutedEarningsPerCommonShare": {
"type": "number",
"format": "float",
"description": "Lucro Diluído por Ação Ordinária (ON).",
"nullable": true
},
"basicEarningsPerPreferredShare": {
"type": "number",
"format": "float",
"description": "Lucro Básico por Ação Preferencial (PN).",
"nullable": true
},
"profitSharingAndStatutoryContributions": {
"type": "number",
"format": "int64",
"description": "Participações nos Lucros e Contribuições Estatutárias.",
"nullable": true
},
"dilutedEarningsPerPreferredShare": {
"type": "number",
"format": "float",
"description": "Lucro Diluído por Ação Preferencial (PN).",
"nullable": true
},
"claimsAndOperationsCosts": {
"type": "number",
"format": "int64",
"description": "Custos com Sinistros e Operações (específico para Seguradoras).",
"nullable": true
},
"administrativeCosts": {
"type": "number",
"format": "int64",
"description": "Despesas Administrativas (detalhamento, pode estar contido em SG&A).",
"nullable": true
},
"otherOperatingIncomeAndExpenses": {
"type": "number",
"format": "int64",
"description": "Outras Receitas e Despesas Operacionais (agregado).",
"nullable": true
},
"earningsPerShare": {
"type": "number",
"format": "float",
"description": "Lucro por Ação (LPA) - Geral (pode ser básico ou diluído, verificar contexto).",
"nullable": true
},
"basicEarningsPerShare": {
"type": "number",
"format": "float",
"description": "Lucro Básico por Ação (LPA Básico) - Geral.",
"nullable": true
},
"dilutedEarningsPerShare": {
"type": "number",
"format": "float",
"description": "Lucro Diluído por Ação (LPA Diluído) - Geral.",
"nullable": true
},
"insuranceOperations": {
"type": "number",
"format": "int64",
"description": "Resultado de Operações de Seguros (específico para Seguradoras).",
"nullable": true
},
"reinsuranceOperations": {
"type": "number",
"format": "int64",
"description": "Resultado de Operações de Resseguros (específico para Seguradoras).",
"nullable": true
},
"complementaryPensionOperations": {
"type": "number",
"format": "int64",
"description": "Resultado de Operações de Previdência Complementar (específico para Seguradoras/Previdência).",
"nullable": true
},
"capitalizationOperations": {
"type": "number",
"format": "int64",
"description": "Resultado de Operações de Capitalização (específico para Seguradoras).",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date",
"description": "Data da última atualização deste registro específico na fonte de dados (YYYY-MM-DD).",
"nullable": true
}
}
},
"IncomeStatementHistory": {
"type": "object",
"description": "Contém o histórico **anual** da Demonstração do Resultado do Exercício (DRE). Retornado via `modules=incomeStatementHistory`.",
"properties": {
"incomeStatementHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IncomeStatementEntry"
},
"description": "Lista de DREs anuais, ordenadas geralmente do mais recente para o mais antigo."
}
}
},
"IncomeStatementHistoryQuarterly": {
"type": "object",
"description": "Contém o histórico **trimestral** da Demonstração do Resultado do Exercício (DRE). Retornado via `modules=incomeStatementHistoryQuarterly`.",
"properties": {
"incomeStatementHistoryQuarterly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IncomeStatementEntry"
},
"description": "Lista de DREs trimestrais, ordenadas geralmente do mais recente para o mais antigo."
}
}
},
"FinancialDataEntry": {
"type": "object",
"description": "Representa um conjunto de dados e indicadores financeiros calculados para um período (TTM, anual ou trimestral).",
"properties": {
"symbol": {
"type": "string",
"description": "Ticker do ativo ao qual os dados se referem."
},
"currentPrice": {
"type": "number",
"format": "float",
"description": "Preço atual da ação (pode ser ligeiramente defasado).",
"nullable": true
},
"targetHighPrice": {
"type": "number",
"format": "float",
"description": "Preço-alvo mais alto estimado por analistas.",
"nullable": true
},
"targetLowPrice": {
"type": "number",
"format": "float",
"description": "Preço-alvo mais baixo estimado por analistas.",
"nullable": true
},
"targetMeanPrice": {
"type": "number",
"format": "float",
"description": "Preço-alvo médio estimado por analistas.",
"nullable": true
},
"targetMedianPrice": {
"type": "number",
"format": "float",
"description": "Preço-alvo mediano estimado por analistas.",
"nullable": true
},
"recommendationMean": {
"type": "number",
"format": "float",
"description": "Média de recomendações dos analistas (1=Compra Forte, 5=Venda Forte).",
"nullable": true
},
"recommendationKey": {
"type": "string",
"description": "Resumo da recomendação (ex.: strong_buy, buy, hold, sell, strong_sell).",
"nullable": true
},
"numberOfAnalystOpinions": {
"type": "number",
"format": "int32",
"description": "Número de opiniões de analistas consideradas.",
"nullable": true
},
"ebitda": {
"type": "number",
"format": "int64",
"description": "Lucro Antes de Juros, Impostos, Depreciação e Amortização (LAJIDA ou EBITDA). Geralmente TTM.",
"nullable": true
},
"quickRatio": {
"type": "number",
"format": "float",
"description": "Índice de Liquidez Seca ((Ativo Circulante - Estoques) / Passivo Circulante).",
"nullable": true
},
"currentRatio": {
"type": "number",
"format": "float",
"description": "Índice de Liquidez Corrente (Ativo Circulante / Passivo Circulante).",
"nullable": true
},
"debtToEquity": {
"type": "number",
"format": "float",
"description": "Índice Dívida Líquida / Patrimônio Líquido.",
"nullable": true
},
"revenuePerShare": {
"type": "number",
"format": "float",
"description": "Receita Líquida por Ação (Receita Líquida TTM / Ações em Circulação).",
"nullable": true
},
"returnOnAssets": {
"type": "number",
"format": "float",
"description": "Retorno sobre Ativos (ROA): Lucro Líquido TTM / Ativo Total Médio.",
"nullable": true
},
"returnOnEquity": {
"type": "number",
"format": "float",
"description": "Retorno sobre Patrimônio Líquido (ROE): Lucro Líquido TTM / Patrimônio Líquido Médio.",
"nullable": true
},
"earningsGrowth": {
"type": "number",
"format": "float",
"description": "Crescimento do Lucro Líquido (geralmente trimestral YoY, como `earningsQuarterlyGrowth`).",
"nullable": true
},
"revenueGrowth": {
"type": "number",
"format": "float",
"description": "Crescimento da Receita Líquida (geralmente trimestral YoY).",
"nullable": true
},
"grossMargins": {
"type": "number",
"format": "float",
"description": "Margem Bruta (Lucro Bruto TTM / Receita Líquida TTM).",
"nullable": true
},
"ebitdaMargins": {
"type": "number",
"format": "float",
"description": "Margem EBITDA (EBITDA TTM / Receita Líquida TTM).",
"nullable": true
},
"operatingMargins": {
"type": "number",
"format": "float",
"description": "Margem Operacional (EBIT TTM / Receita Líquida TTM).",
"nullable": true
},
"profitMargins": {
"type": "number",
"format": "float",
"description": "Margem Líquida (Lucro Líquido TTM / Receita Líquida TTM). Sinônimo do campo de mesmo nome em `DefaultKeyStatisticsEntry`.",
"nullable": true
},
"totalCash": {
"type": "number",
"format": "int64",
"description": "Caixa e Equivalentes de Caixa + Aplicações Financeiras de Curto Prazo (último balanço).",
"nullable": true
},
"totalCashPerShare": {
"type": "number",
"format": "float",
"description": "Caixa Total por Ação (Caixa Total / Ações em Circulação).",
"nullable": true
},
"totalDebt": {
"type": "number",
"format": "int64",
"description": "Dívida Bruta Total (Dívida de Curto Prazo + Dívida de Longo Prazo - último balanço).",
"nullable": true
},
"totalRevenue": {
"type": "number",
"format": "int64",
"description": "Receita Líquida Total (geralmente TTM).",
"nullable": true
},
"grossProfits": {
"type": "number",
"format": "int64",
"description": "Lucro Bruto (geralmente TTM).",
"nullable": true
},
"operatingCashflow": {
"type": "number",
"format": "int64",
"description": "Fluxo de Caixa das Operações (FCO) - (geralmente TTM).",
"nullable": true
},
"freeCashflow": {
"type": "number",
"format": "int64",
"description": "Fluxo de Caixa Livre (FCO - CAPEX) - (geralmente TTM).",
"nullable": true
},
"financialCurrency": {
"type": "string",
"description": "Moeda na qual os dados financeiros são reportados (ex: `BRL`, `USD`).",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date",
"description": "Data da última atualização deste registro específico na fonte de dados (YYYY-MM-DD)."
},
"type": {
"type": "string",
"enum": [
"yearly",
"quarterly",
"ttm"
],
"description": "Periodicidade dos dados: `yearly` (anual), `quarterly` (trimestral), `ttm` (Trailing Twelve Months)."
}
}
},
"FinancialData": {
"type": "object",
"description": "Contém dados financeiros e indicadores TTM (Trailing Twelve Months). Retornado via `modules=financialData`.",
"properties": {
"financialData": {
"$ref": "#/components/schemas/FinancialDataEntry",
"description": "Objeto contendo os dados financeiros TTM."
}
}
},
"FinancialDataHistory": {
"type": "object",
"description": "Contém o histórico **anual** de dados financeiros e indicadores. Retornado via `modules=financialDataHistory`.",
"properties": {
"financialDataHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialDataEntry"
},
"description": "Lista de dados financeiros anuais, ordenados geralmente do mais recente para o mais antigo."
}
}
},
"FinancialDataHistoryQuarterly": {
"type": "object",
"description": "Contém o histórico **trimestral** de dados financeiros e indicadores. Retornado via `modules=financialDataHistoryQuarterly`.",
"properties": {
"financialDataHistoryQuarterly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialDataEntry"
},
"description": "Lista de dados financeiros trimestrais, ordenados geralmente do mais recente para o mais antigo."
}
}
},
"ValueAddedEntry": {
"type": "object",
"description": "Representa os dados de uma Demonstração do Valor Adicionado (DVA) para um período específico (anual ou trimestral). A DVA mostra como a riqueza gerada pela empresa foi distribuída.",
"properties": {
"symbol": {
"type": "string",
"description": "Ticker do ativo ao qual a DVA se refere."
},
"type": {
"type": "string",
"enum": [
"yearly",
"quarterly"
],
"description": "Indica a periodicidade da DVA: `yearly` (anual) ou `quarterly` (trimestral)."
},
"endDate": {
"type": "string",
"format": "date",
"description": "Data de término do período fiscal ao qual a DVA se refere (YYYY-MM-DD)."
},
"revenue": {
"type": "number",
"format": "int64",
"description": "Receitas (Venda de Mercadorias, Produtos e Serviços, etc.). Item 1 da DVA.",
"nullable": true
},
"financialIntermediationRevenue": {
"type": "number",
"format": "int64",
"description": "Receita de Intermediação Financeira (específico para bancos).",
"nullable": true
},
"revenueFromTheProvisionOfServices": {
"type": "number",
"format": "int64",
"description": "Receita da Prestação de Serviços (detalhamento).",
"nullable": true
},
"provisionOrReversalOfExpectedCreditRiskLosses": {
"type": "number",
"format": "int64",
"description": "Provisão/Reversão de Perdas com Risco de Crédito (PCLD).",
"nullable": true
},
"otherRevenues": {
"type": "number",
"format": "int64",
"description": "Outras Receitas.",
"nullable": true
},
"financialIntermediationExpenses": {
"type": "number",
"format": "int64",
"description": "Despesas de Intermediação Financeira (específico para bancos).",
"nullable": true
},
"suppliesPurchasedFromThirdParties": {
"type": "number",
"format": "int64",
"description": "Insumos Adquiridos de Terceiros (Custo de Mercadorias, Matérias-Primas). Item 2 da DVA.",
"nullable": true
},
"materialsEnergyAndOthers": {
"type": "number",
"format": "int64",
"description": "Custos com Materiais, Energia, Serviços de Terceiros e Outros.",
"nullable": true
},
"services": {
"type": "number",
"format": "int64",
"description": "Serviços de Terceiros (detalhamento).",
"nullable": true
},
"lossOrRecoveryOfAssetValues": {
"type": "number",
"format": "int64",
"description": "Perda / Recuperação de Valores de Ativos (Impairment).",
"nullable": true
},
"otherSupplies": {
"type": "number",
"format": "int64",
"description": "Outros Insumos.",
"nullable": true
},
"grossAddedValue": {
"type": "number",
"format": "int64",
"description": "Valor Adicionado Bruto (Receitas - Insumos). Item 3 da DVA.",
"nullable": true
},
"retentions": {
"type": "number",
"format": "int64",
"description": "Retenções (Depreciação, Amortização e Exaustão). Item 4 da DVA.",
"nullable": true
},
"depreciationAndAmortization": {
"type": "number",
"format": "int64",
"description": "Depreciação e Amortização.",
"nullable": true
},
"otherRetentions": {
"type": "number",
"format": "int64",
"description": "Outras Retenções (Exaustão, etc.).",
"nullable": true
},
"netAddedValue": {
"type": "number",
"format": "int64",
"description": "Valor Adicionado Líquido Produzido pela Entidade (Bruto - Retenções). Item 5 da DVA.",
"nullable": true
},
"addedValueReceivedByTransfer": {
"type": "number",
"format": "int64",
"description": "Valor Adicionado Recebido em Transferência (Resultado de Equivalência Patrimonial, Receitas Financeiras, etc.). Item 6 da DVA.",
"nullable": true
},
"equityIncomeResult": {
"type": "number",
"format": "int64",
"description": "Resultado de Equivalência Patrimonial (como receita na DVA).",
"nullable": true
},
"otherValuesReceivedByTransfer": {
"type": "number",
"format": "int64",
"description": "Outros Valores Recebidos (Receitas Financeiras, Aluguéis, etc.).",
"nullable": true
},
"addedValueToDistribute": {
"type": "number",
"format": "int64",
"description": "Valor Adicionado Total a Distribuir (Líquido Produzido + Recebido em Transferência). Item 7 da DVA.",
"nullable": true
},
"distributionOfAddedValue": {
"type": "number",
"format": "int64",
"description": "Distribuição do Valor Adicionado (Soma dos itens seguintes). Item 8 da DVA.",
"nullable": true
},
"teamRemuneration": {
"type": "number",
"format": "int64",
"description": "Pessoal e Encargos (Salários, Benefícios, FGTS).",
"nullable": true
},
"taxes": {
"type": "number",
"format": "int64",
"description": "Impostos, Taxas e Contribuições (Federais, Estaduais, Municipais).",
"nullable": true
},
"federalTaxes": {
"type": "number",
"format": "int64",
"description": "Impostos Federais (IRPJ, CSLL, PIS, COFINS, IPI).",
"nullable": true
},
"stateTaxes": {
"type": "number",
"format": "int64",
"description": "Impostos Estaduais (ICMS).",
"nullable": true
},
"municipalTaxes": {
"type": "number",
"format": "int64",
"description": "Impostos Municipais (ISS).",
"nullable": true
},
"remunerationOfThirdPartyCapitals": {
"type": "number",
"format": "int64",
"description": "Remuneração de Capitais de Terceiros (Juros, Aluguéis).",
"nullable": true
},
"equityRemuneration": {
"type": "number",
"format": "int64",
"description": "Remuneração de Capitais Próprios (JCP, Dividendos, Lucros Retidos).",
"nullable": true
},
"interestOnOwnEquity": {
"type": "number",
"format": "int64",
"description": "Juros sobre o Capital Próprio (JCP).",
"nullable": true
},
"dividends": {
"type": "number",
"format": "int64",
"description": "Dividendos Distribuídos.",
"nullable": true
},
"retainedEarningsOrLoss": {
"type": "number",
"format": "int64",
"description": "Lucros Retidos ou Prejuízo do Exercício.",
"nullable": true
},
"nonControllingShareOfRetainedEarnings": {
"type": "number",
"format": "int64",
"description": "Participação dos Não Controladores nos Lucros Retidos.",
"nullable": true
},
"otherDistributions": {
"type": "number",
"format": "int64",
"description": "Outras Distribuições.",
"nullable": true
},
"productSales": {
"type": "number",
"format": "int64",
"description": "Venda de Produtos e Serviços (detalhamento).",
"nullable": true
},
"constructionOfOwnAssets": {
"type": "number",
"format": "int64",
"description": "Construção de Ativos Próprios.",
"nullable": true
},
"provisionOrReversalOfDoubtfulAccounts": {
"type": "number",
"format": "int64",
"description": "Provisão/Reversão para Créditos de Liquidação Duvidosa (PCLD - como receita/despesa na DVA).",
"nullable": true
},
"costsWithProductsSold": {
"type": "number",
"format": "int64",
"description": "Custos dos Produtos, Mercadorias e Serviços Vendidos (detalhamento).",
"nullable": true
},
"thirdPartyMaterialsAndServices": {
"type": "number",
"format": "int64",
"description": "Materiais, Energia, Serviços de Terceiros.",
"nullable": true
},
"lossOrRecoveryOfAssets": {
"type": "number",
"format": "int64",
"description": "Perda/Recuperação de Valores de Ativos (Impairment - como custo/receita).",
"nullable": true
},
"netAddedValueProduced": {
"type": "number",
"format": "int64",
"description": "Valor Adicionado Líquido Produzido (sinônimo de `netAddedValue`).",
"nullable": true
},
"addedValueReceivedOnTransfer": {
"type": "number",
"format": "int64",
"description": "Valor Adicionado Recebido em Transferência (sinônimo de `addedValueReceivedByTransfer`).",
"nullable": true
},
"financialIncome": {
"type": "number",
"format": "int64",
"description": "Receitas Financeiras (como valor recebido em transferência).",
"nullable": true
},
"insuranceOperationsRevenue": {
"type": "number",
"format": "int64",
"description": "Receita com Operações de Seguros (específico para Seguradoras).",
"nullable": true
},
"complementaryPensionOperationsRevenue": {
"type": "number",
"format": "int64",
"description": "Receita com Operações de Previdência Complementar.",
"nullable": true
},
"feesRevenue": {
"type": "number",
"format": "int64",
"description": "Receita com Taxas e Comissões.",
"nullable": true
},
"variationsOfTechnicalProvisions": {
"type": "number",
"format": "int64",
"description": "Variações das Provisões Técnicas (específico para Seguradoras).",
"nullable": true
},
"insuranceOperationsVariations": {
"type": "number",
"format": "int64",
"description": "Variações de Operações de Seguros.",
"nullable": true
},
"pensionOperationsVariations": {
"type": "number",
"format": "int64",
"description": "Variações de Operações de Previdência.",
"nullable": true
},
"otherVariations": {
"type": "number",
"format": "int64",
"description": "Outras Variações.",
"nullable": true
},
"netOperatingRevenue": {
"type": "number",
"format": "int64",
"description": "Receita Operacional Líquida (detalhamento).",
"nullable": true
},
"claimsAndBenefits": {
"type": "number",
"format": "int64",
"description": "Sinistros Retidos e Benefícios.",
"nullable": true
},
"variationInDeferredSellingExpenses": {
"type": "number",
"format": "int64",
"description": "Variação nas Despesas de Comercialização Diferidas.",
"nullable": true
},
"resultsOfCededReinsuranceOperations": {
"type": "number",
"format": "int64",
"description": "Resultados de Operações de Resseguros Cedidos.",
"nullable": true
},
"resultOfCoinsuranceOperationsAssigned": {
"type": "number",
"format": "int64",
"description": "Resultado de Operações de Cosseguros Cedidos.",
"nullable": true
},
"totalAddedValueToDistribute": {
"type": "number",
"format": "int64",
"description": "Valor Adicionado Total a Distribuir (sinônimo de `addedValueToDistribute`).",
"nullable": true
},
"ownEquityRemuneration": {
"type": "number",
"format": "int64",
"description": "Remuneração de Capitais Próprios (sinônimo de `equityRemuneration`).",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date",
"description": "Data da última atualização deste registro específico na fonte de dados (YYYY-MM-DD)."
}
}
},
"ValueAddedHistory": {
"type": "object",
"description": "Contém o histórico **anual** da Demonstração do Valor Adicionado (DVA). Retornado via `modules=valueAddedHistory`.",
"properties": {
"valueAddedHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueAddedEntry"
},
"description": "Lista de DVAs anuais, ordenadas geralmente do mais recente para o mais antigo."
}
}
},
"ValueAddedHistoryQuarterly": {
"type": "object",
"description": "Contém o histórico **trimestral** da Demonstração do Valor Adicionado (DVA). Retornado via `modules=valueAddedHistoryQuarterly`.",
"properties": {
"valueAddedHistoryQuarterly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueAddedEntry"
},
"description": "Lista de DVAs trimestrais, ordenadas geralmente do mais recente para o mais antigo."
}
}
},
"CashflowEntry": {
"type": "object",
"description": "Representa os dados de uma Demonstração do Fluxo de Caixa (DFC) para um período específico (anual ou trimestral).",
"properties": {
"symbol": {
"type": "string",
"description": "Ticker do ativo ao qual a DFC se refere."
},
"type": {
"type": "string",
"enum": [
"yearly",
"quarterly"
],
"description": "Indica a periodicidade da DFC: `yearly` (anual) ou `quarterly` (trimestral)."
},
"endDate": {
"type": "string",
"format": "date",
"description": "Data de término do período fiscal ao qual a DFC se refere (YYYY-MM-DD)."
},
"operatingCashFlow": {
"type": "number",
"format": "int64",
"description": "Fluxo de Caixa das Atividades Operacionais (FCO).",
"nullable": true
},
"incomeFromOperations": {
"type": "number",
"format": "int64",
"description": "Caixa Gerado nas Operações (antes das variações de ativos/passivos).",
"nullable": true
},
"netIncomeBeforeTaxes": {
"type": "number",
"format": "int64",
"description": "Lucro líquido antes dos impostos (base para reconciliação pelo método indireto).",
"nullable": true
},
"adjustmentsToProfitOrLoss": {
"type": "number",
"format": "int64",
"description": "Ajustes ao lucro/prejuízo (depreciação, amortização, equivalência patrimonial, variações não caixa).",
"nullable": true
},
"changesInAssetsAndLiabilities": {
"type": "number",
"format": "int64",
"description": "Variações em Ativos e Passivos Operacionais (Clientes, Estoques, Fornecedores, etc.).",
"nullable": true
},
"otherOperatingActivities": {
"type": "number",
"format": "int64",
"description": "Outras Atividades Operacionais (Juros pagos/recebidos, Impostos pagos, etc.).",
"nullable": true
},
"investmentCashFlow": {
"type": "number",
"format": "int64",
"description": "Fluxo de Caixa das Atividades de Investimento (FCI) (Compra/Venda de Imobilizado, Investimentos).",
"nullable": true
},
"financingCashFlow": {
"type": "number",
"format": "int64",
"description": "Fluxo de Caixa das Atividades de Financiamento (FCF) (Captação/Pagamento de Empréstimos, Emissão/Recompra de Ações, Dividendos pagos).",
"nullable": true
},
"exchangeVariationWithoutCash": {
"type": "number",
"format": "int64",
"description": "Variação cambial sem efeito caixa (ajuste de conversão).",
"nullable": true
},
"foreignExchangeRateWithoutCash": {
"type": "number",
"format": "int64",
"description": "Efeito da Variação Cambial sobre o Caixa e Equivalentes.",
"nullable": true
},
"increaseOrDecreaseInCash": {
"type": "number",
"format": "int64",
"description": "Aumento ou Redução Líquida de Caixa e Equivalentes (FCO + FCI + FCF + Variação Cambial).",
"nullable": true
},
"initialCashBalance": {
"type": "number",
"format": "int64",
"description": "Saldo Inicial de Caixa e Equivalentes no início do período.",
"nullable": true
},
"finalCashBalance": {
"type": "number",
"format": "int64",
"description": "Saldo Final de Caixa e Equivalentes no final do período.",
"nullable": true
},
"cashGeneratedInOperations": {
"type": "number",
"format": "int64",
"description": "Caixa gerado nas operações (após variações no capital de giro).",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date",
"description": "Data da última atualização deste registro específico na fonte de dados (YYYY-MM-DD)."
}
}
},
"CashflowHistory": {
"type": "object",
"description": "Contém o histórico **anual** da Demonstração do Fluxo de Caixa (DFC). Retornado via `modules=cashflowHistory`.",
"properties": {
"cashflowHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CashflowEntry"
},
"description": "Lista de DFCs anuais, ordenadas geralmente do mais recente para o mais antigo."
}
}
},
"CashflowHistoryQuarterly": {
"type": "object",
"description": "Contém o histórico **trimestral** da Demonstração do Fluxo de Caixa (DFC). Retornado via `modules=cashflowHistoryQuarterly`.",
"properties": {
"cashflowHistoryQuarterly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CashflowEntry"
},
"description": "Lista de DFCs trimestrais, ordenadas geralmente do mais recente para o mais antigo."
}
}
},
"QuoteResult": {
"type": "object",
"description": "Contém os dados detalhados de um ativo específico retornado pelo endpoint `/api/quote/{tickers}`.",
"properties": {
"symbol": {
"type": "string",
"description": "Ticker (símbolo) do ativo (ex: `PETR4`, `^BVSP`)."
},
"currency": {
"type": "string",
"description": "Moeda na qual os valores monetários são expressos (geralmente `BRL`)."
},
"twoHundredDayAverage": {
"type": "number",
"format": "float",
"description": "Média móvel simples dos preços de fechamento dos últimos 200 dias.",
"nullable": true
},
"twoHundredDayAverageChange": {
"type": "number",
"format": "float",
"description": "Variação absoluta entre o preço atual e a média de 200 dias.",
"nullable": true
},
"twoHundredDayAverageChangePercent": {
"type": "number",
"format": "float",
"description": "Variação percentual entre o preço atual e a média de 200 dias.",
"nullable": true
},
"marketCap": {
"type": "number",
"format": "int64",
"description": "Capitalização de mercado total do ativo (Preço Atual x Ações em Circulação).",
"nullable": true
},
"shortName": {
"type": "string",
"description": "Nome curto ou abreviado da empresa ou ativo.",
"nullable": true
},
"longName": {
"type": "string",
"description": "Nome longo ou completo da empresa ou ativo.",
"nullable": true
},
"regularMarketChange": {
"type": "number",
"format": "float",
"description": "Variação absoluta do preço no dia atual em relação ao fechamento anterior.",
"nullable": true
},
"regularMarketChangePercent": {
"type": "number",
"format": "float",
"description": "Variação percentual do preço no dia atual em relação ao fechamento anterior.",
"nullable": true
},
"regularMarketTime": {
"type": "string",
"format": "date-time",
"description": "Data e hora da última atualização da cotação (último negócio registrado). Formato ISO 8601.",
"nullable": true
},
"regularMarketPrice": {
"type": "number",
"format": "float",
"description": "Preço atual ou do último negócio registrado.",
"nullable": true
},
"regularMarketDayHigh": {
"type": "number",
"format": "float",
"description": "Preço máximo atingido no dia de negociação atual.",
"nullable": true
},
"regularMarketDayRange": {
"type": "string",
"description": "String formatada mostrando o intervalo de preço do dia (Mínimo - Máximo).",
"nullable": true
},
"regularMarketDayLow": {
"type": "number",
"format": "float",
"description": "Preço mínimo atingido no dia de negociação atual.",
"nullable": true
},
"regularMarketVolume": {
"type": "number",
"format": "int64",
"description": "Volume financeiro negociado no dia atual.",
"nullable": true
},
"regularMarketPreviousClose": {
"type": "number",
"format": "float",
"description": "Preço de fechamento do pregão anterior.",
"nullable": true
},
"regularMarketOpen": {
"type": "number",
"format": "float",
"description": "Preço de abertura no dia de negociação atual.",
"nullable": true
},
"averageDailyVolume3Month": {
"type": "number",
"format": "int64",
"description": "Média do volume financeiro diário negociado nos últimos 3 meses.",
"nullable": true
},
"averageDailyVolume10Day": {
"type": "number",
"format": "int64",
"description": "Média do volume financeiro diário negociado nos últimos 10 dias.",
"nullable": true
},
"fiftyTwoWeekLowChange": {
"type": "number",
"format": "float",
"description": "Variação absoluta entre o preço atual e o preço mínimo das últimas 52 semanas.",
"nullable": true
},
"fiftyTwoWeekRange": {
"type": "string",
"description": "String formatada mostrando o intervalo de preço das últimas 52 semanas (Mínimo - Máximo).",
"nullable": true
},
"fiftyTwoWeekHighChange": {
"type": "number",
"format": "float",
"description": "Variação absoluta entre o preço atual e o preço máximo das últimas 52 semanas.",
"nullable": true
},
"fiftyTwoWeekHighChangePercent": {
"type": "number",
"format": "float",
"description": "Variação percentual entre o preço atual e o preço máximo das últimas 52 semanas.",
"nullable": true
},
"fiftyTwoWeekLow": {
"type": "number",
"format": "float",
"description": "Preço mínimo atingido nas últimas 52 semanas.",
"nullable": true
},
"fiftyTwoWeekHigh": {
"type": "number",
"format": "float",
"description": "Preço máximo atingido nas últimas 52 semanas.",
"nullable": true
},
"priceEarnings": {
"type": "number",
"format": "float",
"description": "Indicador Preço/Lucro (P/L): Preço Atual / Lucro Por Ação (LPA) TTM. Retornado se `fundamental=true`.",
"nullable": true
},
"earningsPerShare": {
"type": "number",
"format": "float",
"description": "Lucro Por Ação (LPA) dos últimos 12 meses (TTM). Retornado se `fundamental=true`.",
"nullable": true
},
"logourl": {
"type": "string",
"format": "url",
"description": "URL da imagem do logo do ativo/empresa."
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp da última atualização dos dados do índice na fonte (aplicável principalmente a índices, como `^BVSP`). Formato ISO 8601.",
"nullable": true
},
"usedInterval": {
"type": "string",
"description": "O intervalo (`interval`) efetivamente utilizado pela API para retornar os dados históricos, caso solicitado.",
"nullable": true
},
"usedRange": {
"type": "string",
"description": "O período (`range`) efetivamente utilizado pela API para retornar os dados históricos, caso solicitado.",
"nullable": true
},
"historicalDataPrice": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoricalDataPrice"
},
"description": "Array contendo a série histórica de preços, retornado apenas se os parâmetros `range` e/ou `interval` forem especificados na requisição.",
"nullable": true
},
"validRanges": {
"type": "array",
"items": {
"type": "string"
},
"description": "Lista dos valores válidos que podem ser utilizados no parâmetro `range` para este ativo específico."
},
"validIntervals": {
"type": "array",
"items": {
"type": "string"
},
"description": "Lista dos valores válidos que podem ser utilizados no parâmetro `interval` para este ativo específico."
},
"dividendsData": {
"$ref": "#/components/schemas/DividendsData",
"description": "Objeto contendo informações sobre dividendos, JCP e outros eventos corporativos. Retornado apenas se `dividends=true` for especificado na requisição.",
"nullable": true
},
"summaryProfile": {
"$ref": "#/components/schemas/SummaryProfile",
"description": "Resumo do perfil da empresa. Retornado apenas se `modules` incluir `summaryProfile`.",
"nullable": true
},
"balanceSheetHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BalanceSheetEntry"
},
"description": "Histórico **anual** do Balanço Patrimonial. Retornado apenas se `modules` incluir `balanceSheetHistory`.",
"nullable": true
},
"balanceSheetHistoryQuarterly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BalanceSheetEntry"
},
"description": "Histórico **trimestral** do Balanço Patrimonial. Retornado apenas se `modules` incluir `balanceSheetHistoryQuarterly`.",
"nullable": true
},
"defaultKeyStatistics": {
"$ref": "#/components/schemas/DefaultKeyStatisticsEntry",
"description": "Principais estatísticas financeiras atuais/TTM. Retornado apenas se `modules` incluir `defaultKeyStatistics`.",
"nullable": true
},
"defaultKeyStatisticsHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DefaultKeyStatisticsEntry"
},
"description": "Histórico **anual** das principais estatísticas. Retornado apenas se `modules` incluir `defaultKeyStatisticsHistory`.",
"nullable": true
},
"defaultKeyStatisticsHistoryQuarterly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DefaultKeyStatisticsEntry"
},
"description": "Histórico **trimestral** das principais estatísticas. Retornado apenas se `modules` incluir `defaultKeyStatisticsHistoryQuarterly`.",
"nullable": true
},
"incomeStatementHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IncomeStatementEntry"
},
"description": "Histórico **anual** da Demonstração do Resultado (DRE). Retornado apenas se `modules` incluir `incomeStatementHistory`.",
"nullable": true
},
"incomeStatementHistoryQuarterly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IncomeStatementEntry"
},
"description": "Histórico **trimestral** da Demonstração do Resultado (DRE). Retornado apenas se `modules` incluir `incomeStatementHistoryQuarterly`.",
"nullable": true
},
"financialData": {
"$ref": "#/components/schemas/FinancialDataEntry",
"description": "Dados financeiros e indicadores TTM. Retornado apenas se `modules` incluir `financialData`.",
"nullable": true
},
"financialDataHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialDataEntry"
},
"description": "Histórico **anual** de dados financeiros e indicadores. Retornado apenas se `modules` incluir `financialDataHistory`.",
"nullable": true
},
"financialDataHistoryQuarterly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialDataEntry"
},
"description": "Histórico **trimestral** de dados financeiros e indicadores. Retornado apenas se `modules` incluir `financialDataHistoryQuarterly`.",
"nullable": true
},
"valueAddedHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueAddedEntry"
},
"description": "Histórico **anual** da Demonstração do Valor Adicionado (DVA). Retornado apenas se `modules` incluir `valueAddedHistory`.",
"nullable": true
},
"valueAddedHistoryQuarterly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueAddedEntry"
},
"description": "Histórico **trimestral** da Demonstração do Valor Adicionado (DVA). Retornado apenas se `modules` incluir `valueAddedHistoryQuarterly`.",
"nullable": true
},
"cashflowHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CashflowEntry"
},
"description": "Histórico **anual** da Demonstração do Fluxo de Caixa (DFC). Retornado apenas se `modules` incluir `cashflowHistory`.",
"nullable": true
},
"cashflowHistoryQuarterly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CashflowEntry"
},
"description": "Histórico **trimestral** da Demonstração do Fluxo de Caixa (DFC). Retornado apenas se `modules` incluir `cashflowHistoryQuarterly`.",
"nullable": true
}
}
},
"QuoteResponse": {
"type": "object",
"description": "Resposta principal do endpoint `/api/quote/{tickers}`.",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuoteResult"
},
"description": "Array contendo os resultados detalhados para cada ticker solicitado."
},
"requestedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp indicando quando a requisição foi recebida pelo servidor. Formato ISO 8601."
},
"took": {
"type": "string",
"description": "Tempo aproximado que o servidor levou para processar a requisição, em formato de string (ex: `746ms`).",
"example": "746ms"
}
}
},
"CryptoHistoricalData": {
"type": "object",
"description": "Representa um ponto na série histórica de preços de uma criptomoeda.",
"properties": {
"date": {
"type": "integer",
"format": "int64",
"description": "Data do ponto de dados, representada como um timestamp UNIX."
},
"open": {
"type": "number",
"format": "float",
"description": "Preço de abertura da criptomoeda no intervalo."
},
"high": {
"type": "number",
"format": "float",
"description": "Preço máximo atingido no intervalo."
},
"low": {
"type": "number",
"format": "float",
"description": "Preço mínimo atingido no intervalo."
},
"close": {
"type": "number",
"format": "float",
"description": "Preço de fechamento da criptomoeda no intervalo."
},
"volume": {
"type": "integer",
"format": "int64",
"description": "Volume negociado no intervalo (na criptomoeda ou na moeda de referência, verificar contexto)."
},
"adjustedClose": {
"type": "number",
"format": "float",
"description": "Preço de fechamento ajustado (geralmente igual ao `close` para cripto)."
}
}
},
"CryptoCoin": {
"type": "object",
"description": "Contém os dados detalhados de uma criptomoeda específica retornada pelo endpoint `/api/v2/crypto`.",
"properties": {
"currency": {
"type": "string",
"description": "Sigla da moeda fiduciária na qual os preços estão cotados (ex: `BRL`, `USD`)."
},
"currencyRateFromUSD": {
"type": "number",
"format": "float",
"description": "Taxa de câmbio da `currency` em relação ao USD (Dólar Americano). `1 USD = X currency`."
},
"coinName": {
"type": "string",
"description": "Nome completo da criptomoeda (ex: `Bitcoin`, `Ethereum`)."
},
"coin": {
"type": "string",
"description": "Sigla (ticker) da criptomoeda (ex: `BTC`, `ETH`)."
},
"regularMarketChange": {
"type": "number",
"format": "float",
"description": "Variação absoluta do preço nas últimas 24 horas (ou período relevante)."
},
"regularMarketPrice": {
"type": "number",
"format": "float",
"description": "Preço atual da criptomoeda na `currency` especificada."
},
"regularMarketChangePercent": {
"type": "number",
"format": "float",
"description": "Variação percentual do preço nas últimas 24 horas (ou período relevante)."
},
"regularMarketDayLow": {
"type": "number",
"format": "float",
"description": "Preço mínimo nas últimas 24 horas (ou período relevante)."
},
"regularMarketDayHigh": {
"type": "number",
"format": "float",
"description": "Preço máximo nas últimas 24 horas (ou período relevante)."
},
"regularMarketDayRange": {
"type": "string",
"description": "String formatada mostrando o intervalo de preço das últimas 24h (Mínimo - Máximo)."
},
"regularMarketVolume": {
"type": "integer",
"format": "int64",
"description": "Volume negociado nas últimas 24 horas (na `currency` especificada)."
},
"marketCap": {
"type": "integer",
"format": "int64",
"description": "Capitalização de mercado da criptomoeda na `currency` especificada."
},
"regularMarketTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp da última atualização da cotação. Formato ISO 8601."
},
"coinImageUrl": {
"type": "string",
"format": "url",
"description": "URL da imagem do logo da criptomoeda."
},
"usedInterval": {
"type": "string",
"description": "O intervalo (`interval`) efetivamente utilizado para os dados históricos, se solicitado.",
"nullable": true
},
"usedRange": {
"type": "string",
"description": "O período (`range`) efetivamente utilizado para os dados históricos, se solicitado.",
"nullable": true
},
"historicalDataPrice": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CryptoHistoricalData"
},
"description": "Array contendo a série histórica de preços, retornado se `range` ou `interval` forem especificados.",
"nullable": true
},
"validRanges": {
"type": "array",
"items": {
"type": "string"
},
"description": "Lista dos valores válidos para o parâmetro `range` nesta criptomoeda."
},
"validIntervals": {
"type": "array",
"items": {
"type": "string"
},
"description": "Lista dos valores válidos para o parâmetro `interval` nesta criptomoeda."
}
}
},
"CryptoResponse": {
"type": "object",
"description": "Resposta principal do endpoint `/api/v2/crypto`.",
"properties": {
"coins": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CryptoCoin"
},
"description": "Array contendo os resultados detalhados para cada criptomoeda solicitada."
}
}
},
"CryptoAvailableResponse": {
"type": "object",
"description": "Resposta do endpoint que lista todas as criptomoedas disponíveis.",
"properties": {
"coins": {
"type": "array",
"items": {
"type": "string"
},
"description": "Lista de siglas (tickers) das criptomoedas disponíveis (ex: `BTC`, `ETH`, `LTC`)."
}
}
},
"CurrencyAvailableResponse": {
"type": "object",
"description": "Resposta do endpoint que lista todas as moedas fiduciárias disponíveis.",
"properties": {
"currencies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Nome da moeda ou par de moedas suportado (ex: `Dólar Americano/Real Brasileiro`, `Euro/Real Brasileiro`). A sigla pode ser extraída deste nome ou consultada em documentação adicional."
}
}
},
"description": "Lista de objetos, cada um contendo o nome de uma moeda fiduciária ou par suportado pela API."
}
}
},
"CurrencyQuote": {
"type": "object",
"description": "Contém os dados detalhados da cotação de um **par de moedas fiduciárias específico**, retornado como um elemento do array `currency` no endpoint `/api/v2/currency`.",
"properties": {
"fromCurrency": {
"type": "string",
"description": "**Moeda de Origem:** Sigla da moeda base do par (ex: `USD` em `USD-BRL`).",
"example": "USD"
},
"toCurrency": {
"type": "string",
"description": "**Moeda de Destino:** Sigla da moeda de cotação do par (ex: `BRL` em `USD-BRL`).",
"example": "BRL"
},
"name": {
"type": "string",
"description": "**Nome do Par:** Nome descritivo do par de moedas (ex: `Dólar Americano/Real Brasileiro`).",
"example": "Dólar Americano/Real Brasileiro"
},
"high": {
"type": "string",
"description": "**Máxima:** Preço mais alto atingido pelo par no período recente (geralmente diário). Formato String.",
"example": "5.22"
},
"low": {
"type": "string",
"description": "**Mínima:** Preço mais baixo atingido pelo par no período recente (geralmente diário). Formato String.",
"example": "5.162"
},
"bidVariation": {
"type": "string",
"description": "**Variação Absoluta (Bid):** Mudança absoluta no preço de compra (bid) desde o último fechamento ou período de referência. Formato String.",
"example": "0.0454"
},
"percentageChange": {
"type": "string",
"description": "**Variação Percentual:** Mudança percentual no preço do par desde o último fechamento ou período de referência. Formato String.",
"example": "0.88"
},
"bidPrice": {
"type": "string",
"description": "**Preço de Compra (Bid):** Preço atual pelo qual o mercado está disposto a comprar a moeda de origem (`fromCurrency`) pagando com a moeda de destino (`toCurrency`). Formato String.",
"example": "5.2097"
},
"askPrice": {
"type": "string",
"description": "**Preço de Venda (Ask):** Preço atual pelo qual o mercado está disposto a vender a moeda de origem (`fromCurrency`) recebendo a moeda de destino (`toCurrency`). Formato String.",
"example": "5.2127"
},
"updatedAtTimestamp": {
"type": "string",
"description": "**Timestamp da Atualização:** Data e hora da última atualização da cotação, representada como um **timestamp UNIX** (string contendo o número de segundos desde 1970-01-01 UTC).",
"example": "1696601423"
},
"updatedAtDate": {
"type": "string",
"description": "**Data da Atualização:** Data e hora da última atualização da cotação, formatada de forma legível (`YYYY-MM-DD HH:MM:SS`).",
"example": "2023-10-06 11:10:23"
}
},
"required": [
"fromCurrency",
"toCurrency",
"name",
"high",
"low",
"bidVariation",
"percentageChange",
"bidPrice",
"askPrice",
"updatedAtTimestamp",
"updatedAtDate"
]
},
"CurrencyResponse": {
"type": "object",
"description": "Estrutura da **resposta principal** do endpoint `GET /api/v2/currency`.",
"properties": {
"currency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CurrencyQuote"
},
"description": "Array contendo os objetos `CurrencyQuote`, um para cada par de moeda válido solicitado no parâmetro `currency`."
}
},
"required": [
"currency"
]
},
"InflationEntry": {
"type": "object",
"description": "Representa um ponto de dado histórico de inflação para um país.",
"properties": {
"date": {
"type": "string",
"description": "Data da medição da inflação, no formato `DD/MM/YYYY`.",
"example": "01/01/2023"
},
"value": {
"type": "string",
"description": "Valor do índice de inflação para a data especificada (formato string, pode conter `%` ou ser apenas numérico).",
"example": "4.56"
},
"epochDate": {
"type": "integer",
"format": "int64",
"description": "Timestamp UNIX (número de segundos desde 1970-01-01 UTC) correspondente à `date`.",
"example": 1672531199
}
}
},
"InflationResponse": {
"type": "object",
"description": "Resposta principal do endpoint `/api/v2/inflation`.",
"properties": {
"inflation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InflationEntry"
},
"description": "Array contendo os registros históricos de inflação para o país e período solicitados."
}
}
},
"InflationAvailableResponse": {
"type": "object",
"description": "Resposta do endpoint que lista os países com dados de inflação disponíveis.",
"properties": {
"countries": {
"type": "array",
"items": {
"type": "string"
},
"description": "Lista de nomes de países (em minúsculas) para os quais há dados de inflação disponíveis (ex: `brazil`, `usa`, `argentina`)."
}
}
},
"PrimeRateEntry": {
"type": "object",
"description": "Representa um registro individual de taxa básica de juros (SELIC) para uma data específica.",
"properties": {
"date": {
"type": "string",
"description": "Data do registro no formato DD/MM/YYYY.",
"example": "01/01/2022"
},
"value": {
"type": "string",
"description": "Valor da taxa básica de juros (SELIC) para a data correspondente.",
"example": "9.25"
},
"epochDate": {
"type": "integer",
"format": "int64",
"description": "Timestamp em milissegundos (formato epoch) correspondente à data do registro.",
"example": 1640995200000
}
}
},
"PrimeRateResponse": {
"type": "object",
"description": "Resposta principal do endpoint `/api/v2/prime-rate`.",
"properties": {
"prime-rate": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrimeRateEntry"
},
"description": "Array contendo os registros históricos de taxa básica de juros (SELIC) para o país e período solicitados."
}
}
},
"PrimeRateAvailableResponse": {
"type": "object",
"description": "Resposta do endpoint `/api/v2/prime-rate/available` que lista os países disponíveis para consulta de taxa básica de juros (SELIC).",
"properties": {
"countries": {
"type": "array",
"items": {
"type": "string"
},
"description": "Lista de países com dados de taxa básica de juros (SELIC) disponíveis para consulta.",
"example": [
"brazil",
"united states",
"european union"
]
}
}
}
},
"parameters": {
"Token": {
"name": "token",
"in": "query",
"description": "**Obrigatório caso não esteja adicionado como header \"Authorization\".** Seu token de autenticação pessoal da API Brapi.\n\n**Formas de Envio:**\n\n1. **Query Parameter:** Adicione `?token=SEU_TOKEN` ao final da URL.\n2. **HTTP Header:** Inclua o header `Authorization: Bearer SEU_TOKEN` na sua requisição.\n\nAmbos os métodos são aceitos, mas pelo menos um deles deve ser utilizado. Obtenha seu token em [brapi.dev/dashboard](https://brapi.dev/dashboard).",
"required": false,
"schema": {
"type": "string"
},
"example": ""
}
},
"responses": {
"UnauthorizedError": {
"description": "**Unauthorized (Não Autorizado).** O token de autenticação fornecido é inválido, expirou, está ausente ou não possui permissão para acessar o recurso solicitado.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": true,
"message": "O seu token é inválido, por favor, verifique o seu token em brapi.dev/dashboard"
}
}
}
}
},
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Autenticação via header HTTP `Authorization`. Use o formato `Authorization: Bearer SEU_TOKEN`. [Obtenha seu token](https://brapi.dev/dashboard)."
}
}
},
"tags": {
"A__es": {
"name": "Ações",
"description": "Endpoints para consulta de dados relacionados a ativos negociados na B3, como **Ações**, **Fundos Imobiliários (FIIs)**, **BDRs**, **ETFs** e **Índices** (ex: IBOVESPA).\n\nPermite buscar cotações atuais, dados históricos, informações fundamentalistas (via módulos) e listagens de ativos disponíveis."
},
"Criptomoedas": {
"name": "Criptomoedas",
"description": "Endpoints focados na obtenção de dados sobre **Criptomoedas**.\n\nInclui consulta de cotações atuais em diversas moedas fiduciárias, dados históricos e listagem de criptomoedas suportadas pela API."
},
"Moedas": {
"name": "Moedas",
"description": "Endpoints para consulta de **Moedas Fiduciárias**.\n\nAtualmente, focado na listagem das moedas disponíveis para conversão ou consulta de taxas de câmbio (embora o endpoint de cotação de moedas não esteja detalhado aqui, a listagem está disponível)."
},
"Infla__o": {
"name": "Inflação",
"description": "Endpoints para acessar dados históricos de **Índices de Inflação**.\n\nPermite consultar a inflação de diferentes países ao longo do tempo e listar os países com dados disponíveis."
},
"Taxa_de_Juros": {
"name": "Taxa de Juros",
"description": "Endpoints para consulta de **Taxas Básicas de Juros (SELIC)** de diferentes países.\n\nPermite a obtenção de taxas atuais e séries históricas das taxas básicas de juros, com personalização por país, período e opções de ordenação."
}
}
}Como usar esta especificação
1. Ferramentas de Desenvolvimento
- Swagger UI: Visualize e teste a API interativamente
- Postman: Importe a especificação para criar coleções automaticamente
- Insomnia: Gere requisições baseadas na especificação
- OpenAPI Generator: Gere SDKs em diversas linguagens
2. Integração em Projetos
- Frontend: Use para gerar tipos TypeScript automaticamente
- Backend: Valide requisições e respostas contra o schema
- Documentação: Gere documentação automática para sua aplicação
3. Validação e Testes
- Valide suas requisições contra o schema oficial
- Use para testes automatizados de integração
- Garanta compatibilidade com futuras versões da API
Informações Técnicas
- Versão OpenAPI: 3.0.0
- Versão da API: 3.0.0
- Formato: JSON
- Atualização: Automática a cada deploy
- Compatibilidade: Todas as ferramentas que suportam OpenAPI 3.0+
Próximos Passos
- Comece com a documentação geral para entender os conceitos básicos
- Explore os endpoints de ações para ver exemplos práticos
- Veja exemplos de código em diferentes linguagens
- Configure sua conta para obter seu token de API
Esta especificação é gerada automaticamente e sempre reflete o estado atual da API brapi.