general

Get a statistical series

Fetch the observations of one official statistical series by the seriesId returned by find_series (e.g. "world-bank:NY.GDP.PCAP.CD?country=CHN", "bls:LNS14000000"). Returns title, units, frequency, geography and dated values. Use it whenever you need real numbers instead of remembered ones.

Discipline pack: general. Cost: 1 credit per successful call.

post/api/v1/get_series

Request

  • Base URL: https://scholarmuse.ai
  • URL: https://scholarmuse.ai/api/v1/get_series
  • Auth: HTTP bearer

Request body

series_idstring required

A seriesId from find_series, in the form "<source>:<id>" with optional "?dimension=CODE" parts.

startstring

First period to return: a year (2015) or ISO date (2015-06 or 2015-06-01).

endstring

Last period to return: a year or ISO date.

countrystring

ISO country code (CHN or CN) for per-country sources: world-bank, imf, owid, oecd, eurostat. Overrides the country in series_id.

Response

The tool result.

summarystring required
partialboolean
extraobject
credits_usednumber required
call_idstring required

Example response

{
  "billing": {
    "lowBalanceThreshold": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.