Data retrieval is performed via simple RESTful HTTP GET.
URL Part Description (see table below for more information of each):
Parameters are passed in the form of
All request should the following Base Url, with a combination of the parameters in the Table below.
Not every parameters 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 implied.
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.http://fxf.forexfeed.net/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.http://fxf.forexfeed.net/intervals/YOUR_KEY Example 3: Get a Currency Conversion
The following example URL retrieves a live Currency Conversion using the latest market pricing. This convertion request converts 999 EUR to USD.http://fxf.forexfeed.net/convert/999/EUR/USD/YOUR_KEY
URL Part Description (see table below for more information of each):
http://fxf.forexfeed.net/convert/CONVERT_VALUE/CONVERT_FROM/CONVERT_TO/YOUR_KEY 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:http://fxf.forexfeed.net/data?key=YOUR_KEY&interval=300&symbol=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)http://fxf.forexfeed.net/data?key=YOUR_KEY&periods=24&format=xml&interval=3600&symbol=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)http://fxf.forexfeed.net/data?key=YOUR_KEY&periods=30&format=csv&interval=86400&symbol=EURUSD,XAUUSD Advanced Usage
The table below describes various data retrieval parameters and their purpose.
Parameters are passed in the form of
param=value (standard HTTP "Query String" format). All request should the following Base Url, with a combination of the parameters in the Table below.
http://fxf.forexfeed.net/?key=YOUR_KEY&get=data& ...(additional parameters) Not every parameters 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 implied.
| Variable name | Default value | Allowed values | Description |
|---|---|---|---|
| key | - | YOUR_ACCESS_KEY | Your Unique Access key |
| get | data | data, symbols, intervals, conversion | data = Normal data request (OHLC or TBT) symbols = Get a list of Symbols available to you intervals = Get a list of Intervals available to you conversion = Get a currency Conversion, See convert_value, convert_from and convert_to |
| format | csv | csv, xml, nst |
csv = Comma Separated Values xml = Extensible Markup Language nst = A CSV format compatible with Neuroshell Trader |
| symbol | EURUSD | AUDCAD, AUDCHF, AUDEUR, AUDGBP, AUDJPY, AUDNZD, AUDSGD, AUDUSD, AUDXAG, AUDXAU, CADAUD, CADCHF, CADEUR, CADGBP, CADJPY, CADNZD, CADSGD, CADUSD, CADXAG, CADXAU, CHFAUD, CHFCAD, CHFEUR, CHFGBP, CHFJPY, CHFNZD, CHFSGD, CHFUSD, CHFXAG, CHFXAU, CZKEUR, CZKUSD, DKKEUR, DKKUSD, EURAUD, EURCAD, EURCHF, EURCZK, EURDKK, EURGBP, EURHUF, EURJPY, EURNOK, EURNZD, EURPLN, EURSEK, EURSGD, EURUSD, EURXAG, EURXAU, GBPAUD, GBPCAD, GBPCHF, GBPEUR, GBPJPY, GBPNZD, GBPSGD, GBPUSD, GBPXAG, GBPXAU, HKDUSD, HKDXAG, HKDXAU, HUFEUR, HUFUSD, JPYAUD, JPYCAD, JPYCHF, JPYEUR, JPYGBP, JPYNZD, JPYSGD, JPYUSD, JPYXAG, JPYXAU, MXNUSD, NOKEUR, NOKUSD, NZDAUD, NZDCAD, NZDCHF, NZDEUR, NZDGBP, NZDJPY, NZDSGD, NZDUSD, PLNEUR, PLNUSD, SARUSD, SEKEUR, SEKUSD, SGDAUD, SGDCAD, SGDCHF, SGDEUR, SGDGBP, SGDJPY, SGDNZD, SGDUSD, SGDXAG, SGDXAU, THBUSD, USDAUD, USDCAD, USDCHF, USDCZK, USDDKK, USDEUR, USDGBP, USDHKD, USDHUF, USDJPY, USDMXN, USDNOK, USDNZD, USDPLN, USDSAR, USDSEK, USDSGD, USDTHB, USDXAG, USDXAU, USDZAR, XAGAUD, XAGCAD, XAGCHF, XAGEUR, XAGGBP, XAGHKD, XAGJPY, XAGSGD, XAGUSD, XAUAUD, XAUCAD, XAUCHF, XAUEUR, XAUGBP, XAUHKD, XAUJPY, XAUSGD, XAUUSD, ZARUSD, | One or more currency symbols (separated by a comma) |
| interval | 3600 | 1, 5, 10, 30, 45, 60, 300, 600, 900, 1200, 1800, 2700, 3600, 7200, 10800, 14400, 21600, 43200, 86400, 604800, 2628000 |
1 = Tick data (for Bid/Ask or Mid quotes) 5 = 5 Second data (OHLC) 10 = 10 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) |
| periods | 1 | 1~ | The number of previous 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 |
| price | mid | mid bid ask bid,ask |
OHLC options: mid, bid, or ask Tick options: mid or bid,ask |
| separator | comma (,) | User defined | This parameter allows you to change the default column separator - for use with CSV data format only |
| line_end | LF | LF CRLF CR |
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) |
| date_format | Epoch timestamp | epoch or mmddyyyyhhmm | epoch = seconds since Jan, 1 1970 mmddyyyyhhmm = MM/DD/YYYY HH:MM All date are in UTC / GMT time |
| convert_value | none | Monetary | The monetary value in the convert_from currency. The return value will be the equivalent in convert_to See: get, convert_from and convert_to |
| convert_from | none | ISO code | The 3-letter ISO code of the currency to be converted From |
| convert_to | none | ISO code | The 3-letter ISO code of the currency to be converted To |