Skip to content

Latest commit

 

History

History
110 lines (76 loc) · 4.79 KB

README.md

File metadata and controls

110 lines (76 loc) · 4.79 KB
Raw

TRADINGECONOMICS

3.0.17 v3

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

Known Issues

CACHE_MAX_AGE interaction with Heartbeat messages

If CACHE_MAX_AGE is set below a current heartbeat interval (45000ms), the extended cache TTL feature for out-of-market-hours that relies on heartbeats will not work.

Environment Variables

Required? Name Description Type Options Default
API_ENDPOINT The HTTP URL to retrieve data from string https://api.tradingeconomics.com/markets
WS_API_ENDPOINT The WS URL to retrieve data from string wss://stream.tradingeconomics.com/
✅ API_CLIENT_KEY The TradingEconomics API client key string
✅ API_CLIENT_SECRET The TradingEconomics API client secret string
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
standard 1 500 http://api.tradingeconomics.com/documentation/Limits
professional 1 800
enterprise 1 100

Input Parameters

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

Price Endpoint

Supported names for this endpoint are: crypto, forex, price.

Input Params

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

Example

Request:

{
  "data": {
    "endpoint": "price",
    "base": "EUR",
    "quote": "USD"
  }
}
Additional Examples

Request:

{
  "data": {
    "endpoint": "price",
    "base": "EURUSD:CUR",
    "quote": "USD"
  }
}

Stock Endpoint

Supported names for this endpoint are: commodities, stock.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ base asset, coin, from, symbol, ticker The stock ticker to query string

Example

Request:

{
  "data": {
    "endpoint": "stock",
    "base": "AAPL:US"
  }
}

MIT License