Documentation RESTful API

Python SDK

pip install tradermade

Python users can simply install our SDK to start using our API in seconds. We recommend going through our python SDK documentation. Alternatively, you can read our tutorial on how to use our Python-SDK for Forex Data

Python SDK Example

import tradermade as tm
              
# set api key
tm.set_rest_api_key("api_key")
  
#get data
tm.live(currency='EURUSD,GBPUSD',fields=["bid", "mid", "ask"]) # returns live data - fields is optional

tm.historical(currency='EURUSD,GBPUSD', date="2021-04-22",interval="daily", fields=["open", "high", "low","close"]) # returns historical data for the currency requested interval is daily, hourly, minute - fields is optional

tm.timeseries(currency='EURUSD', start="2021-04-20",end="2021-04-22",interval="hourly",fields=["open", "high", "low","close"]) # returns timeseries data for the currency requested interval is daily, hourly, minute - fields is optional

tm.cfd_list() # gets list of all cfds available

tm.currency_list() # gets list of all currency codes available add two codes to get code for currencypair ex EUR + USD gets EURUSD

              

Supported Currencies

We support over 8000+ currency pairs on our api endpoints. This includes 4000+ cryptocurrency pairs. A list of Forex and Crypto codes for live endpoint can be accessed by visting our live currencies list page. We also have CFDs, Visit CFD list page for codes. You can also see below the full CFD list we provide:

Live Currencies List

A list of the available currencies for the /live and the /convert endpoint, can be accessed through requesting the live_currencies_list endpoint. In order to request currency data, add the currencies codes together to form a currency pair. For example EURUSD can be requested by adding EUR and USD together. In order to get the inverse of the same pair, simply reverse the quote to USDEUR. To access JSON object containing all available currency codes verus USD, Simply append your api_key to the TraderMade exchange rates API apicurrencies endpoint.

Request URL  CopySign Up

https://marketdata.tradermade.com/api/v1/live_currencies_list?api_key=api_key 

Response JSON

{
  "available_currencies": {
      "AED":"UAE Dirham",
      "ARS":"Argentine Peso",
      "AUD":"Australian Dollar",
      "BHD":"Bahraini Dinar",
      "BRL":"Brazilian Real",
      "CAD":"Canadian Dollar",
      "CHF":"Swiss Franc",
      "CLP":"Chilean Peso",
      "CNY":"Chinese Yuan",
      "COP":"Colombian Peso",
      "CZK":"Czech Koruna",
      "DKK":"Danish Krone",
      "EUR":"Euro",
      "GBP":"British Pound Sterling",
      "HKD":"Hong Kong Dollar",
      "HRK":"Croatian Kuna",
      "HUF":"Hungarian Forint",
      "IDR":"Indonesian Rupiah",
      "ILS":"Israeli New Sheqel",
      "INR":"Indian Rupee",
      "ISK":"Icelandic Krona",
      "JPY":"Japanese Yen",
      "KRW":"South Korean Won",
      "KWD":"Kuwaiti Dinar",
      "MAD":"Moroccan Dirham",
      "MXN":"Mexican Peso",
      "MYR":"Malaysian Ringgit",
      "NGN":"Nigerean Naira",
      "NOK":"Norwegian Krone",
      "NZD":"New Zealand Dollar",
      "OMR":"Omani Rial",
      "PEN":"Peruvian Nuevo Sol",
      "PHP":"Philippine Peso",
      "PLN":"Polish Zloty",
      "RON":"Romanian Leu",
      "RUB":"Russian Ruble",
      "SEK":"Swedish Krona",
      "SGD":"Singapore Dollar",
      "THB":"Thai Baht",
      "TRY":"Turkish Lira",
      "TWD":"Taiwanese Dollar",
      "USD":"US Dollar",
      "VND":"Vietnamese Dong",
      "ZAR":"South African Rand"
  },
  "endpoint": "live_currencies"
}

Live Crypto List

We offer data for 4000+ cryptocurrency pairs. A list of Forex and Crypto codes for live endpoint can be accessed by visting our live currencies list page. A list of the available cryptocurrencies for the /live endpoint, can be accessed through requesting the live_cypto_list endpoint. In order to request currency data, add the currencies codes together to form a currency pair. For example DOGEUSD can be requested by adding DOGE and USD together. In order to get the inverse of the same pair, simply reverse the quote to USDDOGE. To access JSON object containing all available crypto codes verus USD, Simply append your api_key to the TraderMade live crypto API endpoint.

Request URL  CopySign Up

https://marketdata.tradermade.com/api/v1/live_crypto_list?api_key=api_key 

Response JSON

{
  "available_currencies": {
    "ADA": "Cardano", 
    "ATOM": "Atom", 
    "AVAX": "Avalanche", 
    "AXS": "Axis infinity", 
    "BCH": "Bitcoin Cash", 
    "BNB": "Binance Coin", 
    "BTC": "Bitcoin", 
    "BTG": "Bitcoin Gold", 
    "BUSD": "Binance USD", 
    "DAI": "DAI", 
    "DASH": "Dashcoin", 
    "DOGE": "DogeCoin", 
    "DOT": "Polkadot", 
    "EGLD": "Elrond Egold", 
    "ENJ": "ENJ", 
    "EOS": "EOS Platform", 
    "ETC": "Ethereum Classic", 
    "ETH": "Ethereum", 
    "FIL": "Filecoin", 
    "FLOW": "Flow", 
    "FTM": "Fantom USD", 
    "FTT": "FTX Token", 
    "GALA": "Gala", 
    "HBAR": "Hbar", 
    "HNT": "Helium", 
    "ICP": "Internet Computer Price ", 
    "LINK": "Chainlink", 
    "LRC": "Loopring", 
    "LTC": "Litecoin", 
    "LUNA": "Luna", 
    "MANA": "Decentraland", 
    "MATIC": "Matic", 
    "NEAR": "Near", 
    "NEO": "NEO", 
    "ROSE": "Rose", 
    "SAND": "Sandbox", 
    "SHIB": "Shiba inu", 
    "SOL": "Solana", 
    "THETA": "Theta", 
    "TRX": "Tron", 
    "UNI": "Uniswap", 
    "USDT": "Tether", 
    "UST": "Terra USD", 
    "VET": "Vechain", 
    "XLM": "Stellar", 
    "XMR": "Monero", 
    "XRP": "Ripple", 
    "XTZ": "Tezos"
  }, 
  "endpoint": "live_crypto"
}

Historical Currencies List

We support over 1600 currency pairs on our historical data endpoints A list of the available currencies for the historical, pandasDF, timeseries,, and the minute_historical endpoints, can be accessed through requesting the historical_currencies_list endpoint or visiting list of historical exchange rates page. Below example is an abbreviated version.

Request URL  CopySign Up

https://marketdata.tradermade.com/api/v1/historical_currencies_list?api_key=api_key 

Response JSON

{
  "available_currencies": [
    "AEDEUR", 
    ....
    "EURPHP", 
    "EURPLN", 
    "EURRON", 
    "EURRUB", 
    "EURSEK", 
    "EURSGD", 
    "EURTHB", 
    "EURTRY", 
    "EURTWD", 
    "EURUSD", 
    "EURXAG", 
    "EURXAU", 
    "EURZAR", 
    "GBPAED", 
    "GBPAUD", 
    "GBPBRL", 
    "GBPCAD", 
    "GBPCHF", 
    "GBPCZK", 
    "GBPDKK", 
    "GBPEUR", 
    "GBPHKD", 
    "GBPHUF", 
    "GBPINR", 
    "GBPJPY", 
    "GBPKRW", 
    "GBPMXN", 
    "GBPMYR", 
    "GBPNOK", 
    "GBPNZD", 
    .... 
    "ZARUSD"
  ], 
  "endpoint": "historical_currencies"
}

Error Codes

Below are the error codes and responses for all the api endpoints.

Request parameters:

400 Response JSON

// 400 will return error which includes the details of the error   
{
    "errors": {
        "date": "YYYY-MM-DD time data '2019-10-' does not match format '%Y-%m-%d'"
    },
    "message": "Input payload validation failed"
}
                 

Live Rates

Historical Rates

The historical endpoint provides daily exchange rate data for the available currency pairs. Our daily bars are 22/22 as is the norm in financial markets. The daily bar finishes at and starts from 22:00 GMT. Our API lets you query any trading day over the past 20+ years (for some exotic currency pairs history may be less). The trading week starts from 22:00 hours on a Sunday and if date is requested for Saturday or Sunday Friday date is returned.

Tick Historical Rates

The Tick historical endpoint provides tick FX rate data for 50+ currency pairs. You can visit full currencies list page for complete list of codes. Historical Tick provides one month of data with each chunk not exceeding 60 minutes. This is only available on Advanced plan and uses 5 API request each time and only can be requested one currency pair per request.

You can't access tick historical without advanced plan but you can request a sample tick (shown below) which will get you to tick data going back 4 working days not including today. A maximum chunk of tick data in one request is 30 minutes and will take 5 requests away. You can only request one currency pair per request.

Minute Historical Rates

The API lets you query historical data for any minute for the past 30-years. You can only request one currency pair and one minute of data in one single request.

Hour Historical Rates

The API provides historical rates (ohlc) for the given hour over the past two-years

Timeseries

Time series api provides historical currency rates (OHLC) for daily, hourly and granular endpoints. Daily timeseries data is available for upto 15-year (for some exotic currency pairs history may be less) but max request is one-year per request. Hourly data for up to 12-month (max one month data per request) and minute interval data for upto one month (max 2 days data per call). For example, if you are requesting 15 minute data on Friday you can only request start date from Thursday 00:00 GMT (in one call). Only one currency pair can be requested at a time.

History - daily - fifteen years | hourly - 12 months | minute - 1 Month

Pandas Data Frame

PandasDF api endpoint provides daily OHLC data for the currency requested in a pandas Data Frame that makes it really easy for python developers to use historical currency data. Request single currency when field parameter is "ohlc". Can request multiple currency when field is "close". Data is available for upto 15-year (for some exotic currency pairs history may be less) but max request is one-year per request.

Convert

The API provides conversion from one currency to another in real-time.

Market Open Status

The API provides status of market open and close. When market is open the next_close provides a datetime string and next_open is an empty string. When market is close next_close is an empty string and next_open provides a datetime string.

PHP (CURL)

Python

R

Go

C#

JavaScript (axios)

Below is an example for historical exchange rates data using JavaScript, Axios and NodeJS:

For further explanation See our tutorials on Get live forex data and parse REST JSON API with JavaScript, Axios and NodeJS

JavaScript (axios)  Copy

const axios = require('axios');

axios.get('https://marketdata.tradermade.com/api/v1/live?currency=EURUSD,GBPUSD,UK100&api_key=api_key')
  .then(response => {

    console.log(response.data);

    console.log(response.data.quotes[1]);
  })
  .catch(error => {
    console.log(error);
  });

JavaScript (fetch)

Below is an example for historical exchange rates data using jQuery:

JavaScript (fetch)  Copy

var requestOptions = {
method : 'GET',
redirect : 'follow'
};

fetch( 'https://marketdata.tradermade.com/api/v1/historical?currency=EURUSD%2CGBPUSD&date=2019-10-09&api_key=api_key', requestOptions)
.then(response => response.text())
.then(result =>  console.log(result))
.catch(error =>  console.log( 'error', error));

JavaScript (jQuery)

Below is an example for historical exchange rates data using jQuery:

JavaScript (jQuery)  Copy

var settings = {
"url": "https://marketdata.tradermade.com/api/v1/historical?currency=EURUSD%2CGBPUSD&date=2019-10-09&api_key=api_key",
"method": "GET",
"timeout": 0,
};

$.ajax(settings).done(function (response) {
console.log(response);
});