# Exemplos de Integração URL: /docs/examples.mdx Exemplos práticos de integração com a API brapi.dev em diversas linguagens de programação, plataformas e ferramentas. Inclui código de exemplo para TypeScript, Python, PHP, Java, C#, Google Sheets, Excel, WordPress e aplicações mobile. *** title: 'Exemplos de Integração' description: >- Exemplos práticos de integração com a API brapi.dev em diversas linguagens de programação, plataformas e ferramentas. Inclui código de exemplo para TypeScript, Python, PHP, Java, C#, Google Sheets, Excel, WordPress e aplicações mobile. full: false keywords: brapi, api, documentação, integração, exemplos, código, typescript, python, php, java openGraph: title: Exemplos de Integração com brapi.dev description: >- Exemplos práticos de integração com a API brapi.dev em diversas linguagens de programação, plataformas e ferramentas. Inclui código de exemplo para TypeScript, Python, PHP, Java, C#, Google Sheets, Excel, WordPress e aplicações mobile. type: website locale: pt\_BR lastUpdated: '2025-05-17T08:15:30.000Z' lang: pt-BR ----------- A API da brapi.dev é uma API REST, o que significa que ela pode ser integrada com praticamente qualquer plataforma ou linguagem de programação. Esta página apresenta exemplos concretos de como integrar nossa API em diferentes ambientes. ## Linguagens de Programação ### TypeScript / JavaScript ```typescript // Usando fetch nativo const fetchData = async () => { const token = 'SEU_TOKEN'; const ticker = 'PETR4'; const response = await fetch( `https://brapi.dev/api/quote/${ticker}?token=${token}`, ); const data = await response.json(); console.log(data); }; // Usando Axios import axios from 'axios'; const token = 'SEU_TOKEN'; const ticker = 'PETR4'; const url = `https://brapi.dev/api/quote/${ticker}?token=${token}`; async function fetchQuote() { try { const response = await axios.get(url); console.log(response.data); } catch (error) { console.error('Erro ao buscar cotação', error); } } ``` ### Python ```python # Usando requests import requests token = 'SEU_TOKEN' ticker = 'PETR4' url = f'https://brapi.dev/api/quote/{ticker}?token={token}' response = requests.get(url) data = response.json() print(data) ``` ### PHP ```php ``` ### Java ```java // Usando HttpClient (Java 11+) import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class BrapiExample { public static void main(String[] args) throws Exception { String token = "SEU_TOKEN"; String ticker = "PETR4"; String url = "https://brapi.dev/api/quote/" + ticker + "?token=" + token; HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create(url)) .build(); HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); } } ``` ### C\# ```csharp // Usando HttpClient using System; using System.Net.Http; using System.Threading.Tasks; class Program { static async Task Main() { string token = "SEU_TOKEN"; string ticker = "PETR4"; string url = $"https://brapi.dev/api/quote/{ticker}?token={token}"; using HttpClient client = new HttpClient(); string response = await client.GetStringAsync(url); Console.WriteLine(response); } } ``` ## Planilhas e Ferramentas Sem Código ### Google Sheets ``` =IMPORTJSON("https://brapi.dev/api/quote/PETR4?token=SEU_TOKEN") ``` Observação: O Google Sheets não possui uma função IMPORTJSON nativa. Você precisará instalar uma extensão ou usar Apps Script para adicionar esta funcionalidade. ### Microsoft Excel No Excel, você pode usar o Power Query para importar dados JSON: 1. Vá para a guia "Dados" e selecione "Obter Dados" > "De Outras Fontes" > "Da Web" 2. Insira a URL `https://brapi.dev/api/quote/PETR4?token=SEU_TOKEN` 3. Siga o assistente para transformar os dados JSON ### WordPress Usando um snippet de código PHP no arquivo `functions.php` do seu tema ou em um plugin personalizado: ```php function brapi_stock_price_shortcode($atts) { $atts = shortcode_atts(array( 'ticker' => 'PETR4', ), $atts); $token = 'SEU_TOKEN'; $ticker = $atts['ticker']; $url = "https://brapi.dev/api/quote/{$ticker}?token={$token}"; $response = wp_remote_get($url); if (is_wp_error($response)) { return "Erro ao buscar dados"; } $body = wp_remote_retrieve_body($response); $data = json_decode($body, true); if (isset($data['results'][0]['regularMarketPrice'])) { return "R$ " . number_format($data['results'][0]['regularMarketPrice'], 2, ',', '.'); } else { return "Cotação indisponível"; } } add_shortcode('brapi_cotacao', 'brapi_stock_price_shortcode'); ``` Uso no WordPress: `[brapi_cotacao ticker="PETR4"]` ## Aplicações Mobile ### React Native ```javascript import React, { useState, useEffect } from 'react'; import { View, Text, StyleSheet } from 'react-native'; const StockPrice = ({ ticker }) => { const [price, setPrice] = useState(null); const [loading, setLoading] = useState(true); useEffect(() => { const token = 'SEU_TOKEN'; const fetchPrice = async () => { try { const response = await fetch( `https://brapi.dev/api/quote/${ticker}?token=${token}`, ); const data = await response.json(); setPrice(data.results[0].regularMarketPrice); } catch (error) { console.error(error); } finally { setLoading(false); } }; fetchPrice(); }, [ticker]); if (loading) return Carregando...; return ( {ticker} R$ {price.toFixed(2)} ); }; const styles = StyleSheet.create({ container: { padding: 16, backgroundColor: '#f5f5f5', borderRadius: 8, }, ticker: { fontSize: 16, fontWeight: 'bold', }, price: { fontSize: 20, marginTop: 8, }, }); export default StockPrice; ``` ## Conclusão Como uma API REST, a brapi.dev pode ser integrada em praticamente qualquer ambiente de desenvolvimento, desde aplicações web e mobile tradicionais até planilhas e sistemas de gerenciamento de conteúdo. A flexibilidade do formato JSON e o uso do protocolo HTTP padrão garantem compatibilidade universal. Para sugestões de integração com outras plataformas ou linguagens, entre em contato com nossa equipe de suporte. # Comece a Usar a API da brapi.dev URL: /docs.mdx Guia completo para começar a usar a API da brapi.dev. Aprenda sobre autenticação, endpoints principais e veja exemplos práticos para integrar dados financeiros do Brasil em suas aplicações. *** title: 'Comece a Usar a API da brapi.dev' description: 'Guia completo para começar a usar a API da brapi.dev. Aprenda sobre autenticação, endpoints principais e veja exemplos práticos para integrar dados financeiros do Brasil em suas aplicações.' ------------------------------------------------ import { Callout } from 'fumadocs-ui/components/callout'; import { Card, Cards } from 'fumadocs-ui/components/card'; import { Step, Steps } from 'fumadocs-ui/components/steps'; import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; Bem-vindo à documentação da **brapi.dev**. Nossa API foi projetada para ser **simples, robusta e confiável**, permitindo que você integre dados financeiros do mercado brasileiro em suas aplicações com o mínimo de esforço. Este guia vai te mostrar como fazer sua primeira requisição em minutos. #### 1. Obtenha sua Chave de API (Token) Primeiro, você precisa de uma chave de API (token). Crie sua conta em nosso dashboard para gerar seu token gratuito. Seu token estará disponível na seção "Chaves de API" do seu **[Dashboard](/dashboard)** após o login. #### 2. Faça sua Primeira Requisição Com o token em mãos, você já pode consultar a API. Vamos pegar a cotação da PETR4 como exemplo. Copie o comando abaixo, substitua `SEU_TOKEN` pelo seu token real e execute no seu terminal. ```bash title="Terminal (cURL)" curl --request GET \ --url 'https://brapi.dev/api/quote/PETR4' \ --header 'Authorization: Bearer SEU_TOKEN' ``` #### 3. Receba os Dados Pronto! Você receberá uma resposta em formato JSON, estruturada e pronta para ser utilizada. ```jsonc title="Resposta da API (JSON)" { "results": [ { "symbol": "PETR4", "shortName": "PETROBRAS PN", "longName": "Petróleo Brasileiro S.A. - Petrobras", "currency": "BRL", "regularMarketPrice": 38.50, "regularMarketDayHigh": 39.00, "regularMarketDayLow": 38.20, "regularMarketChange": 0.30, "regularMarketChangePercent": 0.78, "regularMarketTime": "2024-10-26T17:08:00.000Z", "marketCap": 503100000000, "regularMarketVolume": 45678901, "logourl": "https://icons.brapi.dev/logos/PETR4.png", } ] } ``` ## Autenticação Todas as requisições à API devem ser autenticadas. Recomendamos enviar seu token através do header `Authorization` por ser mais seguro. `Authorization: Bearer SEU_TOKEN ` `?token=SEU_TOKEN` Nunca exponha seu token no código do lado do cliente (frontend). Em aplicações web, faça as chamadas para a API da brapi.dev a partir do seu backend. ## Principais Conceitos * **URL Base:** Todas as requisições usam a URL base `https://brapi.dev/api`. * **Múltiplos Ativos:** A maioria dos endpoints permite a consulta de múltiplos ativos em uma única requisição, separando os tickers por vírgula. Ex: `PETR4,VALE3,MGLU3`. * **Módulos Adicionais:** Use o parâmetro `modules` para enriquecer suas respostas com dados fundamentalistas e mais (disponível conforme seu plano). ## Explore Nossos Endpoints Navegue pelas seções para descobrir todos os dados que você pode acessar. ## Exemplos Práticos Veja como é fácil buscar dados em diferentes linguagens. ```bash curl -H "Authorization: Bearer SEU_TOKEN" \ "https://brapi.dev/api/quote/ITUB4,BBDC4?range=1mo&interval=1d" ``` ```python import requests token = "SEU_TOKEN" tickers = "ITUB4,BBDC4" url = f"https://brapi.dev/api/quote/{tickers}" response = requests.get( url, headers={"Authorization": f"Bearer {token}"}, params={"range": "1mo", "interval": "1d"} ) if response.status_code == 200: data = response.json() print(data['results']) else: print(f"Erro: {response.status_code}") ``` ```javascript const token = 'SEU_TOKEN'; const tickers = 'ITUB4,BBDC4'; const url = `https://brapi.dev/api/quote/${tickers}?range=1mo&interval=1d`; async function fetchQuotes() { try { const response = await fetch(url, { headers: { 'Authorization': `Bearer ${token}` } }); if (!response.ok) { throw new Error(`HTTP error! status: ${response.status}`); } const data = await response.json(); console.log(data.results); } catch (error) { console.error('Falha ao buscar cotações:', error); } } fetchQuotes(); ``` ## Próximos Passos Agora que você já entendeu o básico, o que acha de explorar mais a fundo? * **[Explore os endpoints de Ações](/docs/acoes):** A seção mais completa, com dados fundamentalistas e dividendos. * **[Veja todos os exemplos](/docs/examples):** Descubra como aplicar a API em casos de uso mais complexos. # Cotação, Dividendos e Dados Financeiros URL: /docs/acoes.mdx Endpoints para consulta de dados relacionados a ativos negociados na B3, como Ações, Fundos Imobiliários (FIIs), BDRs, ETFs e Índices (ex: IBOVESPA). Permite buscar cotações atuais, dados históricos, informações fundamentalistas (via módulos) e listagens de ativos disponíveis. *** title: Cotação, Dividendos e Dados Financeiros 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). Permite buscar cotações atuais, dados históricos, informações fundamentalistas (via módulos) e listagens de ativos disponíveis. full: true keywords: brapi, api, documentação, ações openGraph: title: Cotação, Dividendos e Dados Financeiros 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). Permite buscar cotações atuais, dados históricos, informações fundamentalistas (via módulos) e listagens de ativos disponíveis. type: website locale: pt\_BR lastUpdated: '2025-04-28T01:22:35.251Z' lang: pt-BR \_openapi: method: GET route: /api/quote/{tickers} toc: * depth: 2 title: Dados de Ações e Ativos Financeiros url: '#buscar-cotação-detalhada-de-ativos-financeiros' structuredData: headings: * content: Dados de Ações e Ativos Financeiros id: buscar-cotação-detalhada-de-ativos-financeiros contents: * content: > 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**. ### Funcionalidades Principais: * **Cotação Atual:** Retorna o preço mais recente, variação diária, máximas, mínimas, volume, etc. * **Dados Históricos:** Permite solicitar séries históricas de preços usando os parâmetros `range` e `interval`. * **Dados Fundamentalistas:** Opcionalmente, inclui dados fundamentalistas básicos (P/L, LPA) com o parâmetro `fundamental=true`. * **Dividendos:** Opcionalmente, inclui histórico de dividendos e JCP com `dividends=true`. * **Módulos Adicionais:** Permite requisitar conjuntos de dados financeiros mais aprofundados através do parâmetro `modules` (veja detalhes abaixo). ### Autenticação: É **obrigatório** fornecer um token de autenticação válido, seja via query parameter `token` ou via header `Authorization: Bearer seu_token`. ### Exemplos de Requisição: **1. Cotação simples de PETR4 e VALE3:** ```bash curl -X GET "https://brapi.dev/api/quote/PETR4,VALE3?token=SEU_TOKEN" ``` **2. Cotação de MGLU3 com dados históricos do último mês (intervalo diário):** ```bash curl -X GET "https://brapi.dev/api/quote/MGLU3?range=1mo&interval=1d&token=SEU_TOKEN" ``` **3. Cotação de ITSA4 incluindo dividendos e dados fundamentalistas básicos:** ```bash curl -X GET "https://brapi.dev/api/quote/ITSA4?fundamental=true÷nds=true&token=SEU_TOKEN" ``` **4. Cotação de WEGE3 com Resumo da Empresa e Balanço Patrimonial Anual (via módulos):** ```bash curl -X GET "https://brapi.dev/api/quote/WEGE3?modules=summaryProfile,balanceSheetHistory&token=SEU_TOKEN" ``` ### Parâmetro `modules` (Detalhado): O 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. **Módulos Disponíveis:** * `summaryProfile`: Informações cadastrais da empresa (endereço, setor, descrição do negócio, website, número de funcionários). * `balanceSheetHistory`: Histórico **anual** do Balanço Patrimonial. * `balanceSheetHistoryQuarterly`: Histórico **trimestral** do Balanço Patrimonial. * `defaultKeyStatistics`: Principais estatísticas da empresa (Valor de Mercado, P/L, ROE, Dividend Yield, etc.) - **TTM (Trailing Twelve Months)**. * `defaultKeyStatisticsHistory`: Histórico **anual** das Principais Estatísticas. * `defaultKeyStatisticsHistoryQuarterly`: Histórico **trimestral** das Principais Estatísticas. * `incomeStatementHistory`: Histórico **anual** da Demonstração do Resultado do Exercício (DRE). * `incomeStatementHistoryQuarterly`: Histórico **trimestral** da Demonstração do Resultado do Exercício (DRE). * `financialData`: Dados financeiros selecionados (Receita, Lucro Bruto, EBITDA, Dívida Líquida, Fluxo de Caixa Livre, Margens) - **TTM (Trailing Twelve Months)**. * `financialDataHistory`: Histórico **anual** dos Dados Financeiros. * `financialDataHistoryQuarterly`: Histórico **trimestral** dos Dados Financeiros. * `valueAddedHistory`: Histórico **anual** da Demonstração do Valor Adicionado (DVA). * `valueAddedHistoryQuarterly`: Histórico **trimestral** da Demonstração do Valor Adicionado (DVA). * `cashflowHistory`: Histórico **anual** da Demonstração do Fluxo de Caixa (DFC). * `cashflowHistoryQuarterly`: Histórico **trimestral** da Demonstração do Fluxo de Caixa (DFC). **Exemplo de Uso do `modules`:** Para obter a cotação de BBDC4 junto com seu DRE trimestral e Fluxo de Caixa anual: ```bash curl -X GET "https://brapi.dev/api/quote/BBDC4?modules=incomeStatementHistoryQuarterly,cashflowHistory&token=SEU_TOKEN" ``` ### Resposta: A 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. * **Sucesso (200 OK):** Retorna os dados conforme solicitado. * **Bad Request (400 Bad Request):** Ocorre se um parâmetro for inválido (ex: `range=invalid`) ou se a formatação estiver incorreta. * **Unauthorized (401 Unauthorized):** Token inválido ou ausente. * **Payment Required (402 Payment Required):** Limite de requisições do plano atual excedido. * **Not Found (404 Not Found):** Um ou mais tickers solicitados não foram encontrados. heading: buscar-cotação-detalhada-de-ativos-financeiros *** Endpoints para consulta de dados relacionados a ativos negociados na B3, como **Ações**, **Fundos Imobiliários (FIIs)**, **BDRs**, **ETFs** e **Índices** (ex: IBOVESPA). Permite buscar cotações atuais, dados históricos, informações fundamentalistas (via módulos) e listagens de ativos disponíveis. # Cotação de todas as ações URL: /docs/acoes/list.mdx Endpoints para consulta de dados relacionados a ativos negociados na B3, como Ações, Fundos Imobiliários (FIIs), BDRs, ETFs e Índices (ex: IBOVESPA). Permite buscar cotações atuais, dados históricos, informações fundamentalistas (via módulos) e listagens de ativos disponíveis. *** title: Cotação de todas as 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). Permite buscar cotações atuais, dados históricos, informações fundamentalistas (via módulos) e listagens de ativos disponíveis. full: true keywords: brapi, api, documentação, ações openGraph: title: Cotação de todas as 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). Permite buscar cotações atuais, dados históricos, informações fundamentalistas (via módulos) e listagens de ativos disponíveis. type: website locale: pt\_BR lastUpdated: '2025-04-28T01:22:35.251Z' lang: pt-BR \_openapi: method: GET route: /api/quote/list toc: * depth: 2 title: Cotações de todas as ações, fundos, índices e BDRs url: '#cotacoes-de-todas-as-acoes-fundos-indices-e-bdrs' structuredData: headings: * content: Listar e Filtrar Cotações de Ativos id: cotacoes-de-todas-as-acoes-fundos-indices-e-bdrs contents: * content: >- 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. ### Funcionalidades: * **Busca por Ticker:** Filtre por parte do ticker usando `search`. * **Filtragem por Tipo:** Restrinja a lista a `stock`, `fund` (FII) ou `bdr` com o parâmetro `type`. * **Filtragem por Setor:** Selecione ativos de um setor específico usando `sector`. * **Ordenação:** Ordene os resultados por diversos campos (preço, variação, volume, etc.) usando `sortBy` e `sortOrder`. * **Paginação:** Controle o número de resultados por página (`limit`) e a página desejada (`page`). ### Autenticação: Requer token de autenticação via `token` (query) ou `Authorization` (header). ### Exemplo de Requisição: **Listar as 10 ações do setor Financeiro com maior volume, ordenadas de forma decrescente:** ```bash curl -X GET "https://brapi.dev/api/quote/list?sector=Finance&sortBy=volume&sortOrder=desc&limit=10&page=1&token=SEU_TOKEN" ``` **Buscar por ativos cujo ticker contenha 'ITUB' e ordenar por nome ascendente:** ```bash curl -X GET "https://brapi.dev/api/quote/list?search=ITUB&sortBy=name&sortOrder=asc&token=SEU_TOKEN" ``` ### Resposta: A 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. heading: cotacoes-de-todas-as-acoes-fundos-indices-e-bdrs *** Endpoints para consulta de dados relacionados a ativos negociados na B3, como **Ações**, **Fundos Imobiliários (FIIs)**, **BDRs**, **ETFs** e **Índices** (ex: IBOVESPA). Permite buscar cotações atuais, dados históricos, informações fundamentalistas (via módulos) e listagens de ativos disponíveis. # Listar Criptomoedas URL: /docs/criptomoedas/available.mdx Endpoints focados na obtenção de dados sobre Criptomoedas. Inclui consulta de cotações atuais em diversas moedas fiduciárias, dados históricos e listagem de criptomoedas suportadas pela API. *** title: Listar Criptomoedas description: >- Endpoints focados na obtenção de dados sobre Criptomoedas. Inclui consulta de cotações atuais em diversas moedas fiduciárias, dados históricos e listagem de criptomoedas suportadas pela API. full: true keywords: brapi, api, documentação, criptomoedas openGraph: title: Listar Criptomoedas description: >- Endpoints focados na obtenção de dados sobre Criptomoedas. Inclui consulta de cotações atuais em diversas moedas fiduciárias, dados históricos e listagem de criptomoedas suportadas pela API. type: website locale: pt\_BR lastUpdated: '2025-04-28T01:22:35.254Z' lang: pt-BR \_openapi: method: GET route: /api/v2/crypto/available toc: * depth: 2 title: Listar Todas as Criptomoedas Disponíveis url: '#listar-todas-as-criptomoedas-disponíveis' structuredData: headings: * content: Listar Todas as Criptomoedas Disponíveis id: listar-todas-as-criptomoedas-disponíveis contents: * content: >- Obtenha a lista completa de todas as siglas (tickers) de criptomoedas que a API Brapi suporta para consulta no endpoint `/api/v2/crypto`. ### Funcionalidade: * Retorna um array `coins` com as siglas. * Pode ser filtrado usando o parâmetro `search`. ### Autenticação: Requer token de autenticação via `token` (query) ou `Authorization` (header). ### Exemplo de Requisição: **Listar todas as criptomoedas disponíveis:** ```bash curl -X GET "https://brapi.dev/api/v2/crypto/available?token=SEU_TOKEN" ``` **Buscar criptomoedas cujo ticker contenha 'DOGE':** ```bash curl -X GET "https://brapi.dev/api/v2/crypto/available?search=DOGE&token=SEU_TOKEN" ``` ### Resposta: A resposta é um objeto JSON com a chave `coins`, contendo um array de strings com as siglas das criptomoedas (ex: `["BTC", "ETH", "LTC", "XRP"]`). heading: listar-todas-as-criptomoedas-disponíveis *** Endpoints focados na obtenção de dados sobre **Criptomoedas**. Inclui consulta de cotações atuais em diversas moedas fiduciárias, dados históricos e listagem de criptomoedas suportadas pela API. # Cotação de Criptomoedas URL: /docs/criptomoedas.mdx Endpoints focados na obtenção de dados sobre Criptomoedas. Inclui consulta de cotações atuais em diversas moedas fiduciárias, dados históricos e listagem de criptomoedas suportadas pela API. *** title: Cotação de Criptomoedas description: >- Endpoints focados na obtenção de dados sobre Criptomoedas. Inclui consulta de cotações atuais em diversas moedas fiduciárias, dados históricos e listagem de criptomoedas suportadas pela API. full: true keywords: brapi, api, documentação, criptomoedas openGraph: title: Cotação de Criptomoedas description: >- Endpoints focados na obtenção de dados sobre Criptomoedas. Inclui consulta de cotações atuais em diversas moedas fiduciárias, dados históricos e listagem de criptomoedas suportadas pela API. type: website locale: pt\_BR lastUpdated: '2025-04-28T01:22:35.254Z' lang: pt-BR \_openapi: method: GET route: /api/v2/crypto toc: * depth: 2 title: Buscar Cotação Detalhada de Criptomoedas url: '#buscar-cotação-detalhada-de-criptomoedas' structuredData: headings: * content: Buscar Cotação Detalhada de Criptomoedas id: buscar-cotação-detalhada-de-criptomoedas contents: * content: >- Obtenha cotações atualizadas e dados históricos para uma ou mais criptomoedas. ### Funcionalidades: * **Cotação Múltipla:** Consulte várias criptomoedas em uma única requisição usando o parâmetro `coin`. * **Moeda de Referência:** Especifique a moeda fiduciária para a cotação com `currency` (padrão: BRL). * **Dados Históricos:** Solicite séries históricas usando `range` e `interval` (similar ao endpoint de ações). ### Autenticação: Requer token de autenticação via `token` (query) ou `Authorization` (header). ### Exemplo de Requisição: **Cotação de Bitcoin (BTC) e Ethereum (ETH) em Dólar Americano (USD):** ```bash curl -X GET "https://brapi.dev/api/v2/crypto?coin=BTC,ETH¤cy=USD&token=SEU_TOKEN" ``` **Cotação de Cardano (ADA) em Real (BRL) com histórico do último mês (intervalo diário):** ```bash curl -X GET "https://brapi.dev/api/v2/crypto?coin=ADA¤cy=BRL&range=1mo&interval=1d&token=SEU_TOKEN" ``` ### Resposta: A 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`). heading: buscar-cotação-detalhada-de-criptomoedas *** Endpoints focados na obtenção de dados sobre **Criptomoedas**. Inclui consulta de cotações atuais em diversas moedas fiduciárias, dados históricos e listagem de criptomoedas suportadas pela API. # Listar Países disponíveis URL: /docs/inflacao/available.mdx Endpoints para acessar dados históricos de Índices de Inflação. Permite consultar a inflação de diferentes países ao longo do tempo e listar os países com dados disponíveis. *** title: Listar Países disponíveis description: >- Endpoints para acessar dados históricos de Índices de Inflação. Permite consultar a inflação de diferentes países ao longo do tempo e listar os países com dados disponíveis. full: true keywords: brapi, api, documentação, inflação openGraph: title: Inflação description: >- Endpoints para acessar dados históricos de Índices de Inflação. Permite consultar a inflação de diferentes países ao longo do tempo e listar os países com dados disponíveis. type: website locale: pt\_BR lastUpdated: '2025-04-28T01:22:35.255Z' lang: pt-BR \_openapi: method: GET route: /api/v2/inflation/available toc: * depth: 2 title: Listar Países com Dados de Inflação Disponíveis url: '#listar-países-com-dados-de-inflação-disponíveis' structuredData: headings: * content: Listar Países com Dados de Inflação Disponíveis id: listar-países-com-dados-de-inflação-disponíveis contents: * content: >- 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`. ### Funcionalidade: * Retorna um array `countries` com os nomes dos países (em minúsculas). * Pode ser filtrado usando o parâmetro `search`. ### Autenticação: Requer token de autenticação via `token` (query) ou `Authorization` (header). ### Exemplo de Requisição: **Listar todos os países com dados de inflação:** ```bash curl -X GET "https://brapi.dev/api/v2/inflation/available?token=SEU_TOKEN" ``` **Buscar países cujo nome contenha 'arg':** ```bash curl -X GET "https://brapi.dev/api/v2/inflation/available?search=arg&token=SEU_TOKEN" ``` ### Resposta: A resposta é um objeto JSON com a chave `countries`, contendo um array de strings com os nomes dos países (ex: `["brazil", "argentina", "usa"]`). heading: listar-países-com-dados-de-inflação-disponíveis *** {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} Endpoints para acessar dados históricos de **Índices de Inflação**. Permite consultar a inflação de diferentes países ao longo do tempo e listar os países com dados disponíveis. # Inflação URL: /docs/inflacao.mdx Endpoints para acessar dados históricos de Índices de Inflação. Permite consultar a inflação de diferentes países ao longo do tempo e listar os países com dados disponíveis. *** title: Inflação description: >- Endpoints para acessar dados históricos de Índices de Inflação. Permite consultar a inflação de diferentes países ao longo do tempo e listar os países com dados disponíveis. full: true keywords: brapi, api, documentação, inflação openGraph: title: Inflação description: >- Endpoints para acessar dados históricos de Índices de Inflação. Permite consultar a inflação de diferentes países ao longo do tempo e listar os países com dados disponíveis. type: website locale: pt\_BR lastUpdated: '2025-04-28T01:22:35.255Z' lang: pt-BR \_openapi: method: GET route: /api/v2/inflation toc: * depth: 2 title: Buscar Dados Históricos de Inflação por País url: '#buscar-dados-históricos-de-inflação-por-país' structuredData: headings: * content: Buscar Dados Históricos de Inflação por País id: buscar-dados-históricos-de-inflação-por-país contents: * content: >- Obtenha dados históricos sobre índices de inflação para um país específico. ### Funcionalidades: * **Seleção de País:** Especifique o país desejado com o parâmetro `country` (padrão: `brazil`). * **Filtragem por Período:** Defina um intervalo de datas com `start` e `end` (formato DD/MM/YYYY). * **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`). * **Ordenação:** Ordene os resultados por data (`date`) ou valor (`value`) usando `sortBy` e `sortOrder`. ### Autenticação: Requer token de autenticação via `token` (query) ou `Authorization` (header). ### Exemplo de Requisição: **Buscar dados de inflação do Brasil para o ano de 2022, ordenados por valor ascendente:** ```bash curl -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" ``` **Buscar os dados mais recentes de inflação (sem período definido, ordenação padrão):** ```bash curl -X GET "https://brapi.dev/api/v2/inflation?country=brazil&token=SEU_TOKEN" ``` ### Resposta: A 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). heading: buscar-dados-históricos-de-inflação-por-país *** Endpoints para acessar dados históricos de **Índices de Inflação**. Permite consultar a inflação de diferentes países ao longo do tempo e listar os países com dados disponíveis. # Listar Moedas URL: /docs/moedas/available.mdx Endpoints para consulta de Moedas Fiduciárias. Atualmente, 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). *** title: Listar Moedas description: >- Endpoints para consulta de Moedas Fiduciárias. Atualmente, 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). full: true keywords: brapi, api, documentação, moedas openGraph: title: Listar Moedas description: >- Endpoints para consulta de Moedas Fiduciárias. Atualmente, 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). type: website locale: pt\_BR lastUpdated: '2025-04-28T01:22:35.254Z' lang: pt-BR \_openapi: method: GET route: /api/v2/currency/available toc: * depth: 2 title: Listar Todas as Moedas Fiduciárias Disponíveis url: '#listar-todas-as-moedas-fiduciárias-disponíveis' structuredData: headings: * content: Listar Todas as Moedas Fiduciárias Disponíveis id: listar-todas-as-moedas-fiduciárias-disponíveis contents: * content: >- 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. ### Funcionalidade: * Retorna um array `currencies` com os nomes das moedas. * Pode ser filtrado usando o parâmetro `search`. ### Autenticação: Requer token de autenticação via `token` (query) ou `Authorization` (header). ### Exemplo de Requisição: **Listar todas as moedas disponíveis:** ```bash curl -X GET "https://brapi.dev/api/v2/currency/available?token=SEU_TOKEN" ``` **Buscar moedas cujo nome contenha 'Euro':** ```bash curl -X GET "https://brapi.dev/api/v2/currency/available?search=Euro&token=SEU_TOKEN" ``` ### Resposta: A 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. heading: listar-todas-as-moedas-fiduciárias-disponíveis *** Endpoints para consulta de **Moedas Fiduciárias**. Atualmente, 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). # Cotação de Moedas URL: /docs/moedas.mdx Endpoints para consulta de Moedas Fiduciárias. Atualmente, focado na listagem das moedas disponíveis para conversão ou consulta de taxas de câmbio. *** title: Cotação de Moedas description: >- Endpoints para consulta de Moedas Fiduciárias. Atualmente, focado na listagem das moedas disponíveis para conversão ou consulta de taxas de câmbio. full: true keywords: brapi, api, documentação, moedas openGraph: title: Cotação de Moedas description: >- Endpoints para consulta de Moedas Fiduciárias. Atualmente, focado na listagem das moedas disponíveis para conversão ou consulta de taxas de câmbio. type: website locale: pt\_BR lastUpdated: '2025-04-28T01:22:35.254Z' lang: pt-BR \_openapi: method: GET route: /api/v2/currency/available toc: * depth: 2 title: Listar Todas as Moedas Fiduciárias Disponíveis url: '#listar-todas-as-moedas-fiduciárias-disponíveis' structuredData: headings: * content: Listar Todas as Moedas Fiduciárias Disponíveis id: listar-todas-as-moedas-fiduciárias-disponíveis contents: * content: >- Obtenha cotações atualizadas para um ou mais pares de moedas fiduciárias (ex: USD-BRL, EUR-USD). ### Funcionalidades: * **Cotação Múltipla:** Consulte vários pares de moedas em uma única requisição usando o parâmetro `currency`. \* **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. ### Parâmetros: * **`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). * **`token` (Obrigatório):** Seu token de autenticação. ### Autenticação: Requer token de autenticação válido via `token` (query) ou `Authorization` (header). ### Estrutura da Resposta (200 OK): A resposta bem-sucedida (`CurrencyResponse`) contém um array `currency`. Cada objeto dentro deste array (`CurrencyQuote`) representa um par solicitado e inclui: \* `fromCurrency`: Sigla da moeda de origem. \* `toCurrency`: Sigla da moeda de destino. * `name`: Nome descritivo do par. \* `high`, `low`: Preços máximo e mínimo do período recente. \* `bidVariation`, `percentageChange`: Variação absoluta e percentual. \* `bidPrice`, `askPrice`: Preços de compra e venda atuais. \* `updatedAtTimestamp`, `updatedAtDate`: Timestamps da última atualização. ````json { \"currency\": [ { \"fromCurrency\": \"USD\", \"toCurrency\": \"BRL\", \"name\": \"Dólar Americano/Real Brasileiro\", \"high\": \"5.22\", \"low\": \"5.162\", \"bidVariation\": \"0.0454\", \"percentageChange\": \"0.88\", \"bidPrice\": \"5.2097\", \"askPrice\": \"5.2127\", \"updatedAtTimestamp\": \"1696601423\", \"updatedAtDate\": \"2023-10-06 11:10:23\" }, { \"fromCurrency\": \"EUR\", \"toCurrency\": \"USD\", \"name\": \"Euro/Dólar Americano\", \"high\": \"1.0568\", \"low\": \"1.0482\", \"bidVariation\": \"-0.0037\", \"percentageChange\": \"-0.35\", \"bidPrice\": \"1.051\", \"askPrice\": \"1.0511\", \"updatedAtTimestamp\": \"1696601456\", \"updatedAtDate\": \"2023-10-06 11:10:56\" } ] } ``` heading: listar-todas-as-moedas-fiduciárias-disponíveis ```` *** Endpoints para consulta de **Moedas Fiduciárias**. Atualmente, focado na listagem das moedas disponíveis para conversão ou consulta de taxas de câmbio. # Taxa Básica de Juros - Países Disponíveis URL: /docs/taxa-basica-de-juros/available.mdx Endpoint para listar todos os países com dados de Taxa Básica de Juros (SELIC) disponíveis na API. Permite a filtragem de países por nome, facilitando a implementação de recursos de autocomplete em interfaces. *** title: Taxa Básica de Juros - Países Disponíveis description: >- Endpoint para listar todos os países com dados de Taxa Básica de Juros (SELIC) disponíveis na API. Permite a filtragem de países por nome, facilitando a implementação de recursos de autocomplete em interfaces. full: true keywords: brapi, api, documentação, taxa de juros, selic, prime rate, países openGraph: title: Taxa Básica de Juros - Países Disponíveis description: >- Endpoint para listar todos os países com dados de Taxa Básica de Juros (SELIC) disponíveis na API. Permite a filtragem de países por nome, facilitando a implementação de recursos de autocomplete em interfaces. type: website locale: pt\_BR lastUpdated: '2025-04-29T10:30:45.123Z' lang: pt-BR \_openapi: method: GET route: /api/v2/prime-rate/available toc: * depth: 2 title: Listar Todos Os Possíveis Países com Taxa Básica de Juros (SELIC) Suportados url: '#listar-todos-os-possíveis-países-com-taxa-básica-de-juros-selic-suportados' structuredData: headings: * content: Listar Todos Os Possíveis Países com Taxa Básica de Juros (SELIC) Suportados id: listar-todos-os-possíveis-países-com-taxa-básica-de-juros-selic-suportados contents: * content: >- 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`. ### Funcionalidades: * **Busca Filtrada:** Utilize o parâmetro `search` para filtrar países por nome ou parte do nome. * **Ideal para Autocomplete:** Perfeito para implementar campos de busca com autocompletar em interfaces de usuário. ### Autenticação: Requer token de autenticação via `token` (query) ou `Authorization` (header). ### Exemplo de Requisição: **Listar países que contenham "BR" no nome:** ```bash curl -X GET "https://brapi.dev/api/v2/prime-rate/available?search=BR&token=SEU_TOKEN" ``` **Listar todos os países disponíveis:** ```bash curl -X GET "https://brapi.dev/api/v2/prime-rate/available?token=SEU_TOKEN" ``` ### Resposta: A resposta contém um array `countries` com a lista de países disponíveis para consulta de taxas básicas de juros (ex: `["brazil", "united states", "european union"]`). heading: listar-todos-os-possíveis-países-com-taxa-básica-de-juros-selic-suportados *** Endpoint para listar todos os **países com dados de Taxa Básica de Juros (SELIC)** disponíveis na API. Facilita a descoberta de quais países possuem dados disponíveis e permite a implementação de recursos de busca e autocomplete em interfaces de usuário. # Taxa Básica de Juros URL: /docs/taxa-basica-de-juros.mdx Endpoints para consulta de Taxas Básicas de Juros (SELIC) de diferentes países. Permite 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. *** title: Taxa Básica de Juros description: >- Endpoints para consulta de Taxas Básicas de Juros (SELIC) de diferentes países. Permite 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. full: true keywords: brapi, api, documentação, taxa de juros, selic, prime rate openGraph: title: Taxa Básica de Juros description: >- Endpoints para consulta de Taxas Básicas de Juros (SELIC) de diferentes países. Permite 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. type: website locale: pt\_BR lastUpdated: '2025-04-29T10:30:45.123Z' lang: pt-BR \_openapi: method: GET route: /api/v2/prime-rate toc: * depth: 2 title: Buscar Taxa Básica de Juros (SELIC) de um País por um Período Determinado url: '#buscar-taxa-básica-de-juros-selic-de-um-país-por-um-período-determinado' structuredData: headings: * content: Buscar Taxa Básica de Juros (SELIC) de um País por um Período Determinado id: buscar-taxa-básica-de-juros-selic-de-um-país-por-um-período-determinado contents: * content: >- Obtenha informações atualizadas sobre a taxa básica de juros (SELIC) de um país por um período determinado. ### Funcionalidades: * **Seleção por País:** Especifique o país desejado usando o parâmetro `country` (padrão: brazil). * **Período Customizado:** Defina datas de início e fim com `start` e `end` para consultar um intervalo específico. * **Ordenação:** Ordene os resultados por data ou valor com os parâmetros `sortBy` e `sortOrder`. * **Dados Históricos:** Solicite o histórico completo ou apenas o valor mais recente com o parâmetro `historical`. ### Autenticação: Requer token de autenticação via `token` (query) ou `Authorization` (header). ### Exemplo de Requisição: **Taxa de juros do Brasil entre dezembro/2021 e janeiro/2022:** ```bash curl -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" ``` **Buscar a taxa básica de juros atual do Brasil:** ```bash curl -X GET "https://brapi.dev/api/v2/prime-rate?country=brazil&token=SEU_TOKEN" ``` ### Resposta: A resposta contém um array `prime-rate`, onde cada objeto representa um ponto de dado da taxa básica de juros com sua `date` (DD/MM/YYYY), `value` (o valor da taxa como string) e `epochDate` (timestamp em milissegundos). heading: buscar-taxa-básica-de-juros-selic-de-um-país-por-um-período-determinado *** Endpoints para consulta de **Taxas Básicas de Juros (SELIC)** de diferentes países. Permite 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.