# 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. ## Swagger Documentation # Brapi - API do Mercado Financeiro Brasileiro - /api/v2/currency Single endpoint documentation for /api/v2/currency ## Base URLs - `https://brapi.dev` - Servidor principal da API Brapi - `http://localhost:3000` - Servidor local para desenvolvimento ## GET /api/v2/currency **Summary:** Buscar Cotação de Pares de Moedas Fiduciárias 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). **Tags:** Moedas ### Parameters - **currency** (query) *required*: **Obrigatório.** Uma lista de um ou mais pares de moedas a serem consultados, separados por vírgula (`,`). * **Formato:** `MOEDA_ORIGEM-MOEDA_DESTINO` (ex: `USD-BRL`). * **Disponibilidade:** Consulte os pares válidos usando o endpoint [`/api/v2/currency/available`](#/Moedas/getAvailableCurrencies). * **Exemplo:** `USD-BRL,EUR-BRL,BTC-BRL` - **undefined** (undefined) ### Responses #### 200 **Sucesso (OK).** A requisição foi bem-sucedida e as cotações dos pares de moedas solicitados foram retornadas no array `currency`. #### 400 **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. **Example Response:** ```json { "error": true, "message": "Algo deu errado ao buscar essa moeda" } ``` #### 401 #### 417 **Expectation Failed (Falha na Expectativa).** O parâmetro obrigatório `currency` não foi fornecido na requisição. **Example Response:** ```json { "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" } ``` ## Schemas The following schemas are used by this endpoint: ### CurrencyQuote 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** (string) *(required)* **Moeda de Origem:** Sigla da moeda base do par (ex: `USD` em `USD-BRL`). - **toCurrency** (string) *(required)* **Moeda de Destino:** Sigla da moeda de cotação do par (ex: `BRL` em `USD-BRL`). - **name** (string) *(required)* **Nome do Par:** Nome descritivo do par de moedas (ex: `Dólar Americano/Real Brasileiro`). - **high** (string) *(required)* **Máxima:** Preço mais alto atingido pelo par no período recente (geralmente diário). Formato String. - **low** (string) *(required)* **Mínima:** Preço mais baixo atingido pelo par no período recente (geralmente diário). Formato String. - **bidVariation** (string) *(required)* **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. - **percentageChange** (string) *(required)* **Variação Percentual:** Mudança percentual no preço do par desde o último fechamento ou período de referência. Formato String. - **bidPrice** (string) *(required)* **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. - **askPrice** (string) *(required)* **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. - **updatedAtTimestamp** (string) *(required)* **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). - **updatedAtDate** (string) *(required)* **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`). ### CurrencyResponse Estrutura da **resposta principal** do endpoint `GET /api/v2/currency`. **Properties:** - **currency** (array) *(required)* Array contendo os objetos `CurrencyQuote`, um para cada par de moeda válido solicitado no parâmetro `currency`. Array items: Reference to: **CurrencyQuote** ### ErrorResponse Schema padrão para respostas de erro da API. **Properties:** - **error** (boolean) *(required)* Indica se a requisição resultou em erro. Sempre `true` para este schema. - **message** (string) *(required)* Mensagem descritiva do erro ocorrido.