| Name | Type | Type | Required | Default |
|---|---|---|---|---|
| id | Series ID or Series Code to return. Accepts only one series ID or series Code. | String |
| Name | Type | Type | Required | Default |
|---|---|---|---|---|
| Accept-Language |
Preferred language code in which data shall be returned. Defaults to English if no translation in the specified language is available. Can be used through the query parameter query or using the header Accept-Language.en - Englishzh - Chineseru - Russianid - Indonesianjp - Japanese
|
String | en | |
| Accept |
Response data format. Default is application/json. Can be used through the query parameter format or using the header Accept.
|
String | json |
| Name | Type | Type | Required | Default |
|---|---|---|---|---|
| lang |
Preferred language code in which data will be returned. Defaults to English if no translation in the language specified is available. Can be used through the query parameter query or using the header Accept-Language.en - Englishzh - Chineseru - Russianid - Indonesianjp - Japanese
|
String | en | |
| format |
Response data format. Default is json. Can be used through the query parameter format or using the header Accept.
|
String | json | |
| token | Access API key. | String | ||
| with_model_information |
If set to true returns the model names as part of the response.
|
Boolean | false | |
| with_replacements_metadata |
If it is true result will contain replacements metadata not only list of ids
|
Boolean | false | |
| forecast_only |
If it is true result will only contain series with forecast
|
Boolean | false | |
| with_release_only |
If it is true result will only contain series with released schedule
|
Boolean | false | |
| with_replacements_only |
If it is true result will only contain series with suggestions
|
Boolean | false | |
| with_observations_only |
If it is true result will not contain series without observations
|
Boolean | false |
| Status Code | Type | Type |
|---|---|---|
| 200 | Series metadata. | SeriesResult |
| 400 | Incorrect input parameters. | BadRequest |
| 401 | Authorization error. | AuthorizationError |
| 403 | Incorrect user permissions. | PermissionsError |
| 404 | Requested entity not found. | NotFound |
| 415 | Unsupported data format. Only json, xml, csv are supported. | UnsupportedMedia |
| 429 | Too many requests were send or limit exceeded. | TooManyRequests |
| 500 | Internal Server Error. | InternalError |