/tradingeconomics/indicators

POST /api/tradingeconomics/indicators

Price: 10 credits

Get an economic indicator for a country by country and indicator slug

How to use it

Get a single economic indicator for a country (e.g. United States unemployment rate, Germany inflation). Returns the latest value, previous value, all-time high and low, unit, frequency, observation date range, a plain-language summary, the indicator definition, related and component indicators, and the recent release calendar (actual / previous / consensus / forecast). Identify the indicator by its country and indicator slug as they appear in the page URL.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string required — Country slug as used in the page URL (examples: "united-states", "germany", "japan"; minLength: 1)
• indicator string required — Indicator slug as used in the page URL (examples: "unemployment-rate", "inflation-cpi", "gdp-growth"; minLength: 1)

Response

• @type string (default: "TradingEconomicsIndicator")
• country string required
• indicator string required
• name string nullable
• symbol string nullable
• category string nullable
• description string nullable
• last number nullable
• previous number nullable
• highest number nullable
• lowest number nullable
• unit string nullable
• frequency string nullable
• date_range string nullable
• summary string nullable
• image string nullable
• url string nullable
• components array (default: [])
  • @type string (default: "TradingEconomicsIndicatorPeer")
  • name string required
  • indicator string nullable
  • country string nullable
  • last number nullable
  • previous number nullable
  • unit string nullable
  • reference string nullable
• related array (default: [])
  • @type string (default: "TradingEconomicsIndicatorPeer")
  • name string required
  • indicator string nullable
  • country string nullable
  • last number nullable
  • previous number nullable
  • unit string nullable
  • reference string nullable
• releases array (default: [])
  • @type string (default: "TradingEconomicsCalendarRelease")
  • date string nullable
  • time string nullable
  • reference string nullable
  • actual number nullable
  • previous number nullable
  • consensus number nullable
  • forecast number nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Indicator not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.