Saltar para o conteúdo principal
GET
Conversão de moeda

Primeiros passos

URL base

Endpoint de validação

O endpoint convert requer a sua chave API, uma moeda base e um parâmetro target para realizar conversões de moeda.
Este pedido bem-sucedido converte 1 EUR para USD utilizando a taxa de câmbio mais atual:

Parâmetros de pedido

api_key
String
obrigatório
A sua chave API única. Note que cada utilizador tem chaves API únicas para cada uma das APIs Cleariflow — a sua chave da API de taxas de câmbio não funcionará para a API de geolocalização IP, por exemplo.
base
String
obrigatório
A moeda base utilizada para obter a(s) taxa(s) de câmbio mais recente(s). Utiliza o padrão de moeda ISO 4217 (por exemplo, USD para dólares americanos), como todos os parâmetros de moeda nesta API.
target
String
obrigatório
A moeda de destino para obter a taxa de câmbio face à moeda base. Como os parâmetros base, qualquer moeda passada aqui segue o padrão ISO 4217. Note que, ao contrário dos outros endpoints, convert aceita apenas uma moeda de destino de cada vez.
date
String
A data histórica da qual pretende obter taxas, no formato AAAA-MM-DD. Se deixar este campo em branco, serão utilizadas as taxas mais recentes disponíveis.
base_amount
Float
O montante da moeda base que pretende converter para a moeda de destino.

Parâmetros de resposta

A resposta da API é devolvida num formato JSON universal e leve.
base
String
A moeda base utilizada para obter as taxas de câmbio.
target
String
A moeda de destino para a qual o base_amount foi convertido.
date
String
A data de origem das moedas, conforme o pedido bem-sucedido.
base_amount
Float
O montante da moeda base do pedido.
converted_amount
Float
O montante da moeda de destino para o qual o base_amount foi convertido.
exchange_rate
Float
A taxa de câmbio utilizada para converter o base_amount da moeda base para a moeda de destino.