Guia Completo da API PTAX do Banco Central do Brasil

A API PTAX, disponibilizada pelo Banco Central do Brasil, é uma ferramenta poderosa para acessar dados de câmbio do país. Ela permite a consulta de taxas oficiais de câmbio de forma programática, incluindo cotações de compra e venda para diferentes moedas, além de dados históricos.

1. O Que é a API PTAX?

A API PTAX fornece acesso às taxas de câmbio oficiais, que são calculadas com base nas transações do mercado interbancário e divulgadas pelo Banco Central diariamente. A PTAX é amplamente utilizada como uma referência de câmbio em negociações, contabilidade, e operações financeiras.

2. Recursos e Benefícios da API PTAX

A API PTAX oferece diversos benefícios para empresas e desenvolvedores que precisam acessar dados de câmbio de forma confiável e em tempo real:

• Dados Oficiais: A taxa PTAX é usada como referência no Brasil, sendo a cotação oficial que representa o câmbio médio ponderado do mercado.
• Acesso a Dados Históricos: A API permite acessar dados históricos de câmbio, que podem ser úteis para análises financeiras e relatórios.
• Automação: A API possibilita a automação de processos financeiros que dependem de taxas de câmbio, como contabilidade, faturamento e precificação.

3. Estrutura da API PTAX

A API PTAX fornece endpoints que permitem consultas a cotações atuais e passadas. O formato de resposta é em JSON, o que facilita a integração com diversas aplicações.

Endpoints Principais

1. Cotação Atual: Permite consultar a cotação PTAX para uma data específica.

• Endpoint: /CotacaoDolarDia(dataCotacao)
• Parâmetros:
  • dataCotacao: Data da cotação no formato dd-MM-yyyy.

1. Cotação de Intervalo: Permite consultar as cotações dentro de um intervalo específico.

• Endpoint: /CotacaoDolarPeriodo(dataInicial, dataFinal)
• Parâmetros:
  • dataInicial: Data de início do intervalo no formato dd-MM-yyyy.
  • dataFinal: Data final do intervalo no formato dd-MM-yyyy.

1. Cotação por Moeda: Permite consultar a cotação PTAX de outras moedas além do dólar.

• Endpoint: /CotacaoMoedaPeriodo(dataInicial, dataFinal, moeda)
• Parâmetros:
  • dataInicial: Data de início do intervalo no formato dd-MM-yyyy.
  • dataFinal: Data final do intervalo no formato dd-MM-yyyy.
  • moeda: Código da moeda em padrão ISO (ex.: USD, EUR).

4. Como Usar a API PTAX: Exemplo em Node.js

Aqui está um exemplo de como integrar e consultar dados da API PTAX utilizando Node.js.

Passo 1: Instale o Axios para Consultas HTTP

O Axios é uma biblioteca popular em JavaScript para fazer requisições HTTP. Execute o seguinte comando para instalá-lo:

npm install axios

Passo 2: Código para Consulta da Cotação Atual do Dólar

const axios = require('axios');

async function getCotacaoDolarAtual(dataCotacao) {
    const url = `https://olinda.bcb.gov.br/olinda/servico/PTAX/versao/v1/odata/CotacaoDolarDia(dataCotacao=@dataCotacao)?@dataCotacao='${dataCotacao}'&$format=json`;

    try {
        const response = await axios.get(url);
        const cotacao = response.data.value[0];
        console.log(`Cotação do Dólar em ${dataCotacao}: Compra - R$ ${cotacao.cotacaoCompra}, Venda - R$ ${cotacao.cotacaoVenda}`);
    } catch (error) {
        console.error("Erro ao buscar cotação:", error.message);
    }
}

getCotacaoDolarAtual("01-11-2023");

Explicação do Código

• URL da API: O URL para a cotação atual do dólar inclui a data da cotação no formato dd-MM-yyyy.
• Resposta: A resposta retorna um JSON contendo as cotações de compra e venda para o dólar americano na data especificada.
• Exemplo de Saída: “Cotação do Dólar em 01-11-2023: Compra – R$ 4,90, Venda – R$ 4,95”.

5. Exemplo de Consulta de Cotações para um Intervalo em Power BI

Power BI oferece uma maneira poderosa de integrar dados externos em relatórios dinâmicos e gráficos. A seguir, explicamos como configurar o Power BI para acessar a API PTAX e criar um relatório que exiba as cotações em um intervalo de datas.

1. Abra o Power BI e vá em “Obter dados” > “Web”.
2. Cole a URL do endpoint /CotacaoDolarPeriodo, especificando o intervalo desejado:

   https://olinda.bcb.gov.br/olinda/servico/PTAX/versao/v1/odata/CotacaoDolarPeriodo(dataInicial=@dataInicial,dataFinal=@dataFinal)?@dataInicial='01-10-2023'&@dataFinal='31-10-2023'&$format=json

3. Carregue os Dados: O Power BI fará o download das cotações para o intervalo especificado.
4. Transformação e Visualização: No editor de consultas, filtre e organize os dados como preferir. Você pode criar gráficos que mostram a variação do dólar no período.

6. Exemplo de Implementação em C

Abaixo está um exemplo de como consultar a API PTAX em C# usando HttpClient:

using System;
using System.Net.Http;
using System.Threading.Tasks;

public class PTAXApi
{
    private static readonly HttpClient client = new HttpClient();

    public async Task GetDolarCotacao(string dataCotacao)
    {
        string url = $"https://olinda.bcb.gov.br/olinda/servico/PTAX/versao/v1/odata/CotacaoDolarDia(dataCotacao=@dataCotacao)?@dataCotacao='{dataCotacao}'&$format=json";

        HttpResponseMessage response = await client.GetAsync(url);
        if (response.IsSuccessStatusCode)
        {
            string responseData = await response.Content.ReadAsStringAsync();
            Console.WriteLine("Dados da API PTAX: " + responseData);
        }
        else
        {
            Console.WriteLine("Erro ao buscar dados da API PTAX.");
        }
    }
}

class Program
{
    static async Task Main(string[] args)
    {
        PTAXApi ptaxApi = new PTAXApi();
        await ptaxApi.GetDolarCotacao("01-11-2023");
    }
}

7. Exemplo de Consulta em PHP

Em PHP, você pode usar a função file_get_contents para acessar a API e buscar dados de câmbio.

<?php
function getCotacaoDolar($dataCotacao) {
    $url = "https://olinda.bcb.gov.br/olinda/servico/PTAX/versao/v1/odata/CotacaoDolarDia(dataCotacao=@dataCotacao)?@dataCotacao='$dataCotacao'&\$format=json";
    $json = file_get_contents($url);
    $data = json_decode($json, true);

    if (isset($data["value"][0])) {
        $compra = $data["value"][0]["cotacaoCompra"];
        $venda = $data["value"][0]["cotacaoVenda"];
        echo "Cotação do Dólar em $dataCotacao: Compra - R$ $compra, Venda - R$ $venda";
    } else {
        echo "Dados não encontrados para a data $dataCotacao.";
    }
}

getCotacaoDolar("01-11-2023");
?>

8. Tabela Resumo das Principais Operações da API PTAX

eda)| Cotações para outras moedas no período |https://olinda.bcb.gov.br/olinda/servico/PTAX/versao/v1/odata/CotacaoMoedaPeriodo(dataInicial=@dataInicial,dataFinal=@dataFinal,moeda=@moeda)?@dataInicial=’01-10-2023’&@dataFinal=’31-10-2023’&@moeda=’EUR’&$format=json` |

9. Conclusão

A API PTAX do Banco Central é uma ferramenta poderosa para a obtenção de dados de câmbio no Brasil, útil para automatizar processos financeiros e análises econômicas. A flexibilidade dos endpoints permite integrar essas informações em diversos sistemas.