Start trial

API reference

Macro

CPI, GDP, unemployment and policy rates from statistics offices and central banks.

Macro observations

GET /v1/macro/observations

1 credit per series 2 credits with fresh=true Operation ID macro.observations

Each series' values by period with the date each was released, so a revision shows up as a later release. frequency downsamples to a coarser one, keeping only complete periods.

Query parameters

  • series array of strings Required

    Comma separated codes from /v1/macro/series, up to 100

    Up to 100 items

  • from date

    First day, YYYY-MM-DD

  • to date

    Last day, YYYY-MM-DD

  • fresh boolean

    Skip our cache and fetch from sources. Items fetched fresh cost double

  • format string

    Response format

    One of jsoncsv

    Defaults to json

  • frequency string

    Downsample to this frequency, which must not be finer than the series' own

    One of dailyweeklymonthlyquarterlyannual

Response

  • data array of objects
    Show 7 fields
    • asOf timestamp

      The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source

    • code string

      The canonical code it resolved to

    • frequency string

      The frequency served

      One of dailyweeklymonthlyquarterlyannual

    • name string
    • observations array of objects
      Show 3 fields
      • period date

        First day of the period

      • released date or null

        When this value was published, null when unknown

      • value number
    • series string

      The code as sent

    • unit string

      One of percentindexpersons

  • errors array of objects
    Show 3 fields
    • code string

      One of invalid_symbolinstrument_not_foundnot_supporteddata_unavailabledata_pendingsource_failed

    • message string
    • series string
  • meta object
    Show 2 fields
    • credits integer

      Credits this call cost

    • requestId string

Errors

400 Bad Request401 Unauthorized402 Payment Required403 Forbidden422 Unprocessable Entity429 Too Many Requests500 Internal Server Error503 Service Unavailable

Every error body is problem+json with a stable code. See errors.

Macro series

GET /v1/macro/series

Free Operation ID macro.series

Every economic series we carry, like AU.CPI.YOY or US.POLICY_RATE, with its unit, frequency and the next expected release.

Query parameters

  • country string

    ISO country code, EA for the euro area

    Matches ^[A-Za-z]{2}$

  • category string

    One of inflationgdplabourrates

  • frequency string

    One of dailyweeklymonthlyquarterlyannual

  • fresh boolean

    Skip our cache and fetch from sources. Items fetched fresh cost double

  • format string

    Response format

    One of jsoncsv

    Defaults to json

Response

  • data array of objects
    Show 10 fields
    • adjustment string

      sa is seasonally adjusted, nsa isn't

      One of sansa

    • aggregation string

      How periods combine when a coarser frequency is asked for

      One of meansumlast

    • aliases array of strings

      Other codes that resolve to this series

    • category string

      One of inflationgdplabourrates

    • code string
    • country string
    • frequency string

      One of dailyweeklymonthlyquarterlyannual

    • name string
    • nextRelease date or null

      Our estimate of the next release, null until the series has been fetched

    • unit string

      One of percentindexpersons

  • meta object
    Show 3 fields
    • credits integer

      Credits this call cost

    • nextCursor string or null

      Pass as cursor to get the next page, null on the last page

    • requestId string

Errors

400 Bad Request401 Unauthorized402 Payment Required403 Forbidden422 Unprocessable Entity429 Too Many Requests500 Internal Server Error503 Service Unavailable

Every error body is problem+json with a stable code. See errors.