List of indicators for specific classification . DEPRECATED. Returns full list of indicators for specific classification. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
IndicatorsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Classification ID. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Classifications list . DEPRECATED. Returns full list of supported top level classifications and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
ClassificationsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
DEPRECATED. Please use `/dictionary/geo`. Countries list . DEPRECATED. Please use `/dictionary/geo`. Returns full list of supported countries and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
CountriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
List of sources for a specific country . Returns full list of sources for a specific country. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
SourcesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Country ISO code (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Full dictionary list . Returns all the available dictionaries. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
DictionaryResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Frequencies list . Returns full list of supported frequencies and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
FrequenciesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Geo list . Returns full list of geo entities and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
GeoResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Indicators list . Returns full list of supported indicators, their codes and the related top level classifications. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
IndicatorsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
DEPRECATED. Please use `/layout/databases`. Database layouts list . DEPRECATED. Please use `/layout/databases`. Returns full list of supported databases and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
LayoutsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Regions list . Returns full list of supported regions and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
RegionsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Release schedule statuses list . Returns full list of supported releases schedule statuses. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
ReleaseStatusesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Release schedule types list . Returns full list of supported releases schedule types. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
ReleaseTypesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Sources list . Returns full list of supported sources and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
SourcesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Statuses list . Returns full list of supported statuses and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
StatusesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Units list . Returns full list of supported units and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
UnitsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Cancel dump . Cancel a running dump . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
DumpResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Dump ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Create dump . Create data dump. The allowed dumps in parallel are 2 dumps per user created dumps and only 1 full dump. If the dump filter contains search parameters, then it must also contain exactly one database. If the filter contains only a list of series ids, then selecting a database is not required. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
DumpResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
filter_id | str | Filter ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
name | str | Name of the new record. Max length 100 |
description | str | Description of the new record. Max length 1000 |
consolidation | str | Consolidation Method |
delivery | str | Delivery Method |
user_ftp_url | str | Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port |
user_ftp_path | str | Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. |
user_ftp_username | str | Username for the local FTP server. Only valid when the localftp delivery method is selected. |
user_ftp_password | str | Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. |
notification_email | str | When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. |
notification_url | str | URL for push notification upon dump completion. |
notification_http_method | str | HTTP Method for push notifications. |
Get dump . Get generated dump or information about process of generation . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
DumpResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Dump ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
List dumps . List user dumps . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
DumpListResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
created_after | date | Will return entries created after `created_after` date |
created_before | date | Will return entries created after `created_before` date |
filter_id | str | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
created_order | str | Choose whether to order the entries ascending or descending. Default is Ascending |
status | list[str] | Dump status |
feed_id | str | Feed ID |
Subscribe for a feed . Creates a request for a feed subscription. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
FeedResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
filter_id | str | Filter ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
name | str | Name of the new record. Max length 100 |
description | str | Description of the new record. Max length 1000 |
consolidation | str | Consolidation Method |
delivery | str | Delivery Method |
user_ftp_url | str | Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port |
user_ftp_path | str | Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. |
user_ftp_username | str | Username for the local FTP server. Only valid when the localftp delivery method is selected. |
user_ftp_password | str | Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. |
notification_email | str | When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. |
notification_url | str | URL for push notification upon dump completion. |
notification_http_method | str | HTTP Method for push notifications. |
frequency | int | Feed generation frequency |
full_dump | bool | When set to true, the feed will always generate full list of time points. This option is only available for lists that are equal or less than 3,000 series. |
Delete feed . Delete feed . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
FeedInformation If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Feed ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Get feed . Get a single data feed record . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
FeedInformation If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Feed ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
List all feed subscriptions . List all feed subscriptions the user have set. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
FeedsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
created_after | date | Will return entries created after `created_after` date |
created_before | date | Will return entries created after `created_before` date |
filter_id | str | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
created_order | str | Choose whether to order the entries ascending or descending. Default is Ascending |
status | list[str] | Feed status |
Update feed . Update an already existing feed. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
FeedInformation If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Feed ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
name | str | Name of the new record. Max length 100 |
description | str | Description of the new record. Max length 1000 |
consolidation | str | Consolidation Method |
delivery | str | Delivery Method |
user_ftp_url | str | Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port |
user_ftp_path | str | Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. |
user_ftp_username | str | Username for the local FTP server. Only valid when the localftp delivery method is selected. |
user_ftp_password | str | Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. |
notification_email | str | When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. |
notification_url | str | URL for push notification upon dump completion. |
notification_http_method | str | HTTP Method for push notifications. |
frequency | int | Feed generation frequency |
full_dump | bool | When set to true, the feed will always generate full list of time points. This option is only available for lists that are equal or less than 3,000 series. |
status | str | Feed status |
filter_id | str | Filter ID |
Create a filter . Creates a series filter. A filter may contain both, an exact list of series and search criterion. The resulted set is a union of both. Filters can be used with /series/search, /dumps and /feeds functions. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
FilterResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
series | list[str] | List of series, comma separated. Its length cannot be more than 100000. |
name | str | Name of the new record. Max length 100 |
description | str | Description of the new record. Max length 1000 |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
topic | list[str] | Topic filter. One or more comma separated topic code values. |
section | list[str] | Section filter. One or more comma separated section code values. |
table | list[str] | Table filter. One or more comma separated table code values. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
data_source | list[str] | Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series |
order | list[str] | Sort order. Default is `relevance`. |
database | list[str] | Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* |
direction | list[str] | Sort order direction. Default is `asc`. Accepted values |
Delete filters . Delete list of filters . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
EmptyObject If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Filter ID. Accepts one or more comma separated values. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Get filter details . Get information about one or more filters . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
FiltersResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Filter ID. Accepts one or more comma separated values. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Get user filters . Returns list of user created filters . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
FiltersResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Update filter details . Update search, series and metadata information for a specific filter . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
FilterResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | A single Filter ID value (required) |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
series | list[str] | List of series, comma separated. Its length cannot be more than 100000. |
name | str | Name of the new record. Max length 100 |
description | str | Description of the new record. Max length 1000 |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
topic | list[str] | Topic filter. One or more comma separated topic code values. |
section | list[str] | Section filter. One or more comma separated section code values. |
table | list[str] | Table filter. One or more comma separated table code values. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
data_source | list[str] | Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series |
order | list[str] | Sort order. Default is `relevance`. |
database | list[str] | Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* |
direction | list[str] | Sort order direction. Default is `asc`. Accepted values |
Request a downloadable insight report . Returns one or more links to the insight report. When the report generation takes too much time to complete in a timely manner, returns HTTP 408. In this case the request have to be repeated after a minute. Once the report is generated, consecutive requests are returned immediately. Each successful response returns one or more download links that expires in 5 minutes. The client application consuming the API shall download the file within this period or send additional request to the API. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
InsightDownloadResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Insight ID (required) |
file_format | str | Insight report file format. Available formats |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
ignore_cache | bool | New file will be generated |
adjust_columns | str | No adjust or wrap text in XLSX cell |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
blank_observations | str | If set to true, will return empty time-points which oterwise are omitted. |
orientation | str | Columns/rows orientation |
order | str | Sort order - Asc/Desc |
decimal_places | float | Decimal places for the time-points values |
date_format | str | Time-points date format |
Insight gallery categories . Returns list of gallery categories. To be used with group filters \"analytics\" and \"gallery\". . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
InsightsCategoriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Insights details . Returns information about a specified insight. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
InsightsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Insight ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
List of all series for a particular insight . Returns all series from the specified insight(s), including all time-points and metadata, as well as their layout in the insight context in terms of grouping and separators. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
InsightSeriesPaginatedResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Insight ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
updated_after | datetime | Returns only the updated time-points after the date specified. |
blank_observations | bool | If it's set to true, empty time-points will be returned |
time_points_status | str | Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
List of all series time-points for a particular insight . Returns all series time-points from the specified insight series. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
InsightSeriesPaginatedResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Insight ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
updated_after | datetime | Returns only the updated time-points after the date specified. |
blank_observations | bool | If it's set to true, empty time-points will be returned |
time_points_status | str | Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
List of series based on their insight series ID . Returns full series data, based on their insight ID. It can include any formulas or transformations applied to the data, or changes to the metadata (ex. title) as part of the insight context. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
InsightSeriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
series_id | str | Insight Series ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
updated_after | datetime | Returns only the updated time-points after the date specified. |
blank_observations | bool | If it's set to true, empty time-points will be returned |
time_points_status | str | Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
List of series time-points based on their insight series ID . Returns series time-points data, based on their insight ID. It can include any formulas or transformations applied to the data as part of the insight context. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
InsightSeriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
series_id | str | Insight Series ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
updated_after | datetime | Returns only the updated time-points after the date specified. |
blank_observations | bool | If it's set to true, empty time-points will be returned |
time_points_status | str | Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted |
List of series metadata based on their insight series ID . Returns series metadata, based on their insight ID. It can include changes to the metadata (ex. title) as part of the insight context. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
InsightSeriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
series_id | str | Insight Series ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
List of all series metadata for a particular insight . Returns all series metadata from the specified insight(s), as well as their layout in the insight context in terms of grouping and separators. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
InsightSeriesPaginatedResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Insight ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
List of User Created Insights . Returns full list of CDMNext user created insights . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
InsightsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Insight categories . Returns list of insight categories. To be used wtih group filters \"favorite\", \"my\", \"shared\", \"recent\", all\". . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
InsightsCategoriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Insights search . Search for insights. Those could be user created, shared, or CEIC created ones. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
InsightsSearchResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
group | str | Insights group. Default is `my`. |
limit | float | Number of records to return |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
order | object | Sort order |
direction | object | Sort order direction |
tags | list[str] | List of insight tags to search by tag |
categories | list[str] | List of insights categories to search by category |
Returns list of internal remarks . Returns list of internal remarks . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
SeriesInternalRemarksResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
List of databases . Returns list of layout databases. This is the top level from the layout hierarchy. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
LayoutItemsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
Returns footnote of a node . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
str If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
node_code | str | Node Code - Database ID, Topic ID, Section ID or Table ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
Returns footnote metadata for a node . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
LayoutFootnoteMetadataResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
node_code | str | Node Code - Database ID, Topic ID, Section ID or Table ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Returns footnote resource file . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
str If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
node_code | str | Node Code - Database ID, Topic ID, Section ID or Table ID (required) |
file_name | str | Resource file name (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
Metadata including list of ancestors for node of particular type (table) and code. . Returns metadata about the specified node id. List of node ancestors is included in the respnose. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
LayoutFullMetadataResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Node ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Metadata including list of ancestors for node of particular type (section) and code. . Returns metadata about the specified node id. List of node ancestors is included in the respnose. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
LayoutFullMetadataResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Node ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Metadata including list of ancestors for node of particular type (topic) and code. . Returns metadata about the specified node id. List of node ancestors is included in the respnose. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
LayoutFullMetadataResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Node ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
List of Sections . Returns list of sections for a selected topic . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
LayoutItemsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Topic ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
List of Series . Returns list of series inside of a table . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
SeriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Table ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
List of Tables . Returns list of tables for a selected section . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
LayoutItemsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Section ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
List of Topics . Returns list of topics for a selected database . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
LayoutItemsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Database ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
List release code series. . Lists the series for a specific release identifier code. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
ReleaseSeriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
code | str | Release identifier code for a group of series with the same release schedule. Accepts only one release identifier code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
List of releases for a single series id . Lists the release schedule for a single series id . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
SeriesReleaseScheduleSearchResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
release_date_from | date | Will return releases with first observation before `release_date_from` |
release_date_to | date | Will return releases with last observation after `release_date_to` |
release_status | list[str] | List of release statuses to return |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
Released schedule search . Allows searching for series' release schedule by a keyword and additional filtering criteria. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
SeriesReleaseScheduleSearchResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
layout | list[str] | **DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* |
database | list[str] | Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
data_source | list[str] | Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series |
series | list[str] | List of series |
topic | list[str] | Topic filter. One or more comma separated topic code values. |
section | list[str] | Section filter. One or more comma separated section code values. |
table | list[str] | Table filter. One or more comma separated table code values. |
order | list[str] | Sort order. Default is `relevance`. |
direction | list[str] | Sort order direction. Default is `asc`. Accepted values |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
facet | list[str] | List of facets to return |
release_date_from | date | Will return releases with first observation before `release_date_from` |
release_date_to | date | Will return releases with last observation after `release_date_to` |
release_status | list[str] | List of release statuses to return |
Returns continuous series information . The method extends the history and fill gaps of active series by combining older and newer counterparts of comparable time series to generate a longer series. Depending on the dataset, data history is extended, and gaps are filled using a combination of geometric compounding and/or filling the missing time points with the comparable older/newer series. CEIC calculates geometric compounding by using the ratio of the first observation of the newer series and the corresponding overlapping time point from the older series, subsequently adjusting observations from the older series using this ratio (i.e., the linking factor). Series estimated using geometric compounding are rounded, if applicable. The method returns function description, chain_id and series IDs in the historical extension. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
ContinuousSeriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Returns continuous series timepoints information . The method extends the history and fill gaps of active series by combining older and newer counterparts of comparable time series to generate a longer series. Depending on the dataset, data history is extended, and gaps are filled using a combination of geometric compounding and/or filling the missing time points with the comparable older/newer series. CEIC calculates geometric compounding by using the ratio of the first observation of the newer series and the corresponding overlapping time point from the older series, subsequently adjusting observations from the older series using this ratio (i.e., the linking factor). Series estimated using geometric compounding are rounded, if applicable. The method returns continuous series timepoints with applied functions. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
ContinuousSeriesWithAppliedFunctionsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
chain_id | str | The ID of the chain. Accepts only one ID. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Returns full series data . Returns series containing both metadata and time-points data. Accepts one or more Series IDs or Series Codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
SeriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
updated_after | datetime | Returns only the updated time-points after the date specified. |
blank_observations | bool | If it's set to true, empty time-points will be returned |
time_points_status | str | Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
with_historical_extension | bool | When set to true, series will include extended historical timepoints |
Returns list of metadata items . Returns series containing metadata only. Accepts one or more Series IDs or Series Codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
SeriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
Returns list of items' statistics . Returns series containing statistics only. Accepts one or more Series IDs or Series Codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
SeriesStatisticsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Returns series time-points . Returns series containing time-points data only. Accepts one or more Series IDs or Series Codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
SeriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
updated_after | datetime | Returns only the updated time-points after the date specified. |
blank_observations | bool | If it's set to true, empty time-points will be returned |
time_points_status | str | Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted |
with_historical_extension | bool | When set to true, series will include extended historical timepoints |
Returns visual image . Returns some chart/map/table image . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
str If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept | str | Response data format. Default is `image/png`. |
format | str | Response data format. Default is `png` |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
token | str | Access API key. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
width | float | Image width |
height | float | Image height |
period | float | Series time-pints mask. Example |
type | str | Visual type |
Series search . Allows searching for series by a keyword and additional filtering criteria. Each filtering criteria accepts one or more, comma separated code values. See Dictionary functions for details on how to retrieve a specific filter code. The multi-dimensional filters include the economic classification and indicators (defined by CEIC database structure), region/country, frequency, unit, source, status and observation date. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
SearchSeriesResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
layout | list[str] | **DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* |
database | list[str] | Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
data_source | list[str] | Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series |
series | list[str] | List of series |
topic | list[str] | Topic filter. One or more comma separated topic code values. |
section | list[str] | Section filter. One or more comma separated section code values. |
table | list[str] | Table filter. One or more comma separated table code values. |
order | list[str] | Sort order. Default is `relevance`. |
direction | list[str] | Sort order direction. Default is `asc`. Accepted values |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
facet | list[str] | List of facets to return |
Generate impersonate token . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
ImpersonateAPIKeyResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
employee_token | str | Impersonate API token generated on CAS service (required) |
user_id | str | User Id (required) |
application | str | Application ID (required) |
expire_after | float | Token will be expired after `expire_after` in seconds |
Get user subscriptions . Get user subscriptions . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
UserSubscriptionsResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Authenticates the user, creating a new session. . Used by certain applications only. Instead of using sessions, use an API key passing it as a `token` query parameter or `Authorization` header. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
UserSessionResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
login | str | Username (required) |
password | str | Password (required) |
application | str | Application ID (required) |
application_version | str | Application Version |
Close existing API session. . Not needed when API key is used. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
SessionStatusResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
session | str | User session (required) |
Check if user's login/password are valid . Check if user's login/password are valid . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
UserCredentialsValidationResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
login | str | Username (required) |
password | str | Password (required) |
Create Watchlist . Create watchlist subscription . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
WatchlistProcessedResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
series_id | str | Watchlist Series IDs, comma separated (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
popup_notifications | bool | If set to true enables popup notifications for watchlist subscription |
email_notifications | str | If set, specifies the email notification frequency |
Delete watchlist . Removes provided series from watchlist subscription . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
WatchlistProcessedResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Watchlist Series IDs, comma separated (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Lists all watchlist subscriptions . Lists all watchlist subscriptions the user have set. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
WatchlistGetResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
Update watchlist . Update watchlist subscription details . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
WatchlistProcessedResult If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Watchlist Series IDs, comma separated (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
popup_notifications | bool | If set to true enables popup notifications for watchlist subscription |
email_notifications | str | If set, specifies the email notification frequency |
dictionary_classifications_id_indicators_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Classification ID. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
dictionary_classifications_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
dictionary_countries_id_sources_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Country ISO code (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
dictionary_countries_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
dictionary_frequencies_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
dictionary_indicators_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
dictionary_layouts_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
dictionary_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
dictionary_regions_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
dictionary_sources_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
dictionary_statuses_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
dictionary_units_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
dumps_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Dump ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
dumps_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
feeds_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Feed ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
feeds_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
filters_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Filter ID. Accepts one or more comma separated values. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
filters_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
impersonate_token_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
employee_token | str | Impersonate API token generated on CAS service (required) |
user_id | str | User Id (required) |
application | str | Application ID (required) |
expire_after | float | Token will be expired after `expire_after` in seconds |
insights_categories_emis_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
insights_categories_focus_economics_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
insights_categories_gallery_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
insights_categories_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
insights_id_download_file_format_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Insight ID (required) |
file_format | str | Insight report file format. Available formats |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
ignore_cache | bool | New file will be generated |
adjust_columns | str | No adjust or wrap text in XLSX cell |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
blank_observations | str | If set to true, will return empty time-points which oterwise are omitted. |
orientation | str | Columns/rows orientation |
order | str | Sort order - Asc/Desc |
decimal_places | float | Decimal places for the time-points values |
date_format | str | Time-points date format |
insights_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Insight ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
insights_id_series_data_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Insight ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
updated_after | datetime | Returns only the updated time-points after the date specified. |
blank_observations | bool | If it's set to true, empty time-points will be returned |
time_points_status | str | Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
insights_id_series_metadata_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Insight ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
insights_id_series_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Insight ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
updated_after | datetime | Returns only the updated time-points after the date specified. |
blank_observations | bool | If it's set to true, empty time-points will be returned |
time_points_status | str | Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
insights_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
insights_search_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
insights_series_series_id_data_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
series_id | str | Insight Series ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
updated_after | datetime | Returns only the updated time-points after the date specified. |
blank_observations | bool | If it's set to true, empty time-points will be returned |
time_points_status | str | Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted |
insights_series_series_id_metadata_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
series_id | str | Insight Series ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
insights_series_series_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
series_id | str | Insight Series ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
updated_after | datetime | Returns only the updated time-points after the date specified. |
blank_observations | bool | If it's set to true, empty time-points will be returned |
time_points_status | str | Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
internal_series_id_internal_remarks_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
layout_databases_id_topics_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Database ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
layout_databases_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
layout_node_code_footnote_download_file_name_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
node_code | str | Node Code - Database ID, Topic ID, Section ID or Table ID (required) |
file_name | str | Resource file name (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
layout_node_code_footnote_download_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
node_code | str | Node Code - Database ID, Topic ID, Section ID or Table ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
layout_node_code_footnote_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
node_code | str | Node Code - Database ID, Topic ID, Section ID or Table ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
layout_sections_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Node ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
layout_sections_id_tables_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Section ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
layout_tables_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Node ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
layout_tables_id_series_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Table ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
layout_topics_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Node ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
layout_topics_id_sections_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Topic ID (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
login_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
logout_session_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
session | str | User session (required) |
releases_code_series_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
code | str | Release identifier code for a group of series with the same release schedule. Accepts only one release identifier code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
releases_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
layout | list[str] | **DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* |
database | list[str] | Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* |
keyword | str | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips |
frequency | list[str] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal |
country | list[str] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. |
source | list[str] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. |
unit | list[str] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. |
indicator | list[str] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! |
region | list[str] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. |
subscribed_only | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. |
key_only | bool | Show only 'key' series when set to `true`. |
new_only | bool | Show only series created less than 1 month ago when set to `true`. |
name_only | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. |
start_date_before | date | Will return series with first observation before `start_date_before` |
end_date_after | date | Will return series with last observation after `end_date_after` |
created_after | date | Will return entries created after `created_after` date |
updated_after | date | Will return series last time updated after `updated_after` date |
geo | list[str] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. |
status | list[str] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand |
data_source | list[str] | Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series |
series | list[str] | List of series |
topic | list[str] | Topic filter. One or more comma separated topic code values. |
section | list[str] | Section filter. One or more comma separated section code values. |
table | list[str] | Table filter. One or more comma separated table code values. |
order | list[str] | Sort order. Default is `relevance`. |
direction | list[str] | Sort order direction. Default is `asc`. Accepted values |
filter_id | list[str] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
facet | list[str] | List of facets to return |
release_date_from | date | Will return releases with first observation before `release_date_from` |
release_date_to | date | Will return releases with last observation after `release_date_to` |
release_status | list[str] | List of release statuses to return |
releases_series_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
release_date_from | date | Will return releases with first observation before `release_date_from` |
release_date_to | date | Will return releases with last observation after `release_date_to` |
release_status | list[str] | List of release statuses to return |
offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. |
limit | float | Number of records to return in the range 1 - 100. Default is 100. |
series_id_data_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
updated_after | datetime | Returns only the updated time-points after the date specified. |
blank_observations | bool | If it's set to true, empty time-points will be returned |
time_points_status | str | Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted |
series_id_metadata_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
series_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
count | int | Limit the amount of latest time-points returned, by the number specified. |
start_date | date | Limits the start date after which the time-points will be returned. |
end_date | date | Limits the end date before which the time-points will be returned. |
updated_after | datetime | Returns only the updated time-points after the date specified. |
blank_observations | bool | If it's set to true, empty time-points will be returned |
time_points_status | str | Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
series_id_visual_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
Name | Type | Description |
---|---|---|
id | str | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
accept_language | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
accept | str | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. |
lang | str | 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` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese |
format | str | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. |
token | str | Access API key. |
with_model_information | bool | If set to `true` returns the model names as part of the response. |
with_replacements_metadata | bool | If it is `true` result will contain replacements metadata not only list of id`s |
forecast_only | bool | If it is `true` result will only contain series with forecast |
with_release_only | bool | If it is `true` result will only contain series with released schedule |
with_replacements_only | bool | If it is `true` result will only contain series with suggestions |
with_observations_only | bool | If it is `true` result will not contain series without observations |
with_continuous_only | bool | If set to `true` results will contain only series with available historical extensions |
series_search_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
subscriptions_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
validate_credentials_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
watchlist_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.
watchlist_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
None If the method is called asynchronously, returns the request thread.