(cache)ISI Emerging Markets Group - Developer Portal

Full Development Guide

API Clients

Namespace: ceic_api_client.apis.default_api

Class: DefaultApi(api_client=None, token=None)

dictionary_classifications_id_indicators_options((self, id, **kwargs))

dictionary_classifications_id_indicators_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Classification ID. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

dictionary_classifications_options((self, **kwargs))

dictionary_classifications_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

dictionary_countries_id_sources_options((self, id, **kwargs))

dictionary_countries_id_sources_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Country ISO code (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

dictionary_countries_options((self, **kwargs))

dictionary_countries_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

dictionary_frequencies_options((self, **kwargs))

dictionary_frequencies_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

dictionary_indicators_options((self, **kwargs))

dictionary_indicators_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

dictionary_layouts_options((self, **kwargs))

dictionary_layouts_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

dictionary_options((self, **kwargs))

dictionary_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

dictionary_regions_options((self, **kwargs))

dictionary_regions_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

dictionary_sources_options((self, **kwargs))

dictionary_sources_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

dictionary_statuses_options((self, **kwargs))

dictionary_statuses_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

dictionary_units_options((self, **kwargs))

dictionary_units_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

dumps_id_options((self, id, **kwargs))

dumps_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Dump ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

dumps_options((self, **kwargs))

dumps_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

feeds_id_options((self, id, **kwargs))

feeds_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Feed ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

feeds_options((self, **kwargs))

feeds_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

filters_id_options((self, id, **kwargs))

filters_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Filter ID. Accepts one or more comma separated values. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

filters_options((self, **kwargs))

filters_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

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

impersonate_token_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
employee_token	str	Impersonate API token generated on CAS service (required)
user_id	str	User Id (required)
application	str	Application ID (required)
expire_after	float	Token will be expired after `expire_after` in seconds

insights_categories_emis_options((self, **kwargs))

insights_categories_emis_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

insights_categories_gallery_options((self, **kwargs))

insights_categories_gallery_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

insights_categories_options((self, **kwargs))

insights_categories_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

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

insights_id_download_file_format_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Insight ID (required)
file_format	str	Insight report file format. Available formats
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
ignore_cache	bool	New file will be generated
adjust_columns	str	No adjust or wrap text in XLSX cell
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
count	int	Limit the amount of latest time-points returned, by the number specified.
blank_observations	str	If set to true, will return empty time-points which oterwise are omitted.
orientation	str	Columns/rows orientation
order	str	Sort order - Asc/Desc
decimal_places	float	Decimal places for the time-points values
date_format	str	Time-points date format

insights_id_options((self, id, **kwargs))

insights_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Insight ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

insights_id_series_data_options((self, id, **kwargs))

insights_id_series_data_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Insight ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
limit	float	Number of records to return in the range 1 - 100. Default is 100.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.

insights_id_series_metadata_options((self, id, **kwargs))

insights_id_series_metadata_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Insight ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions
limit	float	Number of records to return in the range 1 - 100. Default is 100.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.

insights_id_series_options((self, id, **kwargs))

insights_id_series_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Insight ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions
limit	float	Number of records to return in the range 1 - 100. Default is 100.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.

insights_options((self, **kwargs))

insights_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

insights_search_options((self, **kwargs))

insights_search_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

insights_series_series_id_data_options((self, series_id, **kwargs))

insights_series_series_id_data_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
series_id	str	Insight Series ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted

insights_series_series_id_metadata_options((self, series_id, **kwargs))

insights_series_series_id_metadata_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
series_id	str	Insight Series ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

insights_series_series_id_options((self, series_id, **kwargs))

insights_series_series_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
series_id	str	Insight Series ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

internal_series_id_internal_remarks_options((self, id, **kwargs))

internal_series_id_internal_remarks_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

layout_databases_id_topics_options((self, id, **kwargs))

layout_databases_id_topics_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Database ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
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 . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

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

layout_node_code_footnote_download_file_name_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
node_code	str	Node Code - Database ID, Topic ID, Section ID or Table ID (required)
file_name	str	Resource file name (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese

layout_node_code_footnote_download_options((self, node_code, **kwargs))

layout_node_code_footnote_download_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
node_code	str	Node Code - Database ID, Topic ID, Section ID or Table ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese

layout_node_code_footnote_options((self, node_code, **kwargs))

layout_node_code_footnote_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
node_code	str	Node Code - Database ID, Topic ID, Section ID or Table ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

layout_sections_id_options((self, id, **kwargs))

layout_sections_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Node ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
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 . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Section ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
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 . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Node ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
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 . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Table ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
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 . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Node ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
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 . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Topic ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
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 . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

logout_session_options((self, session, **kwargs))

logout_session_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
session	str	User session (required)

releases_code_series_options((self, code, **kwargs))

releases_code_series_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
code	str	Release identifier code for a group of series with the same release schedule. Accepts only one release identifier code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
limit	float	Number of records to return in the range 1 - 100. Default is 100.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.

releases_options((self, **kwargs))

releases_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
limit	float	Number of records to return in the range 1 - 100. Default is 100.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.
layout	list[str]	DEPRECATED. Please use `database` parameter. Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - World Trend Plus WGEM - Economic Monitor WESG - Environmental, Social and Governance WAEM - ASEAN Economic Monitor WFOR - Forecast WCOM - Commodity Market WCOC - Country Competitiveness WAGR - Aggregates WASS - International Associations 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 CEICEPFRLI - EPFR Macro Flows CEICEPFRCF - EPFR Country Flow CEICEPFRCA - EPFR Country Allocations CEICEPFRFF - EPFR Fund Flow CEICGFI - GFI Fenics Market Data CEICMSCI - MSCI Global Equity Index DAILY - High Frequency Database ALT - Alternative Data FMS - Financial and Monetary Statistics HL - Health ASEAN - ASEAN Premium Database APBN - *ASEAN
database	list[str]	Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - World Trend Plus WGEM - Economic Monitor WESG - Environmental, Social and Governance WAEM - ASEAN Economic Monitor WFOR - Forecast WCOM - Commodity Market WCOC - Country Competitiveness WAGR - Aggregates WASS - International Associations 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 CEICEPFRLI - EPFR Macro Flows CEICEPFRCF - EPFR Country Flow CEICEPFRCA - EPFR Country Allocations CEICEPFRFF - EPFR Fund Flow CEICGFI - GFI Fenics Market Data CEICMSCI - MSCI Global Equity Index DAILY - High Frequency Database ALT - Alternative Data FMS - Financial and Monetary Statistics HL - Health ASEAN - ASEAN Premium Database APBN - *ASEAN
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
geo	list[str]	Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
status	list[str]	Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand
data_source	list[str]	Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series
series	list[str]	List of series
with_vintage_enabled_only	bool	If it is `true` result will contain ONLY vintage enabled series
headline_only	bool	Show only 'headline' series when set to `true`.
topic	list[str]	Topic filter. One or more comma separated topic code values.
section	list[str]	Section filter. One or more comma separated section code values.
table	list[str]	Table filter. One or more comma separated table code values.
order	list[str]	Sort order. Default is `relevance`.
direction	list[str]	Sort order direction. Default is `asc`. Accepted values
filter_id	list[str]	Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both.
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions
facet	list[str]	List of facets to return
release_date_from	date	Will return releases with first observation before `release_date_from`
release_date_to	date	Will return releases with last observation after `release_date_to`
release_status	list[str]	List of release statuses to return

releases_series_id_options((self, id, **kwargs))

releases_series_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
release_date_from	date	Will return releases with first observation before `release_date_from`
release_date_to	date	Will return releases with last observation after `release_date_to`
release_status	list[str]	List of release statuses to return
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.
limit	float	Number of records to return in the range 1 - 100. Default is 100.

series_id_data_options((self, id, **kwargs))

series_id_data_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
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_earliest_options((self, id, **kwargs))

series_id_earliest_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

series_id_metadata_options((self, id, **kwargs))

series_id_metadata_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

series_id_options((self, id, **kwargs))

series_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

series_id_vintages_dates_options((self, id, **kwargs))

series_id_vintages_dates_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

series_id_vintages_options((self, id, **kwargs))

series_id_vintages_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

series_id_visual_options((self, id, **kwargs))

series_id_visual_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

series_search_options((self, **kwargs))

series_search_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

subscriptions_options((self, **kwargs))

subscriptions_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

userdefined_series_clone_options((self, **kwargs))

userdefined_series_clone_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

userdefined_series_id_data_options((self, id, **kwargs))

userdefined_series_id_data_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
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

userdefined_series_id_timepoints_date_options((self, id, **kwargs))

userdefined_series_id_timepoints_date_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
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

userdefined_series_id_timepoints_options((self, id, **kwargs))

userdefined_series_id_timepoints_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
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

userdefined_series_options((self, **kwargs))

userdefined_series_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

validate_credentials_options((self, **kwargs))

validate_credentials_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

watchlist_id_options((self, **kwargs))

watchlist_id_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

watchlist_options((self, **kwargs))

watchlist_options . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

None If the method is called asynchronously, returns the request thread.

Namespace: ceic_api_client.apis.dictionary_api

Class: DictionaryApi(api_client=None, token=None)

get_classification_indicators((self, id, **kwargs))

List of indicators for specific classification . DEPRECATED. Returns full list of indicators for specific classification. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

IndicatorsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Classification ID. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_classifications((self, **kwargs))

Classifications list . DEPRECATED. Returns full list of supported top level classifications and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

ClassificationsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

CountriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_country_sources((self, id, **kwargs))

List of sources for a specific country . Returns full list of sources for a specific country. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SourcesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Country ISO code (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_dictionaries((self, **kwargs))

Full dictionary list . Returns all the available dictionaries. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

DictionaryResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_frequencies((self, **kwargs))

Frequencies list . Returns full list of supported frequencies and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

FrequenciesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_geo((self, **kwargs))

Geo list . Returns full list of geo entities and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

GeoResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_indicators((self, **kwargs))

Indicators list . Returns full list of supported indicators, their codes and the related top level classifications. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

IndicatorsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

LayoutsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_regions((self, **kwargs))

Regions list . Returns full list of supported regions and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

RegionsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_release_statuses((self, **kwargs))

Release schedule statuses list . Returns full list of supported releases schedule statuses. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

ReleaseStatusesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_release_types((self, **kwargs))

Release schedule types list . Returns full list of supported releases schedule types. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

ReleaseTypesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_sources((self, **kwargs))

Sources list . Returns full list of supported sources and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SourcesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_statuses((self, **kwargs))

Statuses list . Returns full list of supported statuses and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

StatusesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_units((self, **kwargs))

Units list . Returns full list of supported units and their codes. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UnitsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

Namespace: ceic_api_client.apis.dumps_api

Class: DumpsApi(api_client=None, token=None)

cancel_dump((self, id, **kwargs))

Cancel dump . Cancel a running dump . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

DumpResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Dump ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

create_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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

DumpResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
filter_id	str	Filter ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
name	str	Name of the new record. Max length 100
description	str	Description of the new record. Max length 1000
consolidation	str	Consolidation Method
delivery	str	Delivery Method
user_ftp_url	str	Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port
user_ftp_path	str	Result delivery path for local FTP server. Only valid when the localftp delivery method is selected.
user_ftp_username	str	Username for the local FTP server. Only valid when the localftp delivery method is selected.
user_ftp_password	str	Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified.
notification_email	str	When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set.
notification_url	str	URL for push notification upon dump completion.
notification_http_method	str	HTTP Method for push notifications.

get_data_dump((self, id, **kwargs))

Get dump . Get generated dump or information about process of generation . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

DumpResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Dump ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

list_user_dumps((self, **kwargs))

List dumps . List user dumps . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

DumpListResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.
limit	float	Number of records to return in the range 1 - 100. Default is 100.
created_after	date	Will return entries created after `created_after` date
created_before	date	Will return entries created after `created_before` date
filter_id	str	Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both.
created_order	str	Choose whether to order the entries ascending or descending. Default is Ascending
status	list[str]	Dump status
feed_id	str	Feed ID

Namespace: ceic_api_client.apis.feeds_api

Class: FeedsApi(api_client=None, token=None)

create_feed((self, filter_id, **kwargs))

Subscribe for a feed . Creates a request for a feed subscription. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

FeedResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
filter_id	str	Filter ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
name	str	Name of the new record. Max length 100
description	str	Description of the new record. Max length 1000
consolidation	str	Consolidation Method
delivery	str	Delivery Method
user_ftp_url	str	Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port
user_ftp_path	str	Result delivery path for local FTP server. Only valid when the localftp delivery method is selected.
user_ftp_username	str	Username for the local FTP server. Only valid when the localftp delivery method is selected.
user_ftp_password	str	Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified.
notification_email	str	When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set.
notification_url	str	URL for push notification upon dump completion.
notification_http_method	str	HTTP Method for push notifications.
frequency	int	Feed generation frequency
full_dump	bool	When set to true, the feed will always generate full list of time points. This option is only available for lists that are equal or less than 3,000 series.

delete_feed((self, id, **kwargs))

Delete feed . Delete feed . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

FeedInformation If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Feed ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_feed((self, id, **kwargs))

Get feed . Get a single data feed record . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

FeedInformation If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Feed ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_feeds((self, **kwargs))

List all feed subscriptions . List all feed subscriptions the user have set. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

FeedsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.
limit	float	Number of records to return in the range 1 - 100. Default is 100.
created_after	date	Will return entries created after `created_after` date
created_before	date	Will return entries created after `created_before` date
filter_id	str	Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both.
created_order	str	Choose whether to order the entries ascending or descending. Default is Ascending
status	list[str]	Feed status

update_feed((self, id, **kwargs))

Update feed . Update an already existing feed. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

FeedInformation If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Feed ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
name	str	Name of the new record. Max length 100
description	str	Description of the new record. Max length 1000
consolidation	str	Consolidation Method
delivery	str	Delivery Method
user_ftp_url	str	Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port
user_ftp_path	str	Result delivery path for local FTP server. Only valid when the localftp delivery method is selected.
user_ftp_username	str	Username for the local FTP server. Only valid when the localftp delivery method is selected.
user_ftp_password	str	Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified.
notification_email	str	When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set.
notification_url	str	URL for push notification upon dump completion.
notification_http_method	str	HTTP Method for push notifications.
frequency	int	Feed generation frequency
full_dump	bool	When set to true, the feed will always generate full list of time points. This option is only available for lists that are equal or less than 3,000 series.
status	str	Feed status
filter_id	str	Filter ID

Namespace: ceic_api_client.apis.filters_api

Class: FiltersApi(api_client=None, token=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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

FilterResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
series	list[str]	List of series, comma separated. Its length cannot be more than 100000.
name	str	Name of the new record. Max length 100
description	str	Description of the new record. Max length 1000
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
geo	list[str]	Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
topic	list[str]	Topic filter. One or more comma separated topic code values.
section	list[str]	Section filter. One or more comma separated section code values.
table	list[str]	Table filter. One or more comma separated table code values.
status	list[str]	Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand
data_source	list[str]	Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series
order	list[str]	Sort order. Default is `relevance`.
database	list[str]	Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - World Trend Plus WGEM - Economic Monitor WESG - Environmental, Social and Governance WAEM - ASEAN Economic Monitor WFOR - Forecast WCOM - Commodity Market WCOC - Country Competitiveness WAGR - Aggregates WASS - International Associations 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 CEICEPFRLI - EPFR Macro Flows CEICEPFRCF - EPFR Country Flow CEICEPFRCA - EPFR Country Allocations CEICEPFRFF - EPFR Fund Flow CEICGFI - GFI Fenics Market Data CEICMSCI - MSCI Global Equity Index DAILY - High Frequency Database ALT - Alternative Data FMS - Financial and Monetary Statistics HL - Health ASEAN - ASEAN Premium Database APBN - *ASEAN
direction	list[str]	Sort order direction. Default is `asc`. Accepted values

delete_filters((self, id, **kwargs))

Delete filters . Delete list of filters . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

EmptyObject If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Filter ID. Accepts one or more comma separated values. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_filters((self, id, **kwargs))

Get filter details . Get information about one or more filters . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

FiltersResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Filter ID. Accepts one or more comma separated values. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_user_filters((self, **kwargs))

Get user filters . Returns list of user created filters . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

FiltersResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

update_filter((self, id, **kwargs))

Update filter details . Update search, series and metadata information for a specific filter . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

FilterResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	A single Filter ID value (required)
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
series	list[str]	List of series, comma separated. Its length cannot be more than 100000.
name	str	Name of the new record. Max length 100
description	str	Description of the new record. Max length 1000
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
geo	list[str]	Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
topic	list[str]	Topic filter. One or more comma separated topic code values.
section	list[str]	Section filter. One or more comma separated section code values.
table	list[str]	Table filter. One or more comma separated table code values.
status	list[str]	Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand
data_source	list[str]	Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series
order	list[str]	Sort order. Default is `relevance`.
database	list[str]	Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - World Trend Plus WGEM - Economic Monitor WESG - Environmental, Social and Governance WAEM - ASEAN Economic Monitor WFOR - Forecast WCOM - Commodity Market WCOC - Country Competitiveness WAGR - Aggregates WASS - International Associations 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 CEICEPFRLI - EPFR Macro Flows CEICEPFRCF - EPFR Country Flow CEICEPFRCA - EPFR Country Allocations CEICEPFRFF - EPFR Fund Flow CEICGFI - GFI Fenics Market Data CEICMSCI - MSCI Global Equity Index DAILY - High Frequency Database ALT - Alternative Data FMS - Financial and Monetary Statistics HL - Health ASEAN - ASEAN Premium Database APBN - *ASEAN
direction	list[str]	Sort order direction. Default is `asc`. Accepted values

Namespace: ceic_api_client.apis.insights_api

Class: InsightsApi(api_client=None, token=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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

InsightDownloadResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Insight ID (required)
file_format	str	Insight report file format. Available formats
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
ignore_cache	bool	New file will be generated
adjust_columns	str	No adjust or wrap text in XLSX cell
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
count	int	Limit the amount of latest time-points returned, by the number specified.
blank_observations	str	If set to true, will return empty time-points which oterwise are omitted.
orientation	str	Columns/rows orientation
order	str	Sort order - Asc/Desc
decimal_places	float	Decimal places for the time-points values
date_format	str	Time-points date format

get_gallery_insights_categories((self, **kwargs))

Insight gallery categories . Returns list of gallery categories. To be used with group filters \"analytics\" and \"gallery\". . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

InsightsCategoriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_insight((self, id, **kwargs))

Insights details . Returns information about a specified insight. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

InsightsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Insight ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

InsightSeriesPaginatedResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Insight ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions
limit	float	Number of records to return in the range 1 - 100. Default is 100.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

InsightSeriesPaginatedResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Insight ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
limit	float	Number of records to return in the range 1 - 100. Default is 100.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

InsightSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
series_id	str	Insight Series ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

InsightSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
series_id	str	Insight Series ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

InsightSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
series_id	str	Insight Series ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

InsightSeriesPaginatedResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Insight ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions
limit	float	Number of records to return in the range 1 - 100. Default is 100.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.

get_insights((self, **kwargs))

List of User Created Insights . Returns full list of CDMNext user created insights . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

InsightsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_insights_categories((self, **kwargs))

Insight categories . Returns list of insight categories. To be used wtih group filters \"favorite\", \"my\", \"shared\", \"recent\", all\". . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

InsightsCategoriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

search_insights((self, **kwargs))

Insights search . Search for insights. Those could be user created, shared, or CEIC created ones. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

InsightsSearchResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
group	str	Insights group. Default is `my`.
limit	float	Number of records to return
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
order	object	Sort order
direction	object	Sort order direction
tags	list[str]	List of insight tags to search by tag
categories	list[str]	List of insights categories to search by category

Namespace: ceic_api_client.apis.internal_api

Class: InternalApi(api_client=None, token=None)

get_internal_remarks((self, id, **kwargs))

Returns list of internal remarks . Returns list of internal remarks . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SeriesInternalRemarksResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

Namespace: ceic_api_client.apis.layout_api

Class: LayoutApi(api_client=None, token=None)

get_layout_databases((self, **kwargs))

List of databases . Returns list of layout databases. This is the top level from the layout hierarchy. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

LayoutItemsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
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 . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

str If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
node_code	str	Node Code - Database ID, Topic ID, Section ID or Table ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese

get_layout_footnote_metadata((self, node_code, **kwargs))

Returns footnote metadata for a node . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

LayoutFootnoteMetadataResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
node_code	str	Node Code - Database ID, Topic ID, Section ID or Table ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

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

Returns footnote resource file . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

str If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
node_code	str	Node Code - Database ID, Topic ID, Section ID or Table ID (required)
file_name	str	Resource file name (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese

get_layout_full_metadata((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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

LayoutFullMetadataResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Node ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

LayoutFullMetadataResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Node ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_layout_full_metadata_1((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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

LayoutFullMetadataResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Node ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_layout_sections((self, id, **kwargs))

List of Sections . Returns list of sections for a selected topic . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

LayoutItemsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Topic ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
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 . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Table ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
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 . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

LayoutItemsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Section ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
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 . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

LayoutItemsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Database ID (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
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.

Namespace: ceic_api_client.apis.releases_api

Class: ReleasesApi(api_client=None, token=None)

get_release_series((self, code, **kwargs))

List release code series. . Lists the series for a specific release identifier code. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

ReleaseSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
code	str	Release identifier code for a group of series with the same release schedule. Accepts only one release identifier code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
limit	float	Number of records to return in the range 1 - 100. Default is 100.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.

get_series_releases((self, id, **kwargs))

List of releases for a single series id . Lists the release schedule for a single series id . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SeriesReleaseScheduleSearchResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
release_date_from	date	Will return releases with first observation before `release_date_from`
release_date_to	date	Will return releases with last observation after `release_date_to`
release_status	list[str]	List of release statuses to return
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.
limit	float	Number of records to return in the range 1 - 100. Default is 100.

search_series_releases((self, **kwargs))

Released schedule search . Allows searching for series' release schedule by a keyword and additional filtering criteria. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SeriesReleaseScheduleSearchResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
limit	float	Number of records to return in the range 1 - 100. Default is 100.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.
layout	list[str]	DEPRECATED. Please use `database` parameter. Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - World Trend Plus WGEM - Economic Monitor WESG - Environmental, Social and Governance WAEM - ASEAN Economic Monitor WFOR - Forecast WCOM - Commodity Market WCOC - Country Competitiveness WAGR - Aggregates WASS - International Associations 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 CEICEPFRLI - EPFR Macro Flows CEICEPFRCF - EPFR Country Flow CEICEPFRCA - EPFR Country Allocations CEICEPFRFF - EPFR Fund Flow CEICGFI - GFI Fenics Market Data CEICMSCI - MSCI Global Equity Index DAILY - High Frequency Database ALT - Alternative Data FMS - Financial and Monetary Statistics HL - Health ASEAN - ASEAN Premium Database APBN - *ASEAN
database	list[str]	Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - World Trend Plus WGEM - Economic Monitor WESG - Environmental, Social and Governance WAEM - ASEAN Economic Monitor WFOR - Forecast WCOM - Commodity Market WCOC - Country Competitiveness WAGR - Aggregates WASS - International Associations 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 CEICEPFRLI - EPFR Macro Flows CEICEPFRCF - EPFR Country Flow CEICEPFRCA - EPFR Country Allocations CEICEPFRFF - EPFR Fund Flow CEICGFI - GFI Fenics Market Data CEICMSCI - MSCI Global Equity Index DAILY - High Frequency Database ALT - Alternative Data FMS - Financial and Monetary Statistics HL - Health ASEAN - ASEAN Premium Database APBN - *ASEAN
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
geo	list[str]	Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
status	list[str]	Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand
data_source	list[str]	Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series
series	list[str]	List of series
with_vintage_enabled_only	bool	If it is `true` result will contain ONLY vintage enabled series
headline_only	bool	Show only 'headline' series when set to `true`.
topic	list[str]	Topic filter. One or more comma separated topic code values.
section	list[str]	Section filter. One or more comma separated section code values.
table	list[str]	Table filter. One or more comma separated table code values.
order	list[str]	Sort order. Default is `relevance`.
direction	list[str]	Sort order direction. Default is `asc`. Accepted values
filter_id	list[str]	Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both.
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions
facet	list[str]	List of facets to return
release_date_from	date	Will return releases with first observation before `release_date_from`
release_date_to	date	Will return releases with last observation after `release_date_to`
release_status	list[str]	List of release statuses to return

Namespace: ceic_api_client.apis.series_api

Class: SeriesApi(api_client=None, token=None)

get_continuous_series((self, id, **kwargs))

Returns continuous series information . The method extends the history and fill gaps of active series by combining older and newer counterparts of comparable time series to generate a longer series. Depending on the dataset, data history is extended, and gaps are filled using a combination of geometric compounding and/or filling the missing time points with the comparable older/newer series. CEIC calculates geometric compounding by using the ratio of the first observation of the newer series and the corresponding overlapping time point from the older series, subsequently adjusting observations from the older series using this ratio (i.e., the linking factor). Series estimated using geometric compounding are rounded, if applicable. The method returns function description, chain_id and series IDs in the historical extension. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

ContinuousSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_continuous_series_time_points((self, id, chain_id, **kwargs))

Returns continuous series timepoints information . The method extends the history and fill gaps of active series by combining older and newer counterparts of comparable time series to generate a longer series. Depending on the dataset, data history is extended, and gaps are filled using a combination of geometric compounding and/or filling the missing time points with the comparable older/newer series. CEIC calculates geometric compounding by using the ratio of the first observation of the newer series and the corresponding overlapping time point from the older series, subsequently adjusting observations from the older series using this ratio (i.e., the linking factor). Series estimated using geometric compounding are rounded, if applicable. The method returns continuous series timepoints with applied functions. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

ContinuousSeriesWithAppliedFunctionsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
chain_id	str	The ID of the chain. Accepts only one ID. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions
with_historical_extension	bool	When set to true, series will include extended historical timepoints

get_series_earliest((self, id, **kwargs))

Returns earliest possible data for PIT enabled series. . Returns earliest possible series metadata and timepoints. Accepts one or more Series IDs or Series Codes. Requires a PIT enabled series! . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions
with_historical_extension	bool	When set to true, series will include extended historical timepoints

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SeriesStatisticsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
with_historical_extension	bool	When set to true, series will include extended historical timepoints

get_series_vintages((self, id, **kwargs))

Vintage timepoints . Returns the series timepoints with all vintage revisions as a subnode . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SeriesResultWithVintages If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
count	int	Limit the amount of latest time-points returned, by the number specified.
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
updated_after	datetime	Returns only the updated time-points after the date specified.
blank_observations	bool	If it's set to true, empty time-points will be returned
time_points_status	str	Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted
with_historical_extension	bool	When set to true, series will include extended historical timepoints

get_series_vintages_dates((self, id, **kwargs))

Lists vintage dates . List of all dates for the selected series . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

VintageDatesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
start_date	date	Vintages dates start date in ISO format.
end_date	date	Vintages dates end date in ISO format.
count	float	Number of timepoints to consider when extracting revision dates.

get_series_visual((self, id, **kwargs))

Returns visual image . Returns some chart/map/table image . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

str If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept	str	Response data format. Default is `image/png`.
format	str	Response data format. Default is `png`
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
token	str	Access API key.
vintage_revision_date	str	When specified will return vintages snapshot at the specified revision date (YYYY-MM-DD).
start_date	date	Limits the start date after which the time-points will be returned.
end_date	date	Limits the end date before which the time-points will be returned.
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions
width	float	Image width
height	float	Image height
period	float	Series time-pints mask. Example
type	str	Visual type

get_vintage_continuous_series((self, id, **kwargs))

Returns vintage continuous series information . The method extends the history and fill gaps of active series by combining older and newer counterparts of comparable time series to generate a longer series. Depending on the dataset, data history is extended, and gaps are filled using a combination of geometric compounding and/or filling the missing time points with the comparable older/newer series. CEIC calculates geometric compounding by using the ratio of the first observation of the newer series and the corresponding overlapping time point from the older series, subsequently adjusting observations from the older series using this ratio (i.e., the linking factor). Series estimated using geometric compounding are rounded, if applicable. The method returns function description, chain_id and series IDs in the historical extension. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

ContinuousSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_vintage_continuous_series_time_points((self, id, chain_id, **kwargs))

Returns vintage continuous series timepoints information . The method extends the history and fill gaps of active series by combining older and newer counterparts of comparable time series to generate a longer series. Depending on the dataset, data history is extended, and gaps are filled using a combination of geometric compounding and/or filling the missing time points with the comparable older/newer series. CEIC calculates geometric compounding by using the ratio of the first observation of the newer series and the corresponding overlapping time point from the older series, subsequently adjusting observations from the older series using this ratio (i.e., the linking factor). Series estimated using geometric compounding are rounded, if applicable. The method returns continuous series timepoints with applied functions. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

ContinuousSeriesWithAppliedFunctionsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
chain_id	str	The ID of the chain. Accepts only one ID. (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SearchSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
limit	float	Number of records to return in the range 1 - 100. Default is 100.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.
layout	list[str]	DEPRECATED. Please use `database` parameter. Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - World Trend Plus WGEM - Economic Monitor WESG - Environmental, Social and Governance WAEM - ASEAN Economic Monitor WFOR - Forecast WCOM - Commodity Market WCOC - Country Competitiveness WAGR - Aggregates WASS - International Associations 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 CEICEPFRLI - EPFR Macro Flows CEICEPFRCF - EPFR Country Flow CEICEPFRCA - EPFR Country Allocations CEICEPFRFF - EPFR Fund Flow CEICGFI - GFI Fenics Market Data CEICMSCI - MSCI Global Equity Index DAILY - High Frequency Database ALT - Alternative Data FMS - Financial and Monetary Statistics HL - Health ASEAN - ASEAN Premium Database APBN - *ASEAN
database	list[str]	Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - World Trend Plus WGEM - Economic Monitor WESG - Environmental, Social and Governance WAEM - ASEAN Economic Monitor WFOR - Forecast WCOM - Commodity Market WCOC - Country Competitiveness WAGR - Aggregates WASS - International Associations 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 CEICEPFRLI - EPFR Macro Flows CEICEPFRCF - EPFR Country Flow CEICEPFRCA - EPFR Country Allocations CEICEPFRFF - EPFR Fund Flow CEICGFI - GFI Fenics Market Data CEICMSCI - MSCI Global Equity Index DAILY - High Frequency Database ALT - Alternative Data FMS - Financial and Monetary Statistics HL - Health ASEAN - ASEAN Premium Database APBN - *ASEAN
keyword	str	Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips
strict_keyword_search	bool	When true, will make a strict keywords search instead of fuzzy search.
frequency	list[str]	Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal
country	list[str]	DEPRECATED. Please use `geo` parameter. Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries.
source	list[str]	Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
unit	list[str]	Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
indicator	list[str]	Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future!
region	list[str]	Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
subscribed_only	bool	Show only results for subscribed series when set to `true`. By default show results for all the series found.
key_only	bool	Show only 'key' series when set to `true`.
new_only	bool	Show only series created less than 1 month ago when set to `true`.
name_only	bool	This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes.
start_date_before	date	Will return series with first observation before `start_date_before`
end_date_after	date	Will return series with last observation after `end_date_after`
created_after	date	Will return entries created after `created_after` date
updated_after	date	Will return series last time updated after `updated_after` date and time
timepoints_updated_after	date	Will return series containing timepoints' last time updated after updated_after date and time
geo	list[str]	Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
status	list[str]	Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand
data_source	list[str]	Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series
series	list[str]	List of series
with_vintage_enabled_only	bool	If it is `true` result will contain ONLY vintage enabled series
headline_only	bool	Show only 'headline' series when set to `true`.
topic	list[str]	Topic filter. One or more comma separated topic code values.
section	list[str]	Section filter. One or more comma separated section code values.
table	list[str]	Table filter. One or more comma separated table code values.
order	list[str]	Sort order. Default is `relevance`.
direction	list[str]	Sort order direction. Default is `asc`. Accepted values
filter_id	list[str]	Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both.
with_replacements_metadata	bool	If it is `true` result will contain replacements metadata not only list of id`s
forecast_only	bool	If it is `true` result will only contain series with forecast
with_release_only	bool	If it is `true` result will only contain series with released schedule
with_replacements_only	bool	If it is `true` result will only contain series with suggestions
with_observations_only	bool	If it is `true` result will not contain series without observations
with_continuous_only	bool	If set to `true` results will contain only series with available historical extensions
facet	list[str]	List of facets to return

Namespace: ceic_api_client.apis.sessions_api

Class: SessionsApi(api_client=None, token=None)

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

Generate impersonate token . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

ImpersonateAPIKeyResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
employee_token	str	Impersonate API token generated on CAS service (required)
user_id	str	User Id (required)
application	str	Application ID (required)
expire_after	float	Token will be expired after `expire_after` in seconds

get_subscriptions((self, **kwargs))

Get user subscriptions . Get user subscriptions . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserSubscriptionsResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserSessionResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
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. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

SessionStatusResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
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 . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserCredentialsValidationResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
login	str	Username (required)
password	str	Password (required)

Namespace: ceic_api_client.apis.userdefined_api

Class: UserdefinedApi(api_client=None, token=None)

clone_ceic_series((self, **kwargs))

Clone CEIC series to a new userdefined series . Clones CEIC series. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserdefinedClonedSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
reference_series_id	int	CEIC series id, which the current userdefined series refers to.

delete_all_udd_series_time_points((self, id, **kwargs))

Deletes ALL series time-points . Deletes all series timepoints by provided series id. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserdefinedDeletedSeriesDataBulkDataResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Userdefined 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.

delete_single_udd_series((self, id, **kwargs))

Delete single userdefined series . Delete single userdefined series by provided series id. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserdefinedDeletedSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Userdefined series id. (required)

delete_udd_series_time_point((self, id, date, **kwargs))

Delete series time-point . Delete series timepoint. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserdefinedDeleteSeriesDataResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Userdefined series id. (required)
date	date	Timepoint date in format `YYYY-MM-DD` (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_single_udd_series((self, id, **kwargs))

Userdefined series list . Single userdefined series with metadata only. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserdefinedSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Userdefined 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.

get_udd_series((self, **kwargs))

Userdefined series list . Lists all userdefined series with metadata only. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserdefinedSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
limit	float	Number of records to return in the range 1 - 100. Default is 100.
offset	float	The offset from which the records will be returned. Used to get the next set of records when the limit is reached.

get_udd_series_time_points((self, id, **kwargs))

Returns series time-points . Returns series containing time-points data only. Accepts one or more Series ID. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserdefinedSeriesDataResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Userdefined 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.

patch_udd_series((self, frequency, name, unit, id, **kwargs))

Updates userdefined series with metadata . Updates existing userdefined series. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserdefinedCreatedSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
frequency	str	The frequency name. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (required)
name	str	Series name. (required)
unit	str	Unit abbreviation, ex
id	str	Userdefined 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.
country	str	Country name or ISO code.
remarks	str	Remark for the current series.
start_date	date	Series start date in ISO format.
subnational	str	Subnational.
user_series_id	str	The series id in the user source
category	str	The series category

patch_udd_series_time_point((self, id, date, value, **kwargs))

Patch series time-point . Patch series timepoint. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserdefinedCreateSeriesDataResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Userdefined series id. (required)
date	date	Timepoint date in format `YYYY-MM-DD` (required)
value	float	Timepoint value (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.

post_udd_series((self, frequency, name, unit, **kwargs))

Create userdefined series with metadata . Creates new userdefined series. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserdefinedCreatedSeriesResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
frequency	str	The frequency name. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (required)
name	str	Series name. (required)
unit	str	Unit abbreviation, ex
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.
country	str	Country name or ISO code.
remarks	str	Remark for the current series.
start_date	date	Series start date in ISO format.
reference_series_id	int	CEIC series id, which the current userdefined series refers to.
subnational	str	Subnational.
multiplier	str	Unit multiplier.
source_name	str	Name of the series source.
user_series_id	str	The series id in the user source
category	str	The series category

post_udd_series_time_points((self, id, body, **kwargs))

Creates series time-points . Creates series timepoints by provided `application/json` body. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

UserdefinedCreateSeriesDataResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Userdefined series id. (required)
body	list[UserdefinedTimepointData]	Timepoints data - list of timepoints to create. (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.

Namespace: ceic_api_client.apis.watchlist_api

Class: WatchlistApi(api_client=None, token=None)

create_watchlist((self, series_id, **kwargs))

Create Watchlist . Create watchlist subscription . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

WatchlistProcessedResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
series_id	str	Watchlist Series IDs, comma separated (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
popup_notifications	bool	If set to true enables popup notifications for watchlist subscription
email_notifications	str	If set, specifies the email notification frequency

delete_watchlist((self, id, **kwargs))

Delete watchlist . Removes provided series from watchlist subscription . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

WatchlistProcessedResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Watchlist Series IDs, comma separated (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

get_watchlist((self, **kwargs))

Lists all watchlist subscriptions . Lists all watchlist subscriptions the user have set. . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

WatchlistGetResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.

update_watchlist((self, id, **kwargs))

Update watchlist . Update watchlist subscription details . This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

Returns:

WatchlistProcessedResult If the method is called asynchronously, returns the request thread.

Parameters:

Name	Type	Description
id	str	Watchlist Series IDs, comma separated (required)
accept_language	str	Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
accept	str	Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`.
lang	str	Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese
format	str	Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`.
token	str	Access API key.
with_model_information	bool	If set to `true` returns the model names as part of the response.
popup_notifications	bool	If set to true enables popup notifications for watchlist subscription
email_notifications	str	If set, specifies the email notification frequency

Result Types:

ceic_api_client.models.base_series_information.BaseSeriesInformation(subscribed=None, metadata=None, layout=None, _configuration=None)

ceic_api_client.models.classification.Classification(id=None, name=None, _configuration=None)

ceic_api_client.models.classifications_result.ClassificationsResult(data=None, _configuration=None)

ceic_api_client.models.continuous_series_item.ContinuousSeriesItem(chain_id=None, function_description=None, series=None, _configuration=None)

ceic_api_client.models.continuous_series_list.ContinuousSeriesList(total=None, items=None, _configuration=None)

ceic_api_client.models.continuous_series_result.ContinuousSeriesResult(data=None, _configuration=None)

ceic_api_client.models.continuous_series_result_data.ContinuousSeriesResultData(items=None, total=None, _configuration=None)

ceic_api_client.models.continuous_series_time_point_item.ContinuousSeriesTimePointItem(value=None, date=None, _configuration=None)

ceic_api_client.models.continuous_series_with_applied_functions_list.ContinuousSeriesWithAppliedFunctionsList(time_points=None, _configuration=None)

ceic_api_client.models.continuous_series_with_applied_functions_result.ContinuousSeriesWithAppliedFunctionsResult(data=None, _configuration=None)

ceic_api_client.models.continuous_series_with_applied_functions_result_data.ContinuousSeriesWithAppliedFunctionsResultData(time_points=None, _configuration=None)

ceic_api_client.models.countries_result.CountriesResult(data=None, _configuration=None)

ceic_api_client.models.country.Country(id=None, name=None, _configuration=None)

ceic_api_client.models.dictionary_data.DictionaryData(indicators=None, classifications=None, regions=None, layouts=None, sources=None, countries=None, units=None, _configuration=None)

ceic_api_client.models.dictionary_result.DictionaryResult(data=None, _configuration=None)

ceic_api_client.models.dump_information.DumpInformation(id=None, name=None, description=None, filter_id=None, filter_name=None, filter_description=None, status=None, progress=None, total_series_number=None, collected_series_number=None, download_link=None, created=None, _configuration=None)

ceic_api_client.models.dump_list_information.DumpListInformation(dumps=None, _configuration=None)

ceic_api_client.models.dump_list_result.DumpListResult(data=None, _configuration=None)

ceic_api_client.models.dump_result.DumpResult(data=None, _configuration=None)

ceic_api_client.models.empty_object.EmptyObject(_configuration=None)

ceic_api_client.models.facet.Facet(id=None, items=None, _configuration=None)

ceic_api_client.models.facet_entry.FacetEntry(id=None, total=None, _configuration=None)

ceic_api_client.models.feed_information.FeedInformation(id=None, name=None, description=None, filter_id=None, filter_name=None, filter_description=None, status=None, user_id=None, frequency=None, created_at=None, feed_updated_at=None, language=None, consolidation_method=None, delivery_method=None, delivery_format=None, delivery_path=None, user_ftp_url=None, user_ftp_username=None, notification_email=None, notification_url=None, notification_http_method=None, updated_after=None, full_dump=None, metadata_only=None, _configuration=None)

ceic_api_client.models.feed_result.FeedResult(data=None, _configuration=None)

ceic_api_client.models.feeds_result.FeedsResult(data=None, _configuration=None)

ceic_api_client.models.filter_details.FilterDetails(series=None, search=None, _configuration=None)

ceic_api_client.models.filter_details_search.FilterDetailsSearch(_configuration=None)

ceic_api_client.models.filter_result.FilterResult(data=None, _configuration=None)

ceic_api_client.models.filters_result.FiltersResult(data=None, _configuration=None)

ceic_api_client.models.frequencies_result.FrequenciesResult(data=None, _configuration=None)

ceic_api_client.models.frequency.Frequency(id=None, name=None, _configuration=None)

ceic_api_client.models.geo.Geo(id=None, type=None, title=None, iso_code=None, _configuration=None)

ceic_api_client.models.geo_info.GeoInfo(id=None, code=None, name=None, type=None, parent_id=None, parents=None, _configuration=None)

ceic_api_client.models.geo_info_inner.GeoInfoInner(code=None, name=None, parents=None, parent_id=None, type=None, id=None)

ceic_api_client.models.geo_result.GeoResult(data=None, _configuration=None)

ceic_api_client.models.impersonate_api_key.ImpersonateAPIKey(token=None, _configuration=None)

ceic_api_client.models.impersonate_api_key_data.ImpersonateAPIKeyData(key=None)

ceic_api_client.models.impersonate_api_key_result.ImpersonateAPIKeyResult(data=None, _configuration=None)

ceic_api_client.models.indicator.Indicator(id=None, name=None, classification_id=None, _configuration=None)

ceic_api_client.models.indicators_chain.IndicatorsChain(_configuration=None)

ceic_api_client.models.indicators_chain_item.IndicatorsChainItem(id=None, name=None, _configuration=None)

ceic_api_client.models.indicators_result.IndicatorsResult(data=None, _configuration=None)

ceic_api_client.models.insight_download.InsightDownload(title=None, format=None, download_link=None, download_link_expiration=None, _configuration=None)

ceic_api_client.models.insight_download_result.InsightDownloadResult(data=None, _configuration=None)

ceic_api_client.models.insight_download_result_data.InsightDownloadResultData(download_link_expiration=None, format=None, download_link=None, title=None)

ceic_api_client.models.insight_series.InsightSeries(entity_id=None, insight_series=None, series_data=None, _configuration=None)

ceic_api_client.models.insight_series_information.InsightSeriesInformation(id=None, insight_id=None, name=None, deleted=None, group=None, type=None, applied_functions=None, _configuration=None)

ceic_api_client.models.insight_series_paginated_result.InsightSeriesPaginatedResult(data=None, _configuration=None)

ceic_api_client.models.insight_series_paginated_result_data.InsightSeriesPaginatedResultData(total=None, items=None, _configuration=None)

ceic_api_client.models.insight_series_result.InsightSeriesResult(data=None, _configuration=None)

ceic_api_client.models.insights.Insights(id=None, subscribed=None, name=None, description=None, creation_time=None, last_update_time=None, keywords=None, category=None, creator=None, last_editor=None, _configuration=None)

ceic_api_client.models.insights_categories_result.InsightsCategoriesResult(data=None, _configuration=None)

ceic_api_client.models.insights_category.InsightsCategory(id=None, name=None, parent=None, _configuration=None)

ceic_api_client.models.insights_result.InsightsResult(data=None, _configuration=None)

ceic_api_client.models.insights_search.InsightsSearch(total=None, items=None, _configuration=None)

ceic_api_client.models.insights_search_result.InsightsSearchResult(data=None, _configuration=None)

ceic_api_client.models.internal_series_remarks.InternalSeriesRemarks(entity_id=None, internal_remarks=None, _configuration=None)

ceic_api_client.models.layout.Layout(id=None, name=None, parent_id=None, _configuration=None)

ceic_api_client.models.layout_ancestors.LayoutAncestors(database=None, topic=None, section=None, table=None, _configuration=None)

ceic_api_client.models.layout_footnote_metadata.LayoutFootnoteMetadata(footnote=None, resources=None, _configuration=None)

ceic_api_client.models.layout_footnote_metadata_item.LayoutFootnoteMetadataItem(file_name=None, content_type=None, language_code=None, last_update_time=None, file_type=None, description=None, download_link=None, _configuration=None)

ceic_api_client.models.layout_footnote_metadata_result.LayoutFootnoteMetadataResult(data=None, _configuration=None)

ceic_api_client.models.layout_footnote_resource_metadata_item.LayoutFootnoteResourceMetadataItem(file_name=None, download_link=None, _configuration=None)

ceic_api_client.models.layout_full_metadata_item.LayoutFullMetadataItem(metadata=None, ancestors=None, _configuration=None)

ceic_api_client.models.layout_full_metadata_result.LayoutFullMetadataResult(data=None, _configuration=None)

ceic_api_client.models.layout_information.LayoutInformation(series_code=None, database=None, topic=None, section=None, table=None, _configuration=None)

ceic_api_client.models.layout_information_list.LayoutInformationList()

ceic_api_client.models.layout_item.LayoutItem(subscribed=None, series_count=None, metadata=None, ui=None, _configuration=None)

ceic_api_client.models.layout_item_metadata.LayoutItemMetadata(id=None, name=None, _configuration=None)

ceic_api_client.models.layout_item_ui.LayoutItemUI(display_order=None, _configuration=None)

ceic_api_client.models.layout_items_result.LayoutItemsResult(data=None, _configuration=None)

ceic_api_client.models.layouts_result.LayoutsResult(data=None, _configuration=None)

ceic_api_client.models.province.Province(id=None, name=None, _configuration=None)

ceic_api_client.models.region.Region(id=None, name=None, _configuration=None)

ceic_api_client.models.regions_result.RegionsResult(data=None, _configuration=None)

ceic_api_client.models.release_schedule_status.ReleaseScheduleStatus(id=None, name=None, _configuration=None)

ceic_api_client.models.release_schedule_type.ReleaseScheduleType(id=None, name=None, _configuration=None)

ceic_api_client.models.release_series.ReleaseSeries(series_id=None, name=None, unit=None, frequency=None, start_date=None, end_date=None, last_updated=None, source_name=None, _configuration=None)

ceic_api_client.models.release_series_list.ReleaseSeriesList(total=None, items=None, _configuration=None)

ceic_api_client.models.release_series_result.ReleaseSeriesResult(data=None, _configuration=None)

ceic_api_client.models.release_statuses_result.ReleaseStatusesResult(data=None, _configuration=None)

ceic_api_client.models.release_types_result.ReleaseTypesResult(data=None, _configuration=None)

ceic_api_client.models.response_error.ResponseError(status=None, code=None, message=None, _configuration=None)

ceic_api_client.models.search_series.SearchSeries(total=None, items=None, facets=None, _configuration=None)

ceic_api_client.models.search_series_result.SearchSeriesResult(data=None, _configuration=None)

ceic_api_client.models.series.Series(entity_id=None, subscribed=None, metadata=None, layout=None, ui=None, replacements=None, grouping=None, time_points=None, deleted_time_points=None, _configuration=None)

ceic_api_client.models.series_data.SeriesData(time_points=None, deleted_time_points=None, _configuration=None)

ceic_api_client.models.series_filter.SeriesFilter(id=None, name=None, description=None, created_at=None, last_updated_at=None, creator_id=None, filter_details=None, _configuration=None)

ceic_api_client.models.series_filter_filter_details.SeriesFilterFilterDetails(series=None, search=None)

ceic_api_client.models.series_grouping.SeriesGrouping(parent_code=None, short_name=None, _configuration=None)

ceic_api_client.models.series_information.SeriesInformation(subscribed=None, metadata=None, layout=None, ui=None, replacements=None, grouping=None, _configuration=None)

ceic_api_client.models.series_internal_remarks_result.SeriesInternalRemarksResult(data=None, _configuration=None)

ceic_api_client.models.series_metadata.SeriesMetadata(id=None, name=None, indicator=None, classification=None, unit=None, country=None, province=None, frequency=None, status=None, source=None, indicators=None, geo_info=None, remarks=None, mnemonic=None, trade_code=None, is_forecast=None, has_vintage=None, headline_series=None, has_schedule=None, series_tag=None, start_date=None, end_date=None, multiplier_code=None, last_update_time=None, timepoints_last_update_time=None, key_series=None, new_series=None, period_end=None, last_value=None, last_change=None, number_of_observations=None, has_continuous_series=None, _configuration=None)

ceic_api_client.models.series_metadata_last_change.SeriesMetadataLastChange(value=None, is_opposite=None, is_infinity=None, _configuration=None)

ceic_api_client.models.series_release_schedule_item.SeriesReleaseScheduleItem(code=None, timepoint_date=None, release_date=None, _from=None, to=None, release_type=None, release_status=None, _configuration=None)

ceic_api_client.models.series_release_schedule_result.SeriesReleaseScheduleResult(data=None)

ceic_api_client.models.series_release_schedule_search_result.SeriesReleaseScheduleSearchResult(data=None, _configuration=None)

ceic_api_client.models.series_releases.SeriesReleases(total=None, items=None, _configuration=None)

ceic_api_client.models.series_releases_search.SeriesReleasesSearch(total=None, items=None, _configuration=None)

ceic_api_client.models.series_replacements.SeriesReplacements(ids=None, series=None, _configuration=None)

ceic_api_client.models.series_result.SeriesResult(data=None, errors=None, _configuration=None)

ceic_api_client.models.series_result_with_vintages.SeriesResultWithVintages(data=None, errors=None, _configuration=None)

ceic_api_client.models.series_statistics.SeriesStatistics(min=None, max=None, median=None, mean=None, standard_deviation=None, coefficient_variation=None, variance=None, skewness=None, kurtosis=None, start_date=None, end_date=None, num_points=None, _configuration=None)

ceic_api_client.models.series_statistics_item.SeriesStatisticsItem(entity_id=None, statistics=None, _configuration=None)

ceic_api_client.models.series_statistics_result.SeriesStatisticsResult(data=None, _configuration=None)

ceic_api_client.models.userdefined_created_series_response.UserdefinedCreatedSeriesResponse(items=None, _configuration=None)

ceic_api_client.models.userdefined_created_series_result.UserdefinedCreatedSeriesResult(data=None, _configuration=None)

ceic_api_client.models.userdefined_created_time_point.UserdefinedCreatedTimePoint(value=None, date=None, _configuration=None)

ceic_api_client.models.userdefined_delete_series_data_result.UserdefinedDeleteSeriesDataResult(data=None, _configuration=None)

ceic_api_client.models.userdefined_deleted_series.UserdefinedDeletedSeries(id=None, _configuration=None)

ceic_api_client.models.userdefined_deleted_series_data_bulk_response.UserdefinedDeletedSeriesDataBulkResponse(items=None, _configuration=None)

ceic_api_client.models.userdefined_deleted_series_data_bulk_result.UserdefinedDeletedSeriesDataBulkResult(data=None, _configuration=None)

ceic_api_client.models.userdefined_deleted_series_data_response.UserdefinedDeletedSeriesDataResponse(items=None, _configuration=None)

ceic_api_client.models.userdefined_deleted_series_response.UserdefinedDeletedSeriesResponse(items=None, _configuration=None)

ceic_api_client.models.userdefined_deleted_series_result.UserdefinedDeletedSeriesResult(data=None, _configuration=None)

ceic_api_client.models.userdefined_deleted_time_point.UserdefinedDeletedTimePoint(date=None, _configuration=None)

ceic_api_client.models.userdefined_patch_series_data_result.UserdefinedPatchSeriesDataResult(data=None, _configuration=None)

ceic_api_client.models.userdefined_patched_series_data_response.UserdefinedPatchedSeriesDataResponse(items=None, _configuration=None)

ceic_api_client.models.userdefined_patched_time_point.UserdefinedPatchedTimePoint(value=None, _configuration=None)

ceic_api_client.models.userdefined_series.UserdefinedSeries(entity_id=None, metadata=None, _configuration=None)

ceic_api_client.models.userdefined_series_data_response.UserdefinedSeriesDataResponse(items=None, _configuration=None)

ceic_api_client.models.userdefined_series_data_result.UserdefinedSeriesDataResult(data=None, _configuration=None)

ceic_api_client.models.userdefined_series_metadata.UserdefinedSeriesMetadata(id=None, name=None, country=None, code=None, created_by=None, updated_by=None, level_two_username=None, level_three_username=None, unit=None, frequency=None, remarks=None, creation_time=None, last_update_time=None, user_series_id=None, _configuration=None)

ceic_api_client.models.userdefined_series_response.UserdefinedSeriesResponse(total=None, items=None, _configuration=None)

ceic_api_client.models.userdefined_series_result.UserdefinedSeriesResult(data=None, _configuration=None)

ceic_api_client.models.userdefined_time_point.UserdefinedTimePoint(value=None, date=None, _configuration=None)

ceic_api_client.models.userdefined_timepoint_data.UserdefinedTimepointData(date=None, value=None, _configuration=None)

ceic_api_client.models.vintage_date.VintageDate(date=None, revision_type=None, _configuration=None)

ceic_api_client.models.vintage_dates_result.VintageDatesResult(data=None, _configuration=None)

ceic_api_client.models.vintage_timepoint.VintageTimepoint(value=None, revision_date=None, _configuration=None)

ceic_api_client.models.watchlist_get_result.WatchlistGetResult(data=None, _configuration=None)

ceic_api_client.models.watchlist_item.WatchlistItem(series_id=None, is_subscribed=None, name=None, name_local=None, last_update_time=None, country_name=None, country_name_local=None, popup_notifications=None, email_notifications=None, _configuration=None)

ceic_api_client.models.watchlist_processed_information.WatchlistProcessedInformation(processed_items=None, _configuration=None)

ceic_api_client.models.watchlist_processed_result.WatchlistProcessedResult(data=None, errors=None, _configuration=None)

ceic_api_client.models.series_ui_settings.SeriesUISettings(separator_after_series=None, display_order=None, _configuration=None)

ceic_api_client.models.series_with_vintages.SeriesWithVintages(entity_id=None, subscribed=None, metadata=None, layout=None, ui=None, replacements=None, grouping=None, time_points=None, deleted_time_points=None, _configuration=None)

ceic_api_client.models.session_status.SessionStatus(session=None, destroyed=None, _configuration=None)

ceic_api_client.models.session_status_result.SessionStatusResult(data=None, _configuration=None)

ceic_api_client.models.source.Source(id=None, name=None, country_id=None, _configuration=None)

ceic_api_client.models.sources_result.SourcesResult(data=None, _configuration=None)

ceic_api_client.models.status.Status(id=None, name=None, _configuration=None)

ceic_api_client.models.statuses_result.StatusesResult(data=None, _configuration=None)

ceic_api_client.models.subscription_item.SubscriptionItem(service_code=None, product_code=None, _configuration=None)

ceic_api_client.models.time_point.TimePoint(value=None, date=None, last_update_time=None, _configuration=None)

ceic_api_client.models.time_point_with_vintages.TimePointWithVintages(value=None, date=None, last_update_time=None, vintages=None, _configuration=None)

ceic_api_client.models.unit.Unit(id=None, name=None, _configuration=None)

ceic_api_client.models.units_result.UnitsResult(data=None, _configuration=None)

ceic_api_client.models.user_credentials_validation_result.UserCredentialsValidationResult(data=None, _configuration=None)

ceic_api_client.models.user_credentials_validation_result_data.UserCredentialsValidationResultData(valid=None, _configuration=None)

ceic_api_client.models.user_information.UserInformation(id=None, email=None, first_name=None, last_name=None, _configuration=None)

ceic_api_client.models.user_session.UserSession(session=None, _configuration=None)

ceic_api_client.models.user_session_result.UserSessionResult(data=None, _configuration=None)

ceic_api_client.models.user_subscriptions_result.UserSubscriptionsResult(data=None, _configuration=None)

ceic_api_client.models.userdefined_cloned_series.UserdefinedClonedSeries(entity_id=None, id=None, series_code=None, reference_series_id=None, _configuration=None)

ceic_api_client.models.userdefined_cloned_series_response.UserdefinedClonedSeriesResponse(items=None, _configuration=None)

ceic_api_client.models.userdefined_cloned_series_result.UserdefinedClonedSeriesResult(data=None, _configuration=None)

ceic_api_client.models.userdefined_create_series_data_result.UserdefinedCreateSeriesDataResult(data=None, _configuration=None)

ceic_api_client.models.userdefined_created_series.UserdefinedCreatedSeries(entity_id=None, id=None, series_code=None, name=None, _configuration=None)

ceic_api_client.models.userdefined_created_series_data_response.UserdefinedCreatedSeriesDataResponse(items=None, _configuration=None)