README.md

TRADERMADE

This document was generated automatically. Please see README Generator for more info.

Environment Variables

Required?	Name	Description	Type	Options	Default
	API_ENDPOINT	API endpoint for tradermade	string		https://marketdata.tradermade.com/api/v1/live
✅	API_KEY	An API key that can be obtained from here	string
	WS_API_KEY	An API key that can be obtained from here	string
	WS_API_ENDPOINT	The Websocket endpoint to connect to for forex data	string		wss://marketdata.tradermade.com/feedadv
	WS_ENABLED	Whether data should be returned from websocket or not	boolean		false

---

Data Provider Rate Limits

Name	Requests/credits per second	Requests/credits per minute	Requests/credits per hour	Note
basic			1.369
professional			13.69
business			68.49
advanced			342.46
enterprise			833.33
enterprise-xl			1736.11

---

Input Parameters

Required?	Name	Description	Type	Options	Default
	endpoint	The endpoint to use	string	batch, commodities, forex, live, stock	live

Forex Endpoint

Supported names for this endpoint are: batch, forex.

Input Params

Required?	Name	Aliases	Description	Type	Options	Default	Depends On	Not Valid With
✅	base	coin, from, symbol	The symbol of symbols of the currency to query	string
✅	quote	convert, market, to	The symbol of the currency to convert to	string

Example

Request:

{
  "data": {
    "endpoint": "forex",
    "base": "ETH",
    "quote": "USD"
  }
}

---

Live Endpoint

Supported names for this endpoint are: commodities, live, stock.

Input Params

Required?	Name	Aliases	Description	Type	Options	Default	Depends On	Not Valid With
✅	base	coin, from, market, symbol	The symbol of symbols of the currency to query	string
	quote	convert, to	The symbol of the currency to convert to	string

Example

Request:

{
  "data": {
    "endpoint": "live",
    "base": "AAPL"
  }
}

Additional Examples

Request:

{
  "data": {
    "endpoint": "live",
    "base": "WTI",
    "quote": "USD"
  }
}

---

MIT License