Currency Data Feed Retrieval

Note: If you are upgrading from a previous version, please see changes.

Data retrieval is performed via simple RESTful HTTP GET.

Basic Usage

In all of the following examples please replace YOUR_KEY with the access key provided with your subscription.

Example 1: Get a list of Symbols

The following example URL retrieves a complete list of ISO symbols (Currency and/or Metals) available in your account.

/symbols/YOUR_KEY


Example 2: Get a list of Intervals

The following example URL retrieves a complete list of Intervals (OHLC Time scales) available in your account.

/intervals/YOUR_KEY


Example 3: Get a Currency Conversion

The following example URL retrieves a live Currency Conversion using the latest market pricing. This conversion request converts 999 EUR to USD.

/convert/YOUR_KEY/999/EUR/USD
URL Part Description (see table below for more information of each):
/convert/YOUR_KEY/CONVERT_VALUE/CONVERT_FROM/CONVERT_TO


Example 4: Get the current 5-min Open, High, Low, Close (OHLC) Quote

The following example URL retrieves the current 5-min Open, High, Low, Close (OHLC) quote in CSV format for the EUR/USD currency pair:

/data/YOUR_KEY/i-300/s-EURUSD


Example 5: Get the past 24 hours of OHLC quotes in XML format

The following example URL retrieves the past twentyfour hours of 1-hour OHLC quotes in XML format for the EUR/USD, USD/GBP, USD/CHF and USD/JPY currency pairs. A total of 96 quotes are returned (twentyfour 1-hour OHLC quotes for each of the four symbols)

/data/YOUR_KEY/n-24/f-xml/i-3600/s-EURUSD,USDGBP,USDCHF,USDJPY

Example 6: Get the past 30 days of OHLC quotes in CSV format

The following example URL retrieves the past thirty Daily OHLC quotes in CSV format for the EUR/USD, XAU/USD Currency & Gold pairs. A total of 60 quotes are returned (thirty 1-Day OHLC quotes for each of the two symbols)

/data/YOUR_KEY/n-30/f-csv/i-86400/s-EURUSD,XAUUSD


Advanced Data Retrieval

 

The table below describes various data retrieval parameters and their purpose.


All request for data begin with following Base Url followed by a combination of the URL parameters described in the Table below.
/data/YOUR_KEY/ ...(additional URL parameters) Note that not every parameter is required at all times. Many parameters have a Default Value, where if a value is not provided (by you) then the Default Value will be applied.


Defining the Parameters in your Request URL

  • Parameters are passed in as URL Parts (separated by a forward slash /).
  • Each Parameter must be accompanied by a Value.
  • Each Parameter and it's Value are separated by a hyphen (-).
  • Parameters that accept multiple values (such a s) have their Values further separated by a comma (,).

Variable name Default value Allowed values Description
f csv csv, xml, json Data Output Format
csv = Comma Separated Values
xml = Extensible Markup Language
json = JavaScript Object Notation
n 1 numeric Number of Data Points / Periods
The number of periods to retrieve. For example, if you fetch 1 minute data and 30 periods then you would receive a 30 count of 1-minute OHLC bars
i none
1
5
10
15
30
45

60
300
600
900
1200
1800
2700

3600
7200
10800
14400
21600
43200

86400
604800
2628000
Data Interval
1 = Tick data (for Bid/Ask or Mid quotes)
5 = 5 Second data (OHLC)
10 = 10 Second data (OHLC)
15 = 15 Second data (OHLC)
30 = 30 Second data (OHLC)
45 = 45 Second data (OHLC)

60 = 1 Minute data (OHLC)
300 = 5 Minute data (OHLC)
600 = 10 Minute data (OHLC)
900 = 15 Minute data (OHLC)
1200 = 20 Minute data (OHLC)
1800 = 30 Minute data (OHLC)
2700 = 45 Minute data (OHLC)

3600 = 1 Hour data (OHLC)
7200 = 2 Hour data (OHLC)
10800 = 3 Hour data (OHLC)
14400 = 4 Hour data (OHLC)
21600 = 6 Hour data (OHLC)
43200 = 12 Hour data (OHLC)

86400 = 1 Day/Daily data (OHLC)
604800 = 1 Week/Monthly data (OHLC)
2628000 = 1 Month/Monthly data (OHLC)
p mid mid
bid
ask
bid,ask
Price Type
OHLC options: mid, bid, or ask
Tick options: mid or bid,ask
sep comma (,) User defined Column Separator
This parameter allows you to change the default column separator (applicable to CSV data format only)
eol LF LF
CRLF
CR
Line Ending / End Of Line
This parameter allows you to change the default line ending.
Unix programs might expect a Line Feed: "LF" (\n)
Mac programs might expect a Carriage Return: "CR" (\r)
Windows programs might expect a Carriage Return Line Feed: "CRLF" (\r\n)
df Epoch timestamp epoch
ymd
ymdh
ymdhm
ymdhms
mmddyyyyhhmm
mmddyyyyhhmmss
Date/Timestamp Formatting
epoch: Seconds since Jan, 1 1970
ymd: YYYY-MM-DD
ymdh: YYYY-MM-DD HH
ymdhm: YYYY-MM-DD HH:MM
ymdhms: YYYY-MM-DD HH:MM:SS
mmddyyyyhhmm: MM/DD/YYYY HH:MM
mmddyyyyhhmmss: MM/DD/YYYY HH:MM:SS
All date are in UTC / GMT time
st none epoch The requested Starting Time of data. The Starting Time is expressed as an Epoch timestamp representing the earliest date you wish to load. The number of data points will then be limited by the requested Number of Data Points.
NOTE: Historical data services must be enabled on your service in order to use the load by Start Time function. * Only one Symol per request will be included when retrieving Historic Data by Start Time.
wd D Y, N, D Include Weekend Data:
Y: Yes
N: No
D: Default
s none AUDCAD,
AUDCHF,
AUDCNY,
AUDCZK,
AUDDKK,
AUDEUR,
AUDGBP,
AUDHKD,
AUDHUF,
AUDINR,
AUDJPY,
AUDMXN,
AUDNOK,
AUDNZD,
AUDPLN,
AUDSAR,
AUDSEK,
AUDSGD,
AUDTHB,
AUDTRY,
AUDTWD,
AUDUSD,
AUDXAG,
AUDXAU,
AUDZAR,
CADAUD,
CADCHF,
CADCNY,
CADCZK,
CADDKK,
CADEUR,
CADGBP,
CADHKD,
CADHUF,
CADINR,
CADJPY,
CADMXN,
CADNOK,
CADNZD,
CADPLN,
CADSAR,
CADSEK,
CADSGD,
CADTHB,
CADTRY,
CADTWD,
CADUSD,
CADXAG,
CADXAU,
CADZAR,
CHFAUD,
CHFCAD,
CHFCNY,
CHFCZK,
CHFDKK,
CHFEUR,
CHFGBP,
CHFHKD,
CHFHUF,
CHFINR,
CHFJPY,
CHFMXN,
CHFNOK,
CHFNZD,
CHFPLN,
CHFSAR,
CHFSEK,
CHFSGD,
CHFTHB,
CHFTRY,
CHFTWD,
CHFUSD,
CHFXAG,
CHFXAU,
CHFZAR,
CNYAUD,
CNYCAD,
CNYCHF,
CNYEUR,
CNYGBP,
CNYHKD,
CNYJPY,
CNYSGD,
CNYUSD,
CZKAUD,
CZKCAD,
CZKCHF,
CZKEUR,
CZKGBP,
CZKHKD,
CZKJPY,
CZKSGD,
CZKUSD,
DKKAUD,
DKKCAD,
DKKCHF,
DKKEUR,
DKKGBP,
DKKHKD,
DKKJPY,
DKKSGD,
DKKUSD,
EURAUD,
EURCAD,
EURCHF,
EURCNY,
EURCZK,
EURDKK,
EURGBP,
EURHKD,
EURHUF,
EURINR,
EURJPY,
EURMXN,
EURNOK,
EURNZD,
EURPLN,
EURSAR,
EURSEK,
EURSGD,
EURTHB,
EURTRY,
EURTWD,
EURUSD,
EURXAG,
EURXAU,
EURZAR,
GBPAUD,
GBPCAD,
GBPCHF,
GBPCNY,
GBPCZK,
GBPDKK,
GBPEUR,
GBPHKD,
GBPHUF,
GBPINR,
GBPJPY,
GBPMXN,
GBPNOK,
GBPNZD,
GBPPLN,
GBPSAR,
GBPSEK,
GBPSGD,
GBPTHB,
GBPTRY,
GBPTWD,
GBPUSD,
GBPXAG,
GBPXAU,
GBPZAR,
HKDAUD,
HKDCAD,
HKDCHF,
HKDCNY,
HKDCZK,
HKDDKK,
HKDEUR,
HKDGBP,
HKDHUF,
HKDINR,
HKDJPY,
HKDMXN,
HKDNOK,
HKDNZD,
HKDPLN,
HKDSAR,
HKDSEK,
HKDSGD,
HKDTHB,
HKDTRY,
HKDTWD,
HKDUSD,
HKDXAG,
HKDXAU,
HKDZAR,
HUFAUD,
HUFCAD,
HUFCHF,
HUFEUR,
HUFGBP,
HUFHKD,
HUFJPY,
HUFSGD,
HUFUSD,
INRAUD,
INRCAD,
INRCHF,
INREUR,
INRGBP,
INRHKD,
INRJPY,
INRSGD,
INRUSD,
JPYAUD,
JPYCAD,
JPYCHF,
JPYCNY,
JPYCZK,
JPYDKK,
JPYEUR,
JPYGBP,
JPYHKD,
JPYHUF,
JPYINR,
JPYMXN,
JPYNOK,
JPYNZD,
JPYPLN,
JPYSAR,
JPYSEK,
JPYSGD,
JPYTHB,
JPYTRY,
JPYTWD,
JPYUSD,
JPYXAG,
JPYXAU,
JPYZAR,
MXNAUD,
MXNCAD,
MXNCHF,
MXNEUR,
MXNGBP,
MXNHKD,
MXNJPY,
MXNSGD,
MXNUSD,
NOKAUD,
NOKCAD,
NOKCHF,
NOKEUR,
NOKGBP,
NOKHKD,
NOKJPY,
NOKSGD,
NOKUSD,
NZDAUD,
NZDCAD,
NZDCHF,
NZDEUR,
NZDGBP,
NZDHKD,
NZDJPY,
NZDSGD,
NZDUSD,
NZDXAG,
NZDXAU,
PLNAUD,
PLNCAD,
PLNCHF,
PLNEUR,
PLNGBP,
PLNHKD,
PLNJPY,
PLNSGD,
PLNUSD,
SARAUD,
SARCAD,
SARCHF,
SAREUR,
SARGBP,
SARHKD,
SARJPY,
SARSGD,
SARUSD,
SEKAUD,
SEKCAD,
SEKCHF,
SEKEUR,
SEKGBP,
SEKHKD,
SEKJPY,
SEKSGD,
SEKUSD,
SGDAUD,
SGDCAD,
SGDCHF,
SGDCNY,
SGDCZK,
SGDDKK,
SGDEUR,
SGDGBP,
SGDHKD,
SGDHUF,
SGDINR,
SGDJPY,
SGDMXN,
SGDNOK,
SGDNZD,
SGDPLN,
SGDSAR,
SGDSEK,
SGDTHB,
SGDTRY,
SGDTWD,
SGDUSD,
SGDXAG,
SGDXAU,
SGDZAR,
THBAUD,
THBCAD,
THBCHF,
THBEUR,
THBGBP,
THBHKD,
THBJPY,
THBSGD,
THBUSD,
TRYAUD,
TRYCAD,
TRYCHF,
TRYEUR,
TRYGBP,
TRYHKD,
TRYJPY,
TRYSGD,
TRYUSD,
TWDAUD,
TWDCAD,
TWDCHF,
TWDEUR,
TWDGBP,
TWDHKD,
TWDJPY,
TWDSGD,
TWDUSD,
USDAUD,
USDCAD,
USDCHF,
USDCNY,
USDCZK,
USDDKK,
USDEUR,
USDGBP,
USDHKD,
USDHUF,
USDINR,
USDJPY,
USDMXN,
USDNOK,
USDNZD,
USDPLN,
USDSAR,
USDSEK,
USDSGD,
USDTHB,
USDTRY,
USDTWD,
USDXAG,
USDXAU,
USDXPT,
USDZAR,
XAGAUD,
XAGCAD,
XAGCHF,
XAGEUR,
XAGGBP,
XAGHKD,
XAGJPY,
XAGNZD,
XAGSGD,
XAGUSD,
XAGXAU,
XAUAUD,
XAUCAD,
XAUCHF,
XAUEUR,
XAUGBP,
XAUHKD,
XAUJPY,
XAUNZD,
XAUSGD,
XAUUSD,
XAUXAG,
XPTUSD,
ZARAUD,
ZARCAD,
ZARCHF,
ZAREUR,
ZARGBP,
ZARHKD,
ZARJPY,
ZARSGD,
ZARUSD,
Data Symbol(s)
One or more currency symbols (separated by a comma).

Currently supported symbols include:
SYMBOL, DECIMALS
AUD/CAD, 5
AUD/CHF, 5
AUD/CNY, 4
AUD/CZK, 4
AUD/DKK, 5
AUD/EUR, 5
AUD/GBP, 5
AUD/HKD, 5
AUD/HUF, 3
AUD/INR, 2
AUD/JPY, 3
AUD/MXN, 5
AUD/NOK, 5
AUD/NZD, 5
AUD/PLN, 5
AUD/SAR, 4
AUD/SEK, 5
AUD/SGD, 5
AUD/THB, 3
AUD/TRY, 5
AUD/TWD, 4
AUD/USD, 5
AUD/XAG, 5
AUD/XAU, 8
AUD/ZAR, 4
CAD/AUD, 5
CAD/CHF, 5
CAD/CNY, 4
CAD/CZK, 4
CAD/DKK, 5
CAD/EUR, 5
CAD/GBP, 5
CAD/HKD, 5
CAD/HUF, 3
CAD/INR, 2
CAD/JPY, 3
CAD/MXN, 5
CAD/NOK, 5
CAD/NZD, 5
CAD/PLN, 5
CAD/SAR, 4
CAD/SEK, 5
CAD/SGD, 5
CAD/THB, 3
CAD/TRY, 5
CAD/TWD, 4
CAD/USD, 5
CAD/XAG, 5
CAD/XAU, 8
CAD/ZAR, 4
CHF/AUD, 5
CHF/CAD, 5
CHF/CNY, 4
CHF/CZK, 4
CHF/DKK, 5
CHF/EUR, 5
CHF/GBP, 5
CHF/HKD, 5
CHF/HUF, 3
CHF/INR, 2
CHF/JPY, 3
CHF/MXN, 5
CHF/NOK, 5
CHF/NZD, 5
CHF/PLN, 5
CHF/SAR, 4
CHF/SEK, 5
CHF/SGD, 5
CHF/THB, 3
CHF/TRY, 5
CHF/TWD, 4
CHF/USD, 5
CHF/XAG, 5
CHF/XAU, 8
CHF/ZAR, 5
CNY/AUD, 4
CNY/CAD, 4
CNY/CHF, 4
CNY/EUR, 4
CNY/GBP, 4
CNY/HKD, 4
CNY/JPY, 2
CNY/SGD, 4
CNY/USD, 4
CZK/AUD, 4
CZK/CAD, 4
CZK/CHF, 4
CZK/EUR, 5
CZK/GBP, 4
CZK/HKD, 4
CZK/JPY, 5
CZK/SGD, 4
CZK/USD, 5
DKK/AUD, 5
DKK/CAD, 5
DKK/CHF, 5
DKK/EUR, 5
DKK/GBP, 5
DKK/HKD, 5
DKK/JPY, 3
DKK/SGD, 5
DKK/USD, 5
EUR/AUD, 5
EUR/CAD, 5
EUR/CHF, 5
EUR/CNY, 4
EUR/CZK, 5
EUR/DKK, 5
EUR/GBP, 5
EUR/HKD, 5
EUR/HUF, 3
EUR/INR, 2
EUR/JPY, 3
EUR/MXN, 5
EUR/NOK, 5
EUR/NZD, 5
EUR/PLN, 5
EUR/SAR, 4
EUR/SEK, 5
EUR/SGD, 5
EUR/THB, 3
EUR/TRY, 5
EUR/TWD, 4
EUR/USD, 5
EUR/XAG, 5
EUR/XAU, 8
EUR/ZAR, 5
GBP/AUD, 5
GBP/CAD, 5
GBP/CHF, 5
GBP/CNY, 4
GBP/CZK, 4
GBP/DKK, 5
GBP/EUR, 5
GBP/HKD, 5
GBP/HUF, 3
GBP/INR, 2
GBP/JPY, 3
GBP/MXN, 5
GBP/NOK, 5
GBP/NZD, 5
GBP/PLN, 5
GBP/SAR, 4
GBP/SEK, 5
GBP/SGD, 5
GBP/THB, 3
GBP/TRY, 5
GBP/TWD, 4
GBP/USD, 5
GBP/XAG, 5
GBP/XAU, 8
GBP/ZAR, 5
HKD/AUD, 5
HKD/CAD, 5
HKD/CHF, 5
HKD/CNY, 4
HKD/CZK, 4
HKD/DKK, 5
HKD/EUR, 5
HKD/GBP, 5
HKD/HUF, 3
HKD/INR, 4
HKD/JPY, 5
HKD/MXN, 5
HKD/NOK, 5
HKD/NZD, 5
HKD/PLN, 5
HKD/SAR, 4
HKD/SEK, 5
HKD/SGD, 5
HKD/THB, 3
HKD/TRY, 5
HKD/TWD, 4
HKD/USD, 5
HKD/XAG, 5
HKD/XAU, 8
HKD/ZAR, 4
HUF/AUD, 8
HUF/CAD, 8
HUF/CHF, 8
HUF/EUR, 8
HUF/GBP, 8
HUF/HKD, 8
HUF/JPY, 5
HUF/SGD, 8
HUF/USD, 8
INR/AUD, 8
INR/CAD, 8
INR/CHF, 8
INR/EUR, 8
INR/GBP, 8
INR/HKD, 4
INR/JPY, 4
INR/SGD, 4
INR/USD, 8
JPY/AUD, 8
JPY/CAD, 8
JPY/CHF, 8
JPY/CNY, 8
JPY/CZK, 5
JPY/DKK, 8
JPY/EUR, 8
JPY/GBP, 8
JPY/HKD, 5
JPY/HUF, 5
JPY/INR, 4
JPY/MXN, 5
JPY/NOK, 8
JPY/NZD, 8
JPY/PLN, 8
JPY/SAR, 8
JPY/SEK, 8
JPY/SGD, 8
JPY/THB, 5
JPY/TRY, 8
JPY/TWD, 4
JPY/USD, 8
JPY/XAG, 8
JPY/XAU, 8
JPY/ZAR, 8
MXN/AUD, 5
MXN/CAD, 5
MXN/CHF, 5
MXN/EUR, 5
MXN/GBP, 5
MXN/HKD, 5
MXN/JPY, 5
MXN/SGD, 5
MXN/USD, 5
NOK/AUD, 5
NOK/CAD, 5
NOK/CHF, 5
NOK/EUR, 5
NOK/GBP, 5
NOK/HKD, 5
NOK/JPY, 3
NOK/SGD, 5
NOK/USD, 5
NZD/AUD, 5
NZD/CAD, 5
NZD/CHF, 5
NZD/EUR, 5
NZD/GBP, 5
NZD/HKD, 5
NZD/JPY, 3
NZD/SGD, 5
NZD/USD, 5
NZD/XAG, 5
NZD/XAU, 8
PLN/AUD, 5
PLN/CAD, 5
PLN/CHF, 5
PLN/EUR, 5
PLN/GBP, 5
PLN/HKD, 5
PLN/JPY, 3
PLN/SGD, 5
PLN/USD, 5
SAR/AUD, 4
SAR/CAD, 4
SAR/CHF, 4
SAR/EUR, 4
SAR/GBP, 4
SAR/HKD, 4
SAR/JPY, 2
SAR/SGD, 4
SAR/USD, 5
SEK/AUD, 5
SEK/CAD, 5
SEK/CHF, 5
SEK/EUR, 5
SEK/GBP, 5
SEK/HKD, 5
SEK/JPY, 3
SEK/SGD, 5
SEK/USD, 5
SGD/AUD, 5
SGD/CAD, 5
SGD/CHF, 5
SGD/CNY, 4
SGD/CZK, 4
SGD/DKK, 5
SGD/EUR, 5
SGD/GBP, 5
SGD/HKD, 5
SGD/HUF, 3
SGD/INR, 4
SGD/JPY, 3
SGD/MXN, 5
SGD/NOK, 5
SGD/NZD, 5
SGD/PLN, 5
SGD/SAR, 4
SGD/SEK, 5
SGD/THB, 3
SGD/TRY, 5
SGD/TWD, 4
SGD/USD, 5
SGD/XAG, 5
SGD/XAU, 8
SGD/ZAR, 4
THB/AUD, 8
THB/CAD, 8
THB/CHF, 8
THB/EUR, 8
THB/GBP, 8
THB/HKD, 8
THB/JPY, 5
THB/SGD, 8
THB/USD, 8
TRY/AUD, 5
TRY/CAD, 5
TRY/CHF, 5
TRY/EUR, 5
TRY/GBP, 5
TRY/HKD, 5
TRY/JPY, 3
TRY/SGD, 5
TRY/USD, 5
TWD/AUD, 4
TWD/CAD, 4
TWD/CHF, 4
TWD/EUR, 4
TWD/GBP, 4
TWD/HKD, 4
TWD/JPY, 4
TWD/SGD, 4
TWD/USD, 4
USD/AUD, 5
USD/CAD, 5
USD/CHF, 5
USD/CNY, 4
USD/CZK, 5
USD/DKK, 5
USD/EUR, 5
USD/GBP, 5
USD/HKD, 5
USD/HUF, 3
USD/INR, 3
USD/JPY, 3
USD/MXN, 5
USD/NOK, 5
USD/NZD, 5
USD/PLN, 5
USD/SAR, 5
USD/SEK, 5
USD/SGD, 5
USD/THB, 3
USD/TRY, 5
USD/TWD, 4
USD/XAG, 5
USD/XAU, 8
USD/XPT, 8
USD/ZAR, 5
XAG/AUD, 5
XAG/CAD, 5
XAG/CHF, 5
XAG/EUR, 5
XAG/GBP, 5
XAG/HKD, 5
XAG/JPY, 2
XAG/NZD, 5
XAG/SGD, 5
XAG/USD, 5
XAG/XAU, 8
XAU/AUD, 3
XAU/CAD, 3
XAU/CHF, 3
XAU/EUR, 3
XAU/GBP, 3
XAU/HKD, 3
XAU/JPY, 1
XAU/NZD, 3
XAU/SGD, 3
XAU/USD, 3
XAU/XAG, 3
XPT/USD, 3
ZAR/AUD, 4
ZAR/CAD, 4
ZAR/CHF, 5
ZAR/EUR, 5
ZAR/GBP, 5
ZAR/HKD, 4
ZAR/JPY, 3
ZAR/SGD, 4
ZAR/USD, 5