Documentação da API

Aprenda como usar nossa API de taxa de câmbio

GET Obter Todas as Taxas de Câmbio
https://tipodecambio.cr/api/rates

Retorna as últimas taxas de câmbio de todas as instituições, incluindo as taxas do BCCR e Monex.

Exemplo de Resposta:

{
  "timestamp": 1700000000,
  "rates": [
    {
      "entidad": "Banco Nacional",
      "compra": 520.50,
      "venta": 525.00,
      "actualizacion": "2024-01-15",
      "institution_id": 1
    }
  ],
  "bccr_rate": {
    "compra": 520.00,
    "venta": 525.00,
    "fecha": "2024-01-15"
  },
  "monex_rate": {
    "promedio": 522.50,
    "fecha": "2024-01-15"
  }
}
GET Obter Histórico de Taxas de Câmbio
https://tipodecambio.cr/api/rates/history?institution_id={id}&limit={limit}

Retorna dados históricos de taxas de câmbio.

Parâmetros de Consulta:

Parâmetro Tipo Obrigatório Descrição
institution_id integer Não Filtrar por ID da instituição. Se omitido, retorna todas as instituições.
limit integer Não Número máximo de registros a retornar (padrão: 100)

Exemplo de Resposta:

{
  "history": [
    {
      "fecha": "2024-01-15",
      "compra": 520.50,
      "venta": 525.00,
      "institution": {
        "id": 1,
        "name": "Banco Nacional"
      }
    }
  ]
}
GET Obter Histórico de Instituição
https://tipodecambio.cr/api/rates/institution/{id}?limit={limit}

Retorna dados históricos de taxas de câmbio para uma instituição específica.

Parâmetros de URL:

Parâmetro Tipo Obrigatório Descrição
id integer Sim ID da Instituição

Parâmetros de Consulta:

Parâmetro Tipo Obrigatório Descrição
limit integer Não Número máximo de registros a retornar (padrão: 100)

Exemplo de Resposta:

{
  "institution": {
    "id": 1,
    "name": "Banco Nacional",
    "logo_url": "https://example.com/logo.png",
    "website_url": "https://www.bncr.fi.cr"
  },
  "history": [
    {
      "fecha": "2024-01-15",
      "compra": 520.50,
      "venta": 525.00
    }
  ]
}

Notas Gerais

  • Todos os endpoints da API retornam respostas JSON
  • Todas as datas estão no formato YYYY-MM-DD
  • As taxas de câmbio são retornadas como números de ponto flutuante
  • A API não requer autenticação para endpoints públicos
  • A limitação de taxa é aplicada por endereço IP