完整的开发指南

API Clients

命名空间: ceic_api_client.apis.dictionary_api

类: DictionaryApi(api_client=None)


get_classification_indicators(self, id, **kwargs)

List of indicators for specific classification . Returns full list of indicators for specific classification. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

IndicatorsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

get_classifications(self, **kwargs)

Classifications list . Returns full list of supported top level classifications and their codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

ClassificationsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_countries(self, **kwargs)

DEPRECATED. Please use `/dictionary/geo`. Countries list . DEPRECATED. Please use `/dictionary/geo`. Returns full list of supported countries and their codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

CountriesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_country_sources(self, id, **kwargs)

List of sources for a specific country . Returns full list of sources for a specific country. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

SourcesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

get_dictionaries(self, **kwargs)

Full dictionary list . Returns all the available dictionaries. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

DictionaryResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_frequencies(self, **kwargs)

Frequencies list . Returns full list of supported frequencies and their codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

FrequenciesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_geo(self, **kwargs)

Geo list . Returns full list of geo entities and their codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

GeoResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_indicators(self, **kwargs)

Indicators list . Returns full list of supported indicators, their codes and the related top level classifications. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

IndicatorsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_layouts(self, **kwargs)

DEPRECATED. Please use `/layout/databases`. Database layouts list . DEPRECATED. Please use `/layout/databases`. Returns full list of supported databases and their codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

LayoutsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_regions(self, **kwargs)

Regions list . Returns full list of supported regions and their codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

RegionsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_release_statuses(self, **kwargs)

Release schedule statuses list . Returns full list of supported releases schedule statuses. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

ReleaseStatusesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_release_types(self, **kwargs)

Release schedule types list . Returns full list of supported releases schedule types. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

ReleaseTypesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_sources(self, **kwargs)

Sources list . Returns full list of supported sources and their codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

SourcesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_statuses(self, **kwargs)

Statuses list . Returns full list of supported statuses and their codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

StatusesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_units(self, **kwargs)

Units list . Returns full list of supported units and their codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

UnitsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

命名空间: ceic_api_client.apis.dumps_api

类: DumpsApi(api_client=None)


cancel_dump(self, id, **kwargs)

Cancel dump . Cancel a running dump . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

DumpResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_data_dump(self, filter_id, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

DumpResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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_data_dump(self, id, **kwargs)

Get dump . Get generated dump or information about process of generation . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

DumpResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_user_dumps(self, **kwargs)

List dumps . List user dumps . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

DumpListResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

命名空间: ceic_api_client.apis.feeds_api

类: FeedsApi(api_client=None)


create_feed(self, filter_id, **kwargs)

Subscribe for a feed . Creates a request for a feed subscription. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

FeedResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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(self, id, **kwargs)

Delete feed . Delete feed . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

FeedInformation 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, id, **kwargs)

Get feed . Get a single data feed record . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

FeedInformation 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_feeds(self, **kwargs)

List all feed subscriptions . List all feed subscriptions the user have set. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

FeedsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, id, **kwargs)

Update feed . Update an already existing feed. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

FeedInformation 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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

命名空间: ceic_api_client.apis.filters_api

类: FiltersApi(api_client=None)


create_filter(self, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

FilterResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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
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* 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 - *Daily Database* 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(self, id, **kwargs)

Delete filters . Delete list of filters . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

EmptyObject 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_filters(self, id, **kwargs)

Get filter details . Get information about one or more filters . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

FiltersResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, **kwargs)

Get user filters . Returns list of user created filters . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

FiltersResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, id, **kwargs)

Update filter details . Update search, series and metadata information for a specific filter . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

FilterResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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
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* 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 - *Daily Database* 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

命名空间: ceic_api_client.apis.insights_api

类: InsightsApi(api_client=None)


download_insight(self, id, file_format, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

InsightDownloadResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

get_gallery_insights_categories(self, **kwargs)

Insight gallery categories . Returns list of gallery categories. To be used with group filters \"analytics\" and \"gallery\". . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

InsightsCategoriesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_insight(self, id, **kwargs)

Insights details . Returns information about a specified insight. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

InsightsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

get_insight_series(self, id, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

InsightSeriesPaginatedResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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
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.

get_insight_series_data(self, id, **kwargs)

List of all series time-points for a particular insight . Returns all series time-points from the specified insight series. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

InsightSeriesPaginatedResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

get_insight_series_list(self, series_id, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

InsightSeriesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

get_insight_series_list_data(self, series_id, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

InsightSeriesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

get_insight_series_list_metadata(self, series_id, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

InsightSeriesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

get_insight_series_metadata(self, id, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

InsightSeriesPaginatedResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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
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.

get_insights(self, **kwargs)

List of User Created Insights . Returns full list of CDMNext user created insights . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

InsightsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_insights_categories(self, **kwargs)

Insight categories . Returns list of insight categories. To be used wtih group filters \"favorite\", \"my\", \"shared\", \"recent\", all\". . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

InsightsCategoriesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

search_insights(self, **kwargs)

Insights search . Search for insights. Those could be user created, shared, or CEIC created ones. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

InsightsSearchResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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 str Sort order
direction str 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

命名空间: ceic_api_client.apis.internal_api

类: InternalApi(api_client=None)


get_internal_remarks(self, id, **kwargs)

Returns list of internal remarks . Returns list of internal remarks . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

SeriesInternalRemarksResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

命名空间: ceic_api_client.apis.layout_api

类: LayoutApi(api_client=None)


get_layout_databases(self, **kwargs)

List of databases . Returns list of layout databases. This is the top level from the layout hierarchy. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

LayoutItemsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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.

get_layout_footnote(self, node_code, **kwargs)

Returns footnote of a node . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

str 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

get_layout_footnote_metadata(self, node_code, **kwargs)

Returns footnote metadata for a node . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

LayoutFootnoteMetadataResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

get_layout_footnote_resource(self, node_code, file_name, **kwargs)

Returns footnote resource file . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

str 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

get_layout_full_metadata(self, id, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

LayoutFullMetadataResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

get_layout_full_metadata_0(self, id, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

LayoutFullMetadataResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

get_layout_full_metadata_1(self, id, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

LayoutFullMetadataResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

get_layout_sections(self, id, **kwargs)

List of Sections . Returns list of sections for a selected topic . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

LayoutItemsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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.

get_layout_series(self, id, **kwargs)

List of Series . Returns list of series inside of a table . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

SeriesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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.

get_layout_tables(self, id, **kwargs)

List of Tables . Returns list of tables for a selected section . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

LayoutItemsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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.

get_layout_topics(self, id, **kwargs)

List of Topics . Returns list of topics for a selected database . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

LayoutItemsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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.

命名空间: ceic_api_client.apis.releases_api

类: ReleasesApi(api_client=None)


get_release_series(self, code, **kwargs)

List release code series. . Lists the series for a specific release identifier code. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

ReleaseSeriesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

get_series_releases(self, id, **kwargs)

List of releases for a single series id . Lists the release schedule for a single series id . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

SeriesReleaseScheduleSearchResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

search_series_releases(self, **kwargs)

Released schedule search . Allows searching for series' release schedule by a keyword and additional filtering criteria. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

SeriesReleaseScheduleSearchResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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* 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 - *Daily Database* 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* 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 - *Daily Database* 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.
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
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
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

命名空间: ceic_api_client.apis.series_api

类: SeriesApi(api_client=None)


get_series(self, id, **kwargs)

Returns full series data . Returns series containing both metadata and time-points data. Accepts one or more Series IDs or Series Codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

SeriesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

get_series_metadata(self, id, **kwargs)

Returns list of metadata items . Returns series containing metadata only. Accepts one or more Series IDs or Series Codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

SeriesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

get_series_statistics(self, id, **kwargs)

Returns list of items' statistics . Returns series containing statistics only. Accepts one or more Series IDs or Series Codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

SeriesStatisticsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

get_series_time_points(self, id, **kwargs)

Returns series time-points . Returns series containing time-points data only. Accepts one or more Series IDs or Series Codes. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

SeriesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

get_series_visual(self, id, **kwargs)

Returns visual image . Returns some chart/map/table image . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

str 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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
width float Image width
height float Image height
period float Series time-pints mask. Example
type str Visual type

search_series(self, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

SearchSeriesResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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* 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 - *Daily Database* 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* 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 - *Daily Database* 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.
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
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
facet list[str] List of facets to return

命名空间: ceic_api_client.apis.sessions_api

类: SessionsApi(api_client=None)


generate_impersonate_token(self, employee_token, user_id, application, **kwargs)

Generate impersonate token . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

ImpersonateAPIKeyResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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_subscriptions(self, **kwargs)

Get user subscriptions . Get user subscriptions . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

UserSubscriptionsResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

login(self, login, password, application, **kwargs)

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. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

UserSessionResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
login str Username (required)
password str Password (required)
application str Application ID (required)
application_version str Application Version

logout(self, session, **kwargs)

Close existing API session. . Not needed when API key is used. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

SessionStatusResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
session str User session (required)

validate_credentials(self, login, password, **kwargs)

Check if user's login/password are valid . Check if user's login/password are valid . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

UserCredentialsValidationResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
login str Username (required)
password str Password (required)

命名空间: ceic_api_client.apis.watchlist_api

类: WatchlistApi(api_client=None)


create_watchlist(self, series_id, **kwargs)

Create Watchlist . Create watchlist subscription . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

WatchlistProcessedResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, id, **kwargs)

Delete watchlist . Removes provided series from watchlist subscription . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

WatchlistProcessedResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.

get_watchlist(self, **kwargs)

Lists all watchlist subscriptions . Lists all watchlist subscriptions the user have set. . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

WatchlistGetResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, id, **kwargs)

Update watchlist . Update watchlist subscription details . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

WatchlistProcessedResult 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

命名空间: ceic_api_client.apis.default_api

类: DefaultApi(api_client=None)


dictionary_classifications_id_indicators_options(self, id, **kwargs)

dictionary_classifications_id_indicators_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, **kwargs)

dictionary_classifications_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


dictionary_countries_id_sources_options(self, id, **kwargs)

dictionary_countries_id_sources_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, **kwargs)

dictionary_countries_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


dictionary_frequencies_options(self, **kwargs)

dictionary_frequencies_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


dictionary_indicators_options(self, **kwargs)

dictionary_indicators_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


dictionary_layouts_options(self, **kwargs)

dictionary_layouts_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


dictionary_options(self, **kwargs)

dictionary_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


dictionary_regions_options(self, **kwargs)

dictionary_regions_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


dictionary_sources_options(self, **kwargs)

dictionary_sources_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


dictionary_statuses_options(self, **kwargs)

dictionary_statuses_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


dictionary_units_options(self, **kwargs)

dictionary_units_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


dumps_id_options(self, id, **kwargs)

dumps_id_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, **kwargs)

dumps_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


feeds_id_options(self, id, **kwargs)

feeds_id_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, **kwargs)

feeds_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


filters_id_options(self, id, **kwargs)

filters_id_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, **kwargs)

filters_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


impersonate_token_options(self, employee_token, user_id, application, **kwargs)

impersonate_token_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, **kwargs)

insights_categories_emis_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


insights_categories_focus_economics_options(self, **kwargs)

insights_categories_focus_economics_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


insights_categories_gallery_options(self, **kwargs)

insights_categories_gallery_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


insights_categories_options(self, **kwargs)

insights_categories_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


insights_id_download_file_format_options(self, id, file_format, **kwargs)

insights_id_download_file_format_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, id, **kwargs)

insights_id_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, id, **kwargs)

insights_id_series_data_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, id, **kwargs)

insights_id_series_metadata_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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
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(self, id, **kwargs)

insights_id_series_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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
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(self, **kwargs)

insights_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


insights_search_options(self, **kwargs)

insights_search_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


insights_series_series_id_data_options(self, series_id, **kwargs)

insights_series_series_id_data_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, series_id, **kwargs)

insights_series_series_id_metadata_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

insights_series_series_id_options(self, series_id, **kwargs)

insights_series_series_id_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

internal_series_id_internal_remarks_options(self, id, **kwargs)

internal_series_id_internal_remarks_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

layout_databases_id_topics_options(self, id, **kwargs)

layout_databases_id_topics_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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(self, **kwargs)

layout_databases_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


layout_node_code_footnote_download_file_name_options(self, node_code, file_name, **kwargs)

layout_node_code_footnote_download_file_name_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, node_code, **kwargs)

layout_node_code_footnote_download_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, node_code, **kwargs)

layout_node_code_footnote_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, id, **kwargs)

layout_sections_id_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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(self, id, **kwargs)

layout_sections_id_tables_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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(self, id, **kwargs)

layout_tables_id_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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(self, id, **kwargs)

layout_tables_id_series_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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(self, id, **kwargs)

layout_topics_id_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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(self, id, **kwargs)

layout_topics_id_sections_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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.
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(self, **kwargs)

login_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


logout_session_options(self, session, **kwargs)

logout_session_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
session str User session (required)

releases_code_series_options(self, code, **kwargs)

releases_code_series_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, **kwargs)

releases_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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* 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 - *Daily Database* 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* 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 - *Daily Database* 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.
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
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
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(self, id, **kwargs)

releases_series_id_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, id, **kwargs)

series_id_data_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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(self, id, **kwargs)

series_id_metadata_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

series_id_options(self, id, **kwargs)

series_id_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

series_id_visual_options(self, id, **kwargs)

series_id_visual_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。

参数:
名称 類型 描述
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

series_search_options(self, **kwargs)

series_search_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


subscriptions_options(self, **kwargs)

subscriptions_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


validate_credentials_options(self, **kwargs)

validate_credentials_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


watchlist_id_options(self, **kwargs)

watchlist_id_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


watchlist_options(self, **kwargs)

watchlist_options . 默认情况下,此方法会发出同步HTTP请求。如需发出异步HTTP请求,请执行async_req=True

返回值:

None 如果异步调用该方法,则返回请求的线程。


Result Types

ceic_api_client.models.base_series_information.BaseSeriesInformation(layout=None, subscribed=None, metadata=None)
ceic_api_client.models.classification.Classification(id=None, name=None)
ceic_api_client.models.classifications_result.ClassificationsResult(data=None)
ceic_api_client.models.countries_result.CountriesResult(data=None)
ceic_api_client.models.country.Country(id=None, name=None)
ceic_api_client.models.dictionary_data.DictionaryData(classifications=None, countries=None, regions=None, sources=None, layouts=None, units=None, indicators=None)
ceic_api_client.models.dictionary_result.DictionaryResult(data=None)
ceic_api_client.models.dump_information.DumpInformation(status=None, description=None, total_series_number=None, filter_id=None, filter_description=None, download_link=None, created=None, filter_name=None, collected_series_number=None, progress=None, id=None, name=None)
ceic_api_client.models.dump_list_information.DumpListInformation(dumps=None)
ceic_api_client.models.dump_list_result.DumpListResult(data=None)
ceic_api_client.models.dump_result.DumpResult(data=None)
ceic_api_client.models.empty_object.EmptyObject()
ceic_api_client.models.facet.Facet(items=None, id=None)
ceic_api_client.models.facet_entry.FacetEntry(total=None, id=None)
ceic_api_client.models.feed_information.FeedInformation(user_ftp_username=None, consolidation_method=None, delivery_path=None, frequency=None, notification_email=None, feed_updated_at=None, id=None, user_id=None, notification_url=None, user_ftp_url=None, filter_id=None, status=None, description=None, filter_description=None, full_dump=None, notification_http_method=None, filter_name=None, name=None, language=None, delivery_format=None, created_at=None, delivery_method=None, updated_after=None, metadata_only=None)
ceic_api_client.models.feed_result.FeedResult(data=None)
ceic_api_client.models.feeds_result.FeedsResult(data=None)
ceic_api_client.models.filter_details.FilterDetails(series=None, search=None)
ceic_api_client.models.filter_details_search.FilterDetailsSearch()
ceic_api_client.models.filter_result.FilterResult(data=None)
ceic_api_client.models.filters_result.FiltersResult(data=None)
ceic_api_client.models.frequencies_result.FrequenciesResult(data=None)
ceic_api_client.models.frequency.Frequency(id=None, name=None)
ceic_api_client.models.geo.Geo(iso_code=None, type=None, id=None, title=None)
ceic_api_client.models.geo_info.GeoInfo(code=None, name=None, parents=None, parent_id=None, type=None, id=None)
ceic_api_client.models.geo_result.GeoResult(data=None)
ceic_api_client.models.impersonate_api_key.ImpersonateAPIKey(token=None)
ceic_api_client.models.impersonate_api_key_result.ImpersonateAPIKeyResult(data=None)
ceic_api_client.models.indicator.Indicator(classification_id=None, id=None, name=None)
ceic_api_client.models.indicators_result.IndicatorsResult(data=None)
ceic_api_client.models.insight_download.InsightDownload(download_link_expiration=None, format=None, download_link=None, title=None)
ceic_api_client.models.insight_download_result.InsightDownloadResult(data=None)
ceic_api_client.models.insight_series.InsightSeries(entity_id=None, series_data=None, insight_series=None)
ceic_api_client.models.insight_series_information.InsightSeriesInformation(group=None, name=None, deleted=None, insight_id=None, applied_functions=None, type=None, id=None)
ceic_api_client.models.insight_series_paginated_result.InsightSeriesPaginatedResult(data=None)
ceic_api_client.models.insight_series_paginated_result_data.InsightSeriesPaginatedResultData(items=None, total=None)
ceic_api_client.models.insight_series_result.InsightSeriesResult(data=None)
ceic_api_client.models.insights.Insights(category=None, subscribed=None, description=None, last_update_time=None, creator=None, creation_time=None, keywords=None, last_editor=None, id=None, name=None)
ceic_api_client.models.insights_categories_result.InsightsCategoriesResult(data=None)
ceic_api_client.models.insights_category.InsightsCategory(id=None, parent=None, name=None)
ceic_api_client.models.insights_result.InsightsResult(data=None)
ceic_api_client.models.insights_search.InsightsSearch(items=None, total=None)
ceic_api_client.models.insights_search_result.InsightsSearchResult(data=None)
ceic_api_client.models.internal_series_remarks.InternalSeriesRemarks(internal_remarks=None, entity_id=None)
ceic_api_client.models.layout.Layout(parent_id=None, id=None, name=None)
ceic_api_client.models.layout_ancestors.LayoutAncestors(topic=None, table=None, section=None, database=None)
ceic_api_client.models.layout_footnote_metadata.LayoutFootnoteMetadata(footnote=None, resources=None)
ceic_api_client.models.layout_footnote_metadata_item.LayoutFootnoteMetadataItem(language_code=None, content_type=None, description=None, last_update_time=None, file_type=None, download_link=None, file_name=None)
ceic_api_client.models.layout_footnote_metadata_result.LayoutFootnoteMetadataResult(data=None)
ceic_api_client.models.layout_footnote_resource_metadata_item.LayoutFootnoteResourceMetadataItem(download_link=None, file_name=None)
ceic_api_client.models.layout_full_metadata_item.LayoutFullMetadataItem(ancestors=None, metadata=None)
ceic_api_client.models.layout_full_metadata_result.LayoutFullMetadataResult(data=None)
ceic_api_client.models.layout_information.LayoutInformation(topic=None, table=None, section=None, series_code=None, database=None)
ceic_api_client.models.layout_item.LayoutItem(metadata=None, ui=None, subscribed=None, series_count=None)
ceic_api_client.models.layout_item_metadata.LayoutItemMetadata(id=None, name=None)
ceic_api_client.models.layout_item_ui.LayoutItemUI(display_order=None)
ceic_api_client.models.layout_items_result.LayoutItemsResult(data=None)
ceic_api_client.models.layouts_result.LayoutsResult(data=None)
ceic_api_client.models.province.Province(id=None, name=None)
ceic_api_client.models.region.Region(id=None, name=None)
ceic_api_client.models.regions_result.RegionsResult(data=None)
ceic_api_client.models.release_schedule_status.ReleaseScheduleStatus(id=None, name=None)
ceic_api_client.models.release_schedule_type.ReleaseScheduleType(id=None, name=None)
ceic_api_client.models.release_series.ReleaseSeries(series_id=None, start_date=None, end_date=None, name=None, source_name=None, last_updated=None, frequency=None, unit=None)
ceic_api_client.models.release_series_list.ReleaseSeriesList(items=None, total=None)
ceic_api_client.models.release_series_result.ReleaseSeriesResult(data=None)
ceic_api_client.models.release_statuses_result.ReleaseStatusesResult(data=None)
ceic_api_client.models.release_types_result.ReleaseTypesResult(data=None)
ceic_api_client.models.response_error.ResponseError(status=None, message=None, code=None)
ceic_api_client.models.search_series.SearchSeries(items=None, facets=None, total=None)
ceic_api_client.models.search_series_result.SearchSeriesResult(data=None)
ceic_api_client.models.series.Series(replacements=None, layout=None, subscribed=None, time_points=None, deleted_time_points=None, ui=None, entity_id=None, grouping=None, metadata=None)
ceic_api_client.models.series_data.SeriesData(deleted_time_points=None, time_points=None)
ceic_api_client.models.series_filter.SeriesFilter(description=None, last_updated_at=None, created_at=None, filter_details=None, creator_id=None, id=None, name=None)
ceic_api_client.models.series_grouping.SeriesGrouping(short_name=None, parent_code=None)
ceic_api_client.models.series_information.SeriesInformation(replacements=None, layout=None, subscribed=None, ui=None, metadata=None, grouping=None)
ceic_api_client.models.series_internal_remarks_result.SeriesInternalRemarksResult(data=None)
ceic_api_client.models.series_metadata.SeriesMetadata(mnemonic=None, start_date=None, end_date=None, classification=None, geo_info=None, frequency=None, is_forecast=None, id=None, unit=None, indicator=None, last_update_time=None, has_schedule=None, source=None, multiplier_code=None, is_revised=None, province=None, last_change=None, remarks=None, number_of_observations=None, last_value=None, new_series=None, name=None, country=None, period_end=None, series_tag=None, status=None, key_series=None)
ceic_api_client.models.series_metadata_last_change.SeriesMetadataLastChange(is_infinity=None, is_opposite=None, value=None)
ceic_api_client.models.series_release_schedule_item.SeriesReleaseScheduleItem(release_status=None, code=None, _from=None, release_type=None, timepoint_date=None, release_date=None, to=None)
ceic_api_client.models.series_release_schedule_search_result.SeriesReleaseScheduleSearchResult(data=None)
ceic_api_client.models.series_releases.SeriesReleases(items=None, total=None)
ceic_api_client.models.series_releases_search.SeriesReleasesSearch(items=None, total=None)
ceic_api_client.models.series_replacements.SeriesReplacements(series=None, ids=None)
ceic_api_client.models.series_result.SeriesResult(errors=None, data=None)
ceic_api_client.models.series_statistics.SeriesStatistics(start_date=None, skewness=None, end_date=None, standard_deviation=None, coefficient_variation=None, num_points=None, variance=None, kurtosis=None, mean=None)
ceic_api_client.models.series_statistics_item.SeriesStatisticsItem(entity_id=None, statistics=None)
ceic_api_client.models.series_statistics_result.SeriesStatisticsResult(data=None)
ceic_api_client.models.series_ui_settings.SeriesUISettings(display_order=None, separator_after_series=None)
ceic_api_client.models.session_status.SessionStatus(destroyed=None, session=None)
ceic_api_client.models.session_status_result.SessionStatusResult(data=None)
ceic_api_client.models.source.Source(country_id=None, id=None, name=None)
ceic_api_client.models.sources_result.SourcesResult(data=None)
ceic_api_client.models.status.Status(id=None, name=None)
ceic_api_client.models.statuses_result.StatusesResult(data=None)
ceic_api_client.models.subscription_item.SubscriptionItem(product_code=None, service_code=None)
ceic_api_client.models.time_point.TimePoint(date=None, last_update_time=None, value=None)
ceic_api_client.models.unit.Unit(id=None, name=None)
ceic_api_client.models.units_result.UnitsResult(data=None)
ceic_api_client.models.user_credentials_validation_result.UserCredentialsValidationResult(data=None)
ceic_api_client.models.user_credentials_validation_result_data.UserCredentialsValidationResultData(valid=None)
ceic_api_client.models.user_information.UserInformation(last_name=None, id=None, first_name=None, email=None)
ceic_api_client.models.user_session.UserSession(session=None)
ceic_api_client.models.user_session_result.UserSessionResult(data=None)
ceic_api_client.models.user_subscriptions_result.UserSubscriptionsResult(data=None)
ceic_api_client.models.watchlist_get_result.WatchlistGetResult(data=None)
ceic_api_client.models.watchlist_item.WatchlistItem(series_id=None, popup_notifications=None, name=None, last_update_time=None, is_subscribed=None, name_local=None, country_name=None, email_notifications=None, country_name_local=None)
ceic_api_client.models.watchlist_processed_information.WatchlistProcessedInformation(processed_items=None)
ceic_api_client.models.watchlist_processed_result.WatchlistProcessedResult(errors=None, data=None)