Full Development Guide

  1. Home
  2. Documentation
  3. CEIC Macroeconomic Data API
  4. Javascript Documentation
  5. Full Development Guide

API Clients

Namespace: CEIC\api

Class: DictionaryApi ((CEIC\ApiClient) [apiClient] = CEIC\ApiClient.instance)

getClassificationIndicatorsWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\IndicatorsResult and HTTP response

Parameters:
Name Type Description
id String Classification ID.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getClassificationIndicators(id, opts)

Returns:

A Promise, with data of type CEIC\model\IndicatorsResult

Parameters:
Name Type Description
id String Classification ID.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getClassificationsWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\ClassificationsResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getClassifications(opts)

Returns:

A Promise, with data of type CEIC\model\ClassificationsResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getCountriesWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\CountriesResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getCountries(opts)

Returns:

A Promise, with data of type CEIC\model\CountriesResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getCountrySourcesWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\SourcesResult and HTTP response

Parameters:
Name Type Description
id String Country ISO code
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getCountrySources(id, opts)

Returns:

A Promise, with data of type CEIC\model\SourcesResult

Parameters:
Name Type Description
id String Country ISO code
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getDictionariesWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\DictionaryResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getDictionaries(opts)

Returns:

A Promise, with data of type CEIC\model\DictionaryResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getFrequenciesWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\FrequenciesResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getFrequencies(opts)

Returns:

A Promise, with data of type CEIC\model\FrequenciesResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getGeoWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\GeoResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getGeo(opts)

Returns:

A Promise, with data of type CEIC\model\GeoResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getIndicatorsWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\IndicatorsResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getIndicators(opts)

Returns:

A Promise, with data of type CEIC\model\IndicatorsResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getLayoutsWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\LayoutsResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getLayouts(opts)

Returns:

A Promise, with data of type CEIC\model\LayoutsResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getRegionsWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\RegionsResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getRegions(opts)

Returns:

A Promise, with data of type CEIC\model\RegionsResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getReleaseStatusesWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\ReleaseStatusesResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getReleaseStatuses(opts)

Returns:

A Promise, with data of type CEIC\model\ReleaseStatusesResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getReleaseTypesWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\ReleaseTypesResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getReleaseTypes(opts)

Returns:

A Promise, with data of type CEIC\model\ReleaseTypesResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getSourcesWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\SourcesResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getSources(opts)

Returns:

A Promise, with data of type CEIC\model\SourcesResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getStatusesWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\StatusesResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getStatuses(opts)

Returns:

A Promise, with data of type CEIC\model\StatusesResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getUnitsWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\UnitsResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getUnits(opts)

Returns:

A Promise, with data of type CEIC\model\UnitsResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)

Namespace: CEIC\api

Class: DumpsApi ((CEIC\ApiClient) [apiClient] = CEIC\ApiClient.instance)

cancelDumpWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\DumpResult and HTTP response

Parameters:
Name Type Description
id String Dump ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
cancelDump(id, opts)

Returns:

A Promise, with data of type CEIC\model\DumpResult

Parameters:
Name Type Description
id String Dump ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
createDataDumpWithHttpInfo(filterId, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\DumpResult and HTTP response

Parameters:
Name Type Description
filterId String Filter ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.name String Name of the new record. Max length 100
opts.description String Description of the new record. Max length 1000
opts.consolidation CEIC\model\String Consolidation Method (default to zip)
opts.delivery CEIC\model\String Delivery Method (default to web)
opts.userFtpUrl String Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (default to null)
opts.userFtpPath String Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. (default to /ceic_data_dumps/)
opts.userFtpUsername String Username for the local FTP server. Only valid when the localftp delivery method is selected. (default to null)
opts.userFtpPassword String Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (default to null)
opts.notificationEmail String When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (default to null)
opts.notificationUrl String URL for push notification upon dump completion. (default to null)
opts.notificationHttpMethod CEIC\model\String HTTP Method for push notifications. (default to GET)
createDataDump(filterId, opts)

Returns:

A Promise, with data of type CEIC\model\DumpResult

Parameters:
Name Type Description
filterId String Filter ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.name String Name of the new record. Max length 100
opts.description String Description of the new record. Max length 1000
opts.consolidation CEIC\model\String Consolidation Method (default to zip)
opts.delivery CEIC\model\String Delivery Method (default to web)
opts.userFtpUrl String Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (default to null)
opts.userFtpPath String Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. (default to /ceic_data_dumps/)
opts.userFtpUsername String Username for the local FTP server. Only valid when the localftp delivery method is selected. (default to null)
opts.userFtpPassword String Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (default to null)
opts.notificationEmail String When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (default to null)
opts.notificationUrl String URL for push notification upon dump completion. (default to null)
opts.notificationHttpMethod CEIC\model\String HTTP Method for push notifications. (default to GET)
getDataDumpWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\DumpResult and HTTP response

Parameters:
Name Type Description
id String Dump ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getDataDump(id, opts)

Returns:

A Promise, with data of type CEIC\model\DumpResult

Parameters:
Name Type Description
id String Dump ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
listUserDumpsWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\DumpListResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.createdAfter Date Will return entries created after `created_after` date
opts.createdBefore Date Will return entries created after `created_before` date
opts.filterId String 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.
opts.createdOrder CEIC\model\String Choose whether to order the entries ascending or descending. Default is Ascending (default to ASC)
opts.status Array.<CEIC\model\String> Dump status
opts.feedId String Feed ID
listUserDumps(opts)

Returns:

A Promise, with data of type CEIC\model\DumpListResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.createdAfter Date Will return entries created after `created_after` date
opts.createdBefore Date Will return entries created after `created_before` date
opts.filterId String 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.
opts.createdOrder CEIC\model\String Choose whether to order the entries ascending or descending. Default is Ascending (default to ASC)
opts.status Array.<CEIC\model\String> Dump status
opts.feedId String Feed ID

Namespace: CEIC\api

Class: FeedsApi ((CEIC\ApiClient) [apiClient] = CEIC\ApiClient.instance)

createFeedWithHttpInfo(filterId, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\FeedResult and HTTP response

Parameters:
Name Type Description
filterId String Filter ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.name String Name of the new record. Max length 100
opts.description String Description of the new record. Max length 1000
opts.consolidation CEIC\model\String Consolidation Method (default to zip)
opts.delivery CEIC\model\String Delivery Method (default to web)
opts.userFtpUrl String Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (default to null)
opts.userFtpPath String Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. (default to /ceic_data_dumps/)
opts.userFtpUsername String Username for the local FTP server. Only valid when the localftp delivery method is selected. (default to null)
opts.userFtpPassword String Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (default to null)
opts.notificationEmail String When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (default to null)
opts.notificationUrl String URL for push notification upon dump completion. (default to null)
opts.notificationHttpMethod CEIC\model\String HTTP Method for push notifications. (default to GET)
opts.frequency Number Feed generation frequency (default to 1440)
opts.fullDump Boolean 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. (default to false)
createFeed(filterId, opts)

Returns:

A Promise, with data of type CEIC\model\FeedResult

Parameters:
Name Type Description
filterId String Filter ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.name String Name of the new record. Max length 100
opts.description String Description of the new record. Max length 1000
opts.consolidation CEIC\model\String Consolidation Method (default to zip)
opts.delivery CEIC\model\String Delivery Method (default to web)
opts.userFtpUrl String Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (default to null)
opts.userFtpPath String Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. (default to /ceic_data_dumps/)
opts.userFtpUsername String Username for the local FTP server. Only valid when the localftp delivery method is selected. (default to null)
opts.userFtpPassword String Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (default to null)
opts.notificationEmail String When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (default to null)
opts.notificationUrl String URL for push notification upon dump completion. (default to null)
opts.notificationHttpMethod CEIC\model\String HTTP Method for push notifications. (default to GET)
opts.frequency Number Feed generation frequency (default to 1440)
opts.fullDump Boolean 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. (default to false)
deleteFeedWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\FeedInformation and HTTP response

Parameters:
Name Type Description
id String Feed ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
deleteFeed(id, opts)

Returns:

A Promise, with data of type CEIC\model\FeedInformation

Parameters:
Name Type Description
id String Feed ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getFeedWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\FeedInformation and HTTP response

Parameters:
Name Type Description
id String Feed ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getFeed(id, opts)

Returns:

A Promise, with data of type CEIC\model\FeedInformation

Parameters:
Name Type Description
id String Feed ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getFeedsWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\FeedsResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.createdAfter Date Will return entries created after `created_after` date
opts.createdBefore Date Will return entries created after `created_before` date
opts.filterId String 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.
opts.createdOrder CEIC\model\String Choose whether to order the entries ascending or descending. Default is Ascending (default to ASC)
opts.status Array.<CEIC\model\String> Feed status
getFeeds(opts)

Returns:

A Promise, with data of type CEIC\model\FeedsResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.createdAfter Date Will return entries created after `created_after` date
opts.createdBefore Date Will return entries created after `created_before` date
opts.filterId String 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.
opts.createdOrder CEIC\model\String Choose whether to order the entries ascending or descending. Default is Ascending (default to ASC)
opts.status Array.<CEIC\model\String> Feed status
updateFeedWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\FeedInformation and HTTP response

Parameters:
Name Type Description
id String Feed ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.name String Name of the new record. Max length 100
opts.description String Description of the new record. Max length 1000
opts.consolidation CEIC\model\String Consolidation Method (default to zip)
opts.delivery CEIC\model\String Delivery Method (default to web)
opts.userFtpUrl String Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (default to null)
opts.userFtpPath String Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. (default to /ceic_data_dumps/)
opts.userFtpUsername String Username for the local FTP server. Only valid when the localftp delivery method is selected. (default to null)
opts.userFtpPassword String Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (default to null)
opts.notificationEmail String When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (default to null)
opts.notificationUrl String URL for push notification upon dump completion. (default to null)
opts.notificationHttpMethod CEIC\model\String HTTP Method for push notifications. (default to GET)
opts.frequency Number Feed generation frequency (default to 1440)
opts.fullDump Boolean 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. (default to false)
opts.status CEIC\model\String Feed status
opts.filterId String Filter ID
updateFeed(id, opts)

Returns:

A Promise, with data of type CEIC\model\FeedInformation

Parameters:
Name Type Description
id String Feed ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.name String Name of the new record. Max length 100
opts.description String Description of the new record. Max length 1000
opts.consolidation CEIC\model\String Consolidation Method (default to zip)
opts.delivery CEIC\model\String Delivery Method (default to web)
opts.userFtpUrl String Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (default to null)
opts.userFtpPath String Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. (default to /ceic_data_dumps/)
opts.userFtpUsername String Username for the local FTP server. Only valid when the localftp delivery method is selected. (default to null)
opts.userFtpPassword String Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (default to null)
opts.notificationEmail String When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (default to null)
opts.notificationUrl String URL for push notification upon dump completion. (default to null)
opts.notificationHttpMethod CEIC\model\String HTTP Method for push notifications. (default to GET)
opts.frequency Number Feed generation frequency (default to 1440)
opts.fullDump Boolean 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. (default to false)
opts.status CEIC\model\String Feed status
opts.filterId String Filter ID

Namespace: CEIC\api

Class: FiltersApi ((CEIC\ApiClient) [apiClient] = CEIC\ApiClient.instance)

createFilterWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\FilterResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.series Array.<String> List of series, comma separated. Its length cannot be more than 100000.
opts.name String Name of the new record. Max length 100
opts.description String Description of the new record. Max length 1000
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.topic Array.<String> Topic filter. One or more comma separated topic code values.
opts.section Array.<String> Section filter. One or more comma separated section code values.
opts.table Array.<String> Table filter. One or more comma separated table code values.
opts.status Array.<CEIC\model\String> 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 (default to ["T"])
opts.dataSource Array.<CEIC\model\String> 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
opts.order Array.<CEIC\model\String> Sort order. Default is `relevance`.
opts.database Array.<CEIC\model\String> 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* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.direction Array.<CEIC\model\String> Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending
createFilter(opts)

Returns:

A Promise, with data of type CEIC\model\FilterResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.series Array.<String> List of series, comma separated. Its length cannot be more than 100000.
opts.name String Name of the new record. Max length 100
opts.description String Description of the new record. Max length 1000
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.topic Array.<String> Topic filter. One or more comma separated topic code values.
opts.section Array.<String> Section filter. One or more comma separated section code values.
opts.table Array.<String> Table filter. One or more comma separated table code values.
opts.status Array.<CEIC\model\String> 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 (default to ["T"])
opts.dataSource Array.<CEIC\model\String> 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
opts.order Array.<CEIC\model\String> Sort order. Default is `relevance`.
opts.database Array.<CEIC\model\String> 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* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.direction Array.<CEIC\model\String> Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending
deleteFiltersWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\EmptyObject and HTTP response

Parameters:
Name Type Description
id String Filter ID. Accepts one or more comma separated values.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
deleteFilters(id, opts)

Returns:

A Promise, with data of type CEIC\model\EmptyObject

Parameters:
Name Type Description
id String Filter ID. Accepts one or more comma separated values.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getFiltersWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\FiltersResult and HTTP response

Parameters:
Name Type Description
id String Filter ID. Accepts one or more comma separated values.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getFilters(id, opts)

Returns:

A Promise, with data of type CEIC\model\FiltersResult

Parameters:
Name Type Description
id String Filter ID. Accepts one or more comma separated values.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getUserFiltersWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\FiltersResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getUserFilters(opts)

Returns:

A Promise, with data of type CEIC\model\FiltersResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
updateFilterWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\FilterResult and HTTP response

Parameters:
Name Type Description
id String A single Filter ID value
opts Object Optional parameters
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.series Array.<String> List of series, comma separated. Its length cannot be more than 100000.
opts.name String Name of the new record. Max length 100
opts.description String Description of the new record. Max length 1000
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.topic Array.<String> Topic filter. One or more comma separated topic code values.
opts.section Array.<String> Section filter. One or more comma separated section code values.
opts.table Array.<String> Table filter. One or more comma separated table code values.
opts.status Array.<CEIC\model\String> 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 (default to ["T"])
opts.dataSource Array.<CEIC\model\String> 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
opts.order Array.<CEIC\model\String> Sort order. Default is `relevance`.
opts.database Array.<CEIC\model\String> 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* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.direction Array.<CEIC\model\String> Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending
updateFilter(id, opts)

Returns:

A Promise, with data of type CEIC\model\FilterResult

Parameters:
Name Type Description
id String A single Filter ID value
opts Object Optional parameters
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.series Array.<String> List of series, comma separated. Its length cannot be more than 100000.
opts.name String Name of the new record. Max length 100
opts.description String Description of the new record. Max length 1000
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.topic Array.<String> Topic filter. One or more comma separated topic code values.
opts.section Array.<String> Section filter. One or more comma separated section code values.
opts.table Array.<String> Table filter. One or more comma separated table code values.
opts.status Array.<CEIC\model\String> 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 (default to ["T"])
opts.dataSource Array.<CEIC\model\String> 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
opts.order Array.<CEIC\model\String> Sort order. Default is `relevance`.
opts.database Array.<CEIC\model\String> 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* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.direction Array.<CEIC\model\String> Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending

Namespace: CEIC\api

Class: InsightsApi ((CEIC\ApiClient) [apiClient] = CEIC\ApiClient.instance)

downloadInsightWithHttpInfo(id, fileFormat, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\InsightDownloadResult and HTTP response

Parameters:
Name Type Description
id String Insight ID
fileFormat CEIC\model\String Insight report file format. Available formats: `xlsx`, `pdf`
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.ignoreCache Boolean New file will be generated (default to false)
opts.adjustColumns CEIC\model\String No adjust or wrap text in XLSX cell (default to no)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.blankObservations CEIC\model\String If set to true, will return empty time-points which oterwise are omitted. (default to filter)
opts.orientation CEIC\model\String Columns/rows orientation (default to cols)
opts.order CEIC\model\String Sort order - Asc/Desc (default to asc)
opts.decimalPlaces Number Decimal places for the time-points values (default to 3)
opts.dateFormat String Time-points date format
downloadInsight(id, fileFormat, opts)

Returns:

A Promise, with data of type CEIC\model\InsightDownloadResult

Parameters:
Name Type Description
id String Insight ID
fileFormat CEIC\model\String Insight report file format. Available formats: `xlsx`, `pdf`
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.ignoreCache Boolean New file will be generated (default to false)
opts.adjustColumns CEIC\model\String No adjust or wrap text in XLSX cell (default to no)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.blankObservations CEIC\model\String If set to true, will return empty time-points which oterwise are omitted. (default to filter)
opts.orientation CEIC\model\String Columns/rows orientation (default to cols)
opts.order CEIC\model\String Sort order - Asc/Desc (default to asc)
opts.decimalPlaces Number Decimal places for the time-points values (default to 3)
opts.dateFormat String Time-points date format
getGalleryInsightsCategoriesWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\InsightsCategoriesResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getGalleryInsightsCategories(opts)

Returns:

A Promise, with data of type CEIC\model\InsightsCategoriesResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getInsightWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\InsightsResult and HTTP response

Parameters:
Name Type Description
id String Insight ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getInsight(id, opts)

Returns:

A Promise, with data of type CEIC\model\InsightsResult

Parameters:
Name Type Description
id String Insight ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getInsightSeriesWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\InsightSeriesPaginatedResult and HTTP response

Parameters:
Name Type Description
id String Insight ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.updatedAfter Date Returns only the updated time-points after the date specified.
opts.blankObservations Boolean If it's set to true, empty time-points will be returned (default to false)
opts.timePointsStatus CEIC\model\String Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (default to active)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
getInsightSeries(id, opts)

Returns:

A Promise, with data of type CEIC\model\InsightSeriesPaginatedResult

Parameters:
Name Type Description
id String Insight ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.updatedAfter Date Returns only the updated time-points after the date specified.
opts.blankObservations Boolean If it's set to true, empty time-points will be returned (default to false)
opts.timePointsStatus CEIC\model\String Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (default to active)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
getInsightSeriesDataWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\InsightSeriesPaginatedResult and HTTP response

Parameters:
Name Type Description
id String Insight ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.updatedAfter Date Returns only the updated time-points after the date specified.
opts.blankObservations Boolean If it's set to true, empty time-points will be returned (default to false)
opts.timePointsStatus CEIC\model\String Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (default to active)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
getInsightSeriesData(id, opts)

Returns:

A Promise, with data of type CEIC\model\InsightSeriesPaginatedResult

Parameters:
Name Type Description
id String Insight ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.updatedAfter Date Returns only the updated time-points after the date specified.
opts.blankObservations Boolean If it's set to true, empty time-points will be returned (default to false)
opts.timePointsStatus CEIC\model\String Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (default to active)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
getInsightSeriesListWithHttpInfo(seriesId, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\InsightSeriesResult and HTTP response

Parameters:
Name Type Description
seriesId String Insight Series ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.updatedAfter Date Returns only the updated time-points after the date specified.
opts.blankObservations Boolean If it's set to true, empty time-points will be returned (default to false)
opts.timePointsStatus CEIC\model\String Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (default to active)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
getInsightSeriesList(seriesId, opts)

Returns:

A Promise, with data of type CEIC\model\InsightSeriesResult

Parameters:
Name Type Description
seriesId String Insight Series ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.updatedAfter Date Returns only the updated time-points after the date specified.
opts.blankObservations Boolean If it's set to true, empty time-points will be returned (default to false)
opts.timePointsStatus CEIC\model\String Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (default to active)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
getInsightSeriesListDataWithHttpInfo(seriesId, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\InsightSeriesResult and HTTP response

Parameters:
Name Type Description
seriesId String Insight Series ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.updatedAfter Date Returns only the updated time-points after the date specified.
opts.blankObservations Boolean If it's set to true, empty time-points will be returned (default to false)
opts.timePointsStatus CEIC\model\String Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (default to active)
getInsightSeriesListData(seriesId, opts)

Returns:

A Promise, with data of type CEIC\model\InsightSeriesResult

Parameters:
Name Type Description
seriesId String Insight Series ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.updatedAfter Date Returns only the updated time-points after the date specified.
opts.blankObservations Boolean If it's set to true, empty time-points will be returned (default to false)
opts.timePointsStatus CEIC\model\String Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (default to active)
getInsightSeriesListMetadataWithHttpInfo(seriesId, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\InsightSeriesResult and HTTP response

Parameters:
Name Type Description
seriesId String Insight Series ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
getInsightSeriesListMetadata(seriesId, opts)

Returns:

A Promise, with data of type CEIC\model\InsightSeriesResult

Parameters:
Name Type Description
seriesId String Insight Series ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
getInsightSeriesMetadataWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\InsightSeriesPaginatedResult and HTTP response

Parameters:
Name Type Description
id String Insight ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
getInsightSeriesMetadata(id, opts)

Returns:

A Promise, with data of type CEIC\model\InsightSeriesPaginatedResult

Parameters:
Name Type Description
id String Insight ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
getInsightsWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\InsightsResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getInsights(opts)

Returns:

A Promise, with data of type CEIC\model\InsightsResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getInsightsCategoriesWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\InsightsCategoriesResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getInsightsCategories(opts)

Returns:

A Promise, with data of type CEIC\model\InsightsCategoriesResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
searchInsightsWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\InsightsSearchResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.group CEIC\model\String Insights group. Default is `my`. (default to my)
opts.limit Number Number of records to return (default to 30)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.order Object Sort order (default to edit_date)
opts.direction Object Sort order direction (default to asc)
opts.tags Array.<String> List of insight tags to search by tag
opts.categories Array.<String> List of insights categories to search by category
searchInsights(opts)

Returns:

A Promise, with data of type CEIC\model\InsightsSearchResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.group CEIC\model\String Insights group. Default is `my`. (default to my)
opts.limit Number Number of records to return (default to 30)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.order Object Sort order (default to edit_date)
opts.direction Object Sort order direction (default to asc)
opts.tags Array.<String> List of insight tags to search by tag
opts.categories Array.<String> List of insights categories to search by category

Namespace: CEIC\api

Class: InternalApi ((CEIC\ApiClient) [apiClient] = CEIC\ApiClient.instance)

getInternalRemarksWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\SeriesInternalRemarksResult and HTTP response

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
getInternalRemarks(id, opts)

Returns:

A Promise, with data of type CEIC\model\SeriesInternalRemarksResult

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)

Namespace: CEIC\api

Class: LayoutApi ((CEIC\ApiClient) [apiClient] = CEIC\ApiClient.instance)

getLayoutDatabasesWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\LayoutItemsResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T","C","B","D"])
opts.filterId Array.<String> 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.
getLayoutDatabases(opts)

Returns:

A Promise, with data of type CEIC\model\LayoutItemsResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T","C","B","D"])
opts.filterId Array.<String> 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.
getLayoutFootnoteWithHttpInfo(nodeCode, opts)

Returns:

A Promise, with an object containing data of type @link 'String' and HTTP response

Parameters:
Name Type Description
nodeCode String Node Code - Database ID, Topic ID, Section ID or Table ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
getLayoutFootnote(nodeCode, opts)

Returns:

A Promise, with data of type @link 'String'

Parameters:
Name Type Description
nodeCode String Node Code - Database ID, Topic ID, Section ID or Table ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
getLayoutFootnoteMetadataWithHttpInfo(nodeCode, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\LayoutFootnoteMetadataResult and HTTP response

Parameters:
Name Type Description
nodeCode String Node Code - Database ID, Topic ID, Section ID or Table ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getLayoutFootnoteMetadata(nodeCode, opts)

Returns:

A Promise, with data of type CEIC\model\LayoutFootnoteMetadataResult

Parameters:
Name Type Description
nodeCode String Node Code - Database ID, Topic ID, Section ID or Table ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getLayoutFootnoteResourceWithHttpInfo(nodeCode, fileName, opts)

Returns:

A Promise, with an object containing data of type @link 'String' and HTTP response

Parameters:
Name Type Description
nodeCode String Node Code - Database ID, Topic ID, Section ID or Table ID
fileName String Resource file name
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
getLayoutFootnoteResource(nodeCode, fileName, opts)

Returns:

A Promise, with data of type @link 'String'

Parameters:
Name Type Description
nodeCode String Node Code - Database ID, Topic ID, Section ID or Table ID
fileName String Resource file name
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
getLayoutFullMetadataWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\LayoutFullMetadataResult and HTTP response

Parameters:
Name Type Description
id String Node ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getLayoutFullMetadata(id, opts)

Returns:

A Promise, with data of type CEIC\model\LayoutFullMetadataResult

Parameters:
Name Type Description
id String Node ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getLayoutFullMetadata_0WithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\LayoutFullMetadataResult and HTTP response

Parameters:
Name Type Description
id String Node ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getLayoutFullMetadata_0(id, opts)

Returns:

A Promise, with data of type CEIC\model\LayoutFullMetadataResult

Parameters:
Name Type Description
id String Node ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getLayoutFullMetadata_1WithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\LayoutFullMetadataResult and HTTP response

Parameters:
Name Type Description
id String Node ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getLayoutFullMetadata_1(id, opts)

Returns:

A Promise, with data of type CEIC\model\LayoutFullMetadataResult

Parameters:
Name Type Description
id String Node ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getLayoutSectionsWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\LayoutItemsResult and HTTP response

Parameters:
Name Type Description
id String Topic ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T","C","B","D"])
opts.filterId Array.<String> 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.
getLayoutSections(id, opts)

Returns:

A Promise, with data of type CEIC\model\LayoutItemsResult

Parameters:
Name Type Description
id String Topic ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T","C","B","D"])
opts.filterId Array.<String> 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.
getLayoutSeriesWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\SeriesResult and HTTP response

Parameters:
Name Type Description
id String Table ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T","C","B","D"])
opts.filterId Array.<String> 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.
getLayoutSeries(id, opts)

Returns:

A Promise, with data of type CEIC\model\SeriesResult

Parameters:
Name Type Description
id String Table ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T","C","B","D"])
opts.filterId Array.<String> 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.
getLayoutTablesWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\LayoutItemsResult and HTTP response

Parameters:
Name Type Description
id String Section ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T","C","B","D"])
opts.filterId Array.<String> 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.
getLayoutTables(id, opts)

Returns:

A Promise, with data of type CEIC\model\LayoutItemsResult

Parameters:
Name Type Description
id String Section ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T","C","B","D"])
opts.filterId Array.<String> 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.
getLayoutTopicsWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\LayoutItemsResult and HTTP response

Parameters:
Name Type Description
id String Database ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T","C","B","D"])
opts.filterId Array.<String> 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.
getLayoutTopics(id, opts)

Returns:

A Promise, with data of type CEIC\model\LayoutItemsResult

Parameters:
Name Type Description
id String Database ID
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T","C","B","D"])
opts.filterId Array.<String> 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

Class: ReleasesApi ((CEIC\ApiClient) [apiClient] = CEIC\ApiClient.instance)

getReleaseSeriesWithHttpInfo(code, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\ReleaseSeriesResult and HTTP response

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

Returns:

A Promise, with data of type CEIC\model\ReleaseSeriesResult

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

Returns:

A Promise, with an object containing data of type CEIC\model\SeriesReleaseScheduleSearchResult and HTTP response

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.releaseDateFrom Date Will return releases with first observation before `release_date_from`
opts.releaseDateTo Date Will return releases with last observation after `release_date_to`
opts.releaseStatus Array.<CEIC\model\String> List of release statuses to return
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
getSeriesReleases(id, opts)

Returns:

A Promise, with data of type CEIC\model\SeriesReleaseScheduleSearchResult

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.releaseDateFrom Date Will return releases with first observation before `release_date_from`
opts.releaseDateTo Date Will return releases with last observation after `release_date_to`
opts.releaseStatus Array.<CEIC\model\String> List of release statuses to return
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
searchSeriesReleasesWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\SeriesReleaseScheduleSearchResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
opts.layout Array.<CEIC\model\String> **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* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.database Array.<CEIC\model\String> 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* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T"])
opts.dataSource Array.<CEIC\model\String> 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
opts.series Array.<String> List of series
opts.topic Array.<String> Topic filter. One or more comma separated topic code values.
opts.section Array.<String> Section filter. One or more comma separated section code values.
opts.table Array.<String> Table filter. One or more comma separated table code values.
opts.order Array.<CEIC\model\String> Sort order. Default is `relevance`.
opts.direction Array.<CEIC\model\String> Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending
opts.filterId Array.<String> 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.
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
opts.facet Array.<CEIC\model\String> List of facets to return
opts.releaseDateFrom Date Will return releases with first observation before `release_date_from`
opts.releaseDateTo Date Will return releases with last observation after `release_date_to`
opts.releaseStatus Array.<CEIC\model\String> List of release statuses to return
searchSeriesReleases(opts)

Returns:

A Promise, with data of type CEIC\model\SeriesReleaseScheduleSearchResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
opts.layout Array.<CEIC\model\String> **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* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.database Array.<CEIC\model\String> 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* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T"])
opts.dataSource Array.<CEIC\model\String> 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
opts.series Array.<String> List of series
opts.topic Array.<String> Topic filter. One or more comma separated topic code values.
opts.section Array.<String> Section filter. One or more comma separated section code values.
opts.table Array.<String> Table filter. One or more comma separated table code values.
opts.order Array.<CEIC\model\String> Sort order. Default is `relevance`.
opts.direction Array.<CEIC\model\String> Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending
opts.filterId Array.<String> 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.
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
opts.facet Array.<CEIC\model\String> List of facets to return
opts.releaseDateFrom Date Will return releases with first observation before `release_date_from`
opts.releaseDateTo Date Will return releases with last observation after `release_date_to`
opts.releaseStatus Array.<CEIC\model\String> List of release statuses to return

Namespace: CEIC\api

Class: SeriesApi ((CEIC\ApiClient) [apiClient] = CEIC\ApiClient.instance)

getContinuousSeriesWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\ContinuousSeriesResult and HTTP response

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getContinuousSeries(id, opts)

Returns:

A Promise, with data of type CEIC\model\ContinuousSeriesResult

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getContinuousSeriesTimePointsWithHttpInfo(id, chainId, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\ContinuousSeriesWithAppliedFunctionsResult and HTTP response

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
chainId String The ID of the chain. Accepts only one ID.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getContinuousSeriesTimePoints(id, chainId, opts)

Returns:

A Promise, with data of type CEIC\model\ContinuousSeriesWithAppliedFunctionsResult

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
chainId String The ID of the chain. Accepts only one ID.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getSeriesWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\SeriesResult and HTTP response

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.updatedAfter Date Returns only the updated time-points after the date specified.
opts.blankObservations Boolean If it's set to true, empty time-points will be returned (default to false)
opts.timePointsStatus CEIC\model\String Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (default to active)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
opts.withHistoricalExtension Boolean When set to true, series will include extended historical timepoints (default to false)
getSeries(id, opts)

Returns:

A Promise, with data of type CEIC\model\SeriesResult

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.updatedAfter Date Returns only the updated time-points after the date specified.
opts.blankObservations Boolean If it's set to true, empty time-points will be returned (default to false)
opts.timePointsStatus CEIC\model\String Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (default to active)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
opts.withHistoricalExtension Boolean When set to true, series will include extended historical timepoints (default to false)
getSeriesMetadataWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\SeriesResult and HTTP response

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
getSeriesMetadata(id, opts)

Returns:

A Promise, with data of type CEIC\model\SeriesResult

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
getSeriesStatisticsWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\SeriesStatisticsResult and HTTP response

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getSeriesStatistics(id, opts)

Returns:

A Promise, with data of type CEIC\model\SeriesStatisticsResult

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getSeriesTimePointsWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\SeriesResult and HTTP response

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.updatedAfter Date Returns only the updated time-points after the date specified.
opts.blankObservations Boolean If it's set to true, empty time-points will be returned (default to false)
opts.timePointsStatus CEIC\model\String Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (default to active)
opts.withHistoricalExtension Boolean When set to true, series will include extended historical timepoints (default to false)
getSeriesTimePoints(id, opts)

Returns:

A Promise, with data of type CEIC\model\SeriesResult

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.count Number Limit the amount of latest time-points returned, by the number specified. (default to 3650)
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.updatedAfter Date Returns only the updated time-points after the date specified.
opts.blankObservations Boolean If it's set to true, empty time-points will be returned (default to false)
opts.timePointsStatus CEIC\model\String Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (default to active)
opts.withHistoricalExtension Boolean When set to true, series will include extended historical timepoints (default to false)
getSeriesVisualWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type @link 'Blob' and HTTP response

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.accept CEIC\model\String Response data format. Default is `image/png`. (default to image/png)
opts.format CEIC\model\String Response data format. Default is `png` (default to png)
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.token String Access API key.
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
opts.width Number Image width
opts.height Number Image height
opts.period Number Series time-pints mask. Example: 10y, 20m, 12d, 4w
opts.type CEIC\model\String Visual type (default to chart)
getSeriesVisual(id, opts)

Returns:

A Promise, with data of type @link 'Blob'

Parameters:
Name Type Description
id String Series ID or Series Code to return. Accepts only one series ID or series Code.
opts Object Optional parameters
opts.accept CEIC\model\String Response data format. Default is `image/png`. (default to image/png)
opts.format CEIC\model\String Response data format. Default is `png` (default to png)
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.token String Access API key.
opts.startDate Date Limits the start date after which the time-points will be returned.
opts.endDate Date Limits the end date before which the time-points will be returned.
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
opts.width Number Image width
opts.height Number Image height
opts.period Number Series time-pints mask. Example: 10y, 20m, 12d, 4w
opts.type CEIC\model\String Visual type (default to chart)
searchSeriesWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\SearchSeriesResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
opts.layout Array.<CEIC\model\String> **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* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.database Array.<CEIC\model\String> 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* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T"])
opts.dataSource Array.<CEIC\model\String> 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
opts.series Array.<String> List of series
opts.topic Array.<String> Topic filter. One or more comma separated topic code values.
opts.section Array.<String> Section filter. One or more comma separated section code values.
opts.table Array.<String> Table filter. One or more comma separated table code values.
opts.order Array.<CEIC\model\String> Sort order. Default is `relevance`.
opts.direction Array.<CEIC\model\String> Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending
opts.filterId Array.<String> 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.
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
opts.facet Array.<CEIC\model\String> List of facets to return
searchSeries(opts)

Returns:

A Promise, with data of type CEIC\model\SearchSeriesResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.limit Number Number of records to return in the range 1 - 100. Default is 100. (default to 100)
opts.offset Number The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (default to 0)
opts.layout Array.<CEIC\model\String> **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* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.database Array.<CEIC\model\String> 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* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.keyword String Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States
opts.strictKeywordSearch Boolean When true, will make a strict keywords search instead of fuzzy search. (default to false)
opts.frequency Array.<CEIC\model\String> 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
opts.country Array.<String> **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.
opts.source Array.<String> Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources.
opts.unit Array.<String> Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units.
opts.indicator Array.<String> 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!
opts.region Array.<String> Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions.
opts.subscribedOnly Boolean Show only results for subscribed series when set to `true`. By default show results for all the series found. (default to false)
opts.keyOnly Boolean Show only 'key' series when set to `true`. (default to false)
opts.newOnly Boolean Show only series created less than 1 month ago when set to `true`. (default to false)
opts.nameOnly Boolean 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. (default to false)
opts.startDateBefore Date Will return series with first observation before `start_date_before`
opts.endDateAfter Date Will return series with last observation after `end_date_after`
opts.createdAfter Date Will return entries created after `created_after` date
opts.updatedAfter Date Will return series last time updated after `updated_after` date
opts.geo Array.<String> Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids.
opts.status Array.<CEIC\model\String> 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 (default to ["T"])
opts.dataSource Array.<CEIC\model\String> 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
opts.series Array.<String> List of series
opts.topic Array.<String> Topic filter. One or more comma separated topic code values.
opts.section Array.<String> Section filter. One or more comma separated section code values.
opts.table Array.<String> Table filter. One or more comma separated table code values.
opts.order Array.<CEIC\model\String> Sort order. Default is `relevance`.
opts.direction Array.<CEIC\model\String> Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending
opts.filterId Array.<String> 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.
opts.withReplacementsMetadata Boolean If it is `true` result will contain replacements metadata not only list of id`s (default to false)
opts.forecastOnly Boolean If it is `true` result will only contain series with forecast (default to false)
opts.withReleaseOnly Boolean If it is `true` result will only contain series with released schedule (default to false)
opts.withReplacementsOnly Boolean If it is `true` result will only contain series with suggestions (default to false)
opts.withObservationsOnly Boolean If it is `true` result will not contain series without observations (default to false)
opts.withContinuousOnly Boolean If set to `true` results will contain only series with available historical extensions (default to false)
opts.facet Array.<CEIC\model\String> List of facets to return

Namespace: CEIC\api

Class: SessionsApi ((CEIC\ApiClient) [apiClient] = CEIC\ApiClient.instance)

generateImpersonateTokenWithHttpInfo(employeeToken, userId, application, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\ImpersonateAPIKeyResult and HTTP response

Parameters:
Name Type Description
employeeToken String Impersonate API token generated on CAS service
userId String User Id
application String Application ID
opts Object Optional parameters
opts.expireAfter Number Token will be expired after `expire_after` in seconds (default to 86400)
generateImpersonateToken(employeeToken, userId, application, opts)

Returns:

A Promise, with data of type CEIC\model\ImpersonateAPIKeyResult

Parameters:
Name Type Description
employeeToken String Impersonate API token generated on CAS service
userId String User Id
application String Application ID
opts Object Optional parameters
opts.expireAfter Number Token will be expired after `expire_after` in seconds (default to 86400)
getSubscriptionsWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\UserSubscriptionsResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getSubscriptions(opts)

Returns:

A Promise, with data of type CEIC\model\UserSubscriptionsResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
loginWithHttpInfo(login, password, application, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\UserSessionResult and HTTP response

Parameters:
Name Type Description
login String Username
password String Password
application String Application ID
opts Object Optional parameters
opts.applicationVersion String Application Version
login(login, password, application, opts)

Returns:

A Promise, with data of type CEIC\model\UserSessionResult

Parameters:
Name Type Description
login String Username
password String Password
application String Application ID
opts Object Optional parameters
opts.applicationVersion String Application Version
logoutWithHttpInfo(session)

Returns:

A Promise, with an object containing data of type CEIC\model\SessionStatusResult and HTTP response

Parameters:
Name Type Description
session String User session
logout(session)

Returns:

A Promise, with data of type CEIC\model\SessionStatusResult

Parameters:
Name Type Description
session String User session
validateCredentialsWithHttpInfo(login, password)

Returns:

A Promise, with an object containing data of type CEIC\model\UserCredentialsValidationResult and HTTP response

Parameters:
Name Type Description
login String Username
password String Password
validateCredentials(login, password)

Returns:

A Promise, with data of type CEIC\model\UserCredentialsValidationResult

Parameters:
Name Type Description
login String Username
password String Password

Namespace: CEIC\api

Class: WatchlistApi ((CEIC\ApiClient) [apiClient] = CEIC\ApiClient.instance)

createWatchlistWithHttpInfo(seriesId, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\WatchlistProcessedResult and HTTP response

Parameters:
Name Type Description
seriesId String Watchlist Series IDs, comma separated
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.popupNotifications Boolean If set to true enables popup notifications for watchlist subscription
opts.emailNotifications CEIC\model\String If set, specifies the email notification frequency
createWatchlist(seriesId, opts)

Returns:

A Promise, with data of type CEIC\model\WatchlistProcessedResult

Parameters:
Name Type Description
seriesId String Watchlist Series IDs, comma separated
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.popupNotifications Boolean If set to true enables popup notifications for watchlist subscription
opts.emailNotifications CEIC\model\String If set, specifies the email notification frequency
deleteWatchlistWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\WatchlistProcessedResult and HTTP response

Parameters:
Name Type Description
id String Watchlist Series IDs, comma separated
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
deleteWatchlist(id, opts)

Returns:

A Promise, with data of type CEIC\model\WatchlistProcessedResult

Parameters:
Name Type Description
id String Watchlist Series IDs, comma separated
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getWatchlistWithHttpInfo(opts)

Returns:

A Promise, with an object containing data of type CEIC\model\WatchlistGetResult and HTTP response

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
getWatchlist(opts)

Returns:

A Promise, with data of type CEIC\model\WatchlistGetResult

Parameters:
Name Type Description
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
updateWatchlistWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing data of type CEIC\model\WatchlistProcessedResult and HTTP response

Parameters:
Name Type Description
id String Watchlist Series IDs, comma separated
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.popupNotifications Boolean If set to true enables popup notifications for watchlist subscription
opts.emailNotifications CEIC\model\String If set, specifies the email notification frequency
updateWatchlist(id, opts)

Returns:

A Promise, with data of type CEIC\model\WatchlistProcessedResult

Parameters:
Name Type Description
id String Watchlist Series IDs, comma separated
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
opts.popupNotifications Boolean If set to true enables popup notifications for watchlist subscription
opts.emailNotifications CEIC\model\String If set, specifies the email notification frequency

Namespace: CEIC\api

Class: DefaultApi ((CEIC\ApiClient) [apiClient] = CEIC\ApiClient.instance)

dictionaryClassificationsIdIndicatorsOptionsWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing HTTP response

Parameters:
Name Type Description
id String Classification ID.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
dictionaryClassificationsIdIndicatorsOptions(id, opts)

Returns:

A Promise

Parameters:
Name Type Description
id String Classification ID.
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
dictionaryClassificationsOptionsWithHttpInfo()

Returns:

A Promise, with an object containing HTTP response

dictionaryClassificationsOptions()

Returns:

A Promise

dictionaryCountriesIdSourcesOptionsWithHttpInfo(id, opts)

Returns:

A Promise, with an object containing HTTP response

Parameters:
Name Type Description
id String Country ISO code
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
dictionaryCountriesIdSourcesOptions(id, opts)

Returns:

A Promise

Parameters:
Name Type Description
id String Country ISO code
opts Object Optional parameters
opts.acceptLanguage CEIC\model\String Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.accept CEIC\model\String Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.lang CEIC\model\String Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (default to en)
opts.format CEIC\model\String Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (default to json)
opts.token String Access API key.
opts.withModelInformation Boolean If set to `true` returns the model names as part of the response. (default to false)
dictionaryCountriesOptionsWithHttpInfo()

Returns:

A Promise, with an object containing HTTP response

dictionaryCountriesOptions()

Returns:

A Promise

dictionaryFrequenciesOptionsWithHttpInfo()

Returns:

A Promise, with an object containing HTTP response

dictionaryFrequenciesOptions()

Returns:

A Promise

dictionaryIndicatorsOptionsWithHttpInfo()

Returns:

A Promise, with an object containing HTTP response

dictionaryIndicatorsOptions()

Returns:

A Promise

dictionaryLayoutsOptionsWithHttpInfo()

Returns:

A Promise, with an object containing HTTP response

dictionaryLayoutsOptions()

Returns:

A Promise

dictionaryOptionsWithHttpInfo()

Returns:

A Promise, with an object containing HTTP response

dictionaryOptions()

Returns:

A Promise

dictionaryRegionsOptionsWithHttpInfo()

R