Respond a list of series found by IDs, belonging potentially to different providers and datasets.

get/series

Request

Query parameters

series_idsstring[] required

List of series IDs separated by commas. A series ID is formatted like provider_code/dataset_code/series_code. Series can belong to any provider and dataset.

[
  "AMECO/ZUTN/EA19.1.0.0.0.ZUTN"
]
facetsboolean

Return facets in response.

observationsboolean

Return observations for each series of the response.

metadataboolean

Return providers and datasets metadata in response.

format'csv' | 'json' | 'xlsx'

Format of the output. If using csv and response includes series of different frequencies, many CSV files will be produced, one per frequency, wrapped in a single ZIP file. Implies observations=1 automatically.

align_periodsboolean

Ensure that all the periods of each series are defined in every other series. Add NA (not available) values when needed. Must be used with parameter observations=1.

limitinteger

The numbers of items to return.

offsetinteger

The number of items to skip before starting to collect the result set.

Response

A list of series

datasetsobject required
providersobject required

Example response

{
  "_meta": {
    "version": "0.22.0"
  },
  "errors": [
    {
      "message": "Could not produce any series"
    }
  ],
  "series": {
    "docs": [
      {
        "dataset_code": "ZUTN",
        "provider_code": "AMECO",
        "series_code": "AUT.1.0.0.0.ZUTN"
      }
    ],
    "limit": 100,
    "num_found": 65
  }
}

Changes

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