GetExchangeRate
Access real-time and historical exchange rates for forex and cryptocurrency pairs. Use the API to specify currency pairs, date ranges, timezones, and data formats for precise financial insights.
Instructions
This API call returns real-time exchange rate for currency pair. Works with forex and cryptocurrency.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Input Schema (JSON Schema)
{
"$defs": {
"GetExchangeRateRequest": {
"description": "This API call returns real-time exchange rate for currency pair. Works with forex and cryptocurrency.",
"properties": {
"apikey": {
"default": "demo",
"description": "API key",
"examples": [
"demo"
],
"title": "Apikey",
"type": "string"
},
"date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "If not null, will use exchange rate from a specific date or time. Format `2006-01-02` or `2006-01-02 15:04:05`. Is set in the local exchange time zone, use timezone parameter to specify a specific time zone",
"examples": [
"2006-01-02 15:04:05"
],
"title": "Date"
},
"delimiter": {
"default": ";",
"description": "Specify the delimiter used when downloading the `CSV` file. Default semicolon `;`",
"title": "Delimiter",
"type": "string"
},
"dp": {
"default": 5,
"description": "The number of decimal places for the data",
"title": "Dp",
"type": "integer"
},
"format": {
"default": "JSON",
"description": "Value can be `JSON` or `CSV`. Default `JSON`",
"title": "Format",
"type": "string"
},
"symbol": {
"description": "The currency pair you want to request can be either forex or cryptocurrency. Slash(/) delimiter is used. E.g. `EUR/USD` or `BTC/ETH` will be correct",
"examples": [
"EUR/USD"
],
"title": "Symbol",
"type": "string"
},
"timezone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Timezone at which output datetime will be displayed. Supports:\n<ul>\n<li>1. <code>Exchange</code> for local exchange time</li>\n<li>2. <code>UTC</code> for datetime at universal UTC standard</li>\n<li>3. Timezone name according to the IANA Time Zone Database. E.g. <code>America/New_York</code>, <code>Asia/Singapore</code>. Full list of timezones can be found <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\" target=\"blank\">here</a>.</li>\n</ul>\n<i>Take note that the IANA Timezone name is case-sensitive</i>",
"examples": [
"UTC"
],
"title": "Timezone"
}
},
"required": [
"symbol"
],
"title": "GetExchangeRateRequest",
"type": "object"
}
},
"properties": {
"params": {
"$ref": "#/$defs/GetExchangeRateRequest"
}
},
"required": [
"params"
],
"title": "GetExchangeRateArguments",
"type": "object"
}