API

WebSocket

Symbols

Back to Home Page Login to Dashboard

API Documentation

Access real-time and historical market data with easy-to-integrate RESTful endpoints.

Get Your Free API Key

Products

High demand

Endpoint

6 endpoint(s) for Forex

Forex Last Quote
Forex Last Trade
Forex Aggregates
Forex Previous Close
Forex Currency Converter API
Forex Snapshot API

Forex Aggregates

With the Forex Aggregates API, you can get the tick bars of the forex symbol.

URL Schema

https://api.finage.co.uk/agg/forex/{ symbol }/{ multiply }/{ time }/{ from }/{ to }?apikey=YOUR_API_KEY

Example Request

https://api.finage.co.uk/agg/forex/GBPUSD/1/day/2021-01-01/2021-01-05?apikey=YOUR_API_KEY

Example Output

{
  "symbol": "GBPUSD",
  "totalResults": 4,
  "results": [
{
      "v": 254,
      "o": 1.3642,
      "c": 1.3667,
      "h": 1.3677,
      "l": 1.3642,
      "t": 1609477200000
    },
{
      "v": 300,
      "o": 1.367,
      "c": 1.3685,
      "h": 1.369,
      "l": 1.366,
      "t": 1609480800000
    },
{
      "v": 275,
      "o": 1.3685,
      "c": 1.37,
      "h": 1.371,
      "l": 1.368,
      "t": 1609484400000
    },
{
      "v": 320,
      "o": 1.37,
      "c": 1.372,
      "h": 1.373,
      "l": 1.3695,
      "t": 1609488000000
    }
  ]
}

Input Parameters (* required field)

* symbolSymbol Name
* multiplyTime Multiplier
* timeSize of the time. [minute, hour, day, week, month, quarter, year]
* fromStart date
* toEnd date
limitLimit of the results. Default is 100, maximum allowed limit is 50000. Please set a limit if you are using the API in the production.
sortYou can sort the results by timestamp. asc will return ascending results oldest to newest, desc will return descending results newest to oldest. Default is asc.
dbt_filterDaily-based time filter. You can allow the time filters to filter daily based. Otherwise, the filter will only trim the start and end of the output. Default is false.
stStart time in UTC. (Eg. 17:30)
etEnd time in UTC. (Eg. 17:45)
date_formatYou can change the format of the date in the results. ts is timestamp, dt is datetime. [Default is dt]

Output Parameters

symbolSymbol Name
totalResultsResult Count
oOpen Price
hHighest Price
cClose Price
lLowest Price
vVolume
tTimestamp