完整的开发指南

API Clients

命名空间: CEIC\api

类: DefaultApi((CEIC\ApiClient) apiClient = CEIC\ApiClient.instance)


dictionaryClassificationsIdIndicatorsOptions(id, opts)

返回值:

A Promise

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

dictionaryClassificationsOptions()

返回值:

A Promise


dictionaryCountriesIdSourcesOptions(id, opts)

返回值:

A Promise

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

dictionaryCountriesOptions()

返回值:

A Promise


dictionaryFrequenciesOptions()

返回值:

A Promise


dictionaryIndicatorsOptions()

返回值:

A Promise


dictionaryLayoutsOptions()

返回值:

A Promise


dictionaryOptions()

返回值:

A Promise


dictionaryRegionsOptions()

返回值:

A Promise


dictionarySourcesOptions()

返回值:

A Promise


dictionaryStatusesOptions()

返回值:

A Promise


dictionaryUnitsOptions()

返回值:

A Promise


dumpsIdOptions(id, opts)

返回值:

A Promise

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

dumpsOptions()

返回值:

A Promise


feedsIdOptions(id, opts)

返回值:

A Promise

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

feedsOptions()

返回值:

A Promise


filtersIdOptions(id, opts)

返回值:

A Promise

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

filtersOptions()

返回值:

A Promise


impersonateTokenOptions(employeeToken, userId, application, opts)

返回值:

A Promise

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

insightsCategoriesEmisOptions()

返回值:

A Promise


insightsCategoriesFocusEconomicsOptions()

返回值:

A Promise


insightsCategoriesGalleryOptions()

返回值:

A Promise


insightsCategoriesOptions()

返回值:

A Promise


insightsIdDownloadFileFormatOptions(id, fileFormat, opts)

返回值:

A Promise

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

insightsIdOptions(id, opts)

返回值:

A Promise

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

insightsIdSeriesDataOptions(id, opts)

返回值:

A Promise

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

insightsIdSeriesMetadataOptions(id, opts)

返回值:

A Promise

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

insightsIdSeriesOptions(id, opts)

返回值:

A Promise

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

insightsOptions()

返回值:

A Promise


insightsSearchOptions()

返回值:

A Promise


insightsSeriesSeriesIdDataOptions(seriesId, opts)

返回值:

A Promise

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

insightsSeriesSeriesIdMetadataOptions(seriesId, opts)

返回值:

A Promise

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

insightsSeriesSeriesIdOptions(seriesId, opts)

返回值:

A Promise

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

internalSeriesIdInternalRemarksOptions(id, opts)

返回值:

A Promise

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

layoutDatabasesIdTopicsOptions(id, opts)

返回值:

A Promise

参数:
名称 類型 描述
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.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.
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 (default to [T, C, B])
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.

layoutDatabasesOptions()

返回值:

A Promise


layoutNodeCodeFootnoteDownloadFileNameOptions(nodeCode, fileName, opts)

返回值:

A Promise

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

layoutNodeCodeFootnoteDownloadOptions(nodeCode, opts)

返回值:

A Promise

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

layoutNodeCodeFootnoteOptions(nodeCode, opts)

返回值:

A Promise

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

layoutSectionsIdOptions(id, opts)

返回值:

A Promise

参数:
名称 類型 描述
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)
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.
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 (default to [T, C, B])
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.

layoutSectionsIdTablesOptions(id, opts)

返回值:

A Promise

参数:
名称 類型 描述
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.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.
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 (default to [T, C, B])
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.

layoutTablesIdOptions(id, opts)

返回值:

A Promise

参数:
名称 類型 描述
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)
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.
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 (default to [T, C, B])
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.

layoutTablesIdSeriesOptions(id, opts)

返回值:

A Promise

参数:
名称 類型 描述
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.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.
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 (default to [T, C, B])
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.

layoutTopicsIdOptions(id, opts)

返回值:

A Promise

参数:
名称 類型 描述
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)
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.
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 (default to [T, C, B])
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.

layoutTopicsIdSectionsOptions(id, opts)

返回值:

A Promise

参数:
名称 類型 描述
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.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.
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 (default to [T, C, B])
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.

loginOptions()

返回值:

A Promise


logoutSessionOptions(session)

返回值:

A Promise

参数:
名称 類型 描述
session String User session

releasesCodeSeriesOptions(code, opts)

返回值:

A Promise

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

releasesOptions(opts)

返回值:

A Promise

参数:
名称 類型 描述
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* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
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* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
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.
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 (default to [T])
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.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 (default to Released)
opts.offset2 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)

releasesSeriesIdOptions(id, opts)

返回值:

A Promise

参数:
名称 類型 描述
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 (default to Released)
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.offset2 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)

seriesIdDataOptions(id, opts)

返回值:

A Promise

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

seriesIdMetadataOptions(id, opts)

返回值:

A Promise

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

seriesIdOptions(id, opts)

返回值:

A Promise

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

seriesIdVisualOptions(id, opts)

返回值:

A Promise

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

seriesSearchOptions()

返回值:

A Promise


subscriptionsOptions()

返回值:

A Promise


validateCredentialsOptions()

返回值:

A Promise


watchlistIdOptions()

返回值:

A Promise


watchlistOptions()

返回值:

A Promise


命名空间: CEIC\api

类: DictionaryApi((CEIC\ApiClient) apiClient = CEIC\ApiClient.instance)


getClassificationIndicators(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\IndicatorsResult

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

getClassifications(opts)

返回值:

一个Promise,数据类型为 CEIC\model\ClassificationsResult

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

返回值:

一个Promise,数据类型为 CEIC\model\CountriesResult

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

返回值:

一个Promise,数据类型为 CEIC\model\SourcesResult

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

getDictionaries(opts)

返回值:

一个Promise,数据类型为 CEIC\model\DictionaryResult

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

返回值:

一个Promise,数据类型为 CEIC\model\FrequenciesResult

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

返回值:

一个Promise,数据类型为 CEIC\model\GeoResult

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

返回值:

一个Promise,数据类型为 CEIC\model\IndicatorsResult

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

返回值:

一个Promise,数据类型为 CEIC\model\LayoutsResult

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

返回值:

一个Promise,数据类型为 CEIC\model\RegionsResult

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

返回值:

一个Promise,数据类型为 CEIC\model\ReleaseStatusesResult

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

返回值:

一个Promise,数据类型为 CEIC\model\ReleaseTypesResult

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

返回值:

一个Promise,数据类型为 CEIC\model\SourcesResult

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

返回值:

一个Promise,数据类型为 CEIC\model\StatusesResult

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

返回值:

一个Promise,数据类型为 CEIC\model\UnitsResult

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

命名空间: CEIC\api

类: DumpsApi((CEIC\ApiClient) apiClient = CEIC\ApiClient.instance)


cancelDump(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\DumpResult

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

createDataDump(filterId, opts)

返回值:

一个Promise,数据类型为 CEIC\model\DumpResult

参数:
名称 類型 描述
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.
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.
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.
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.
opts.notificationUrl String URL for push notification upon dump completion.
opts.notificationHttpMethod CEIC\model\String HTTP Method for push notifications. (default to GET)

getDataDump(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\DumpResult

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

listUserDumps(opts)

返回值:

一个Promise,数据类型为 CEIC\model\DumpListResult

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

命名空间: CEIC\api

类: FeedsApi((CEIC\ApiClient) apiClient = CEIC\ApiClient.instance)


createFeed(filterId, opts)

返回值:

一个Promise,数据类型为 CEIC\model\FeedResult

参数:
名称 類型 描述
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.
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.
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.
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.
opts.notificationUrl String URL for push notification upon dump completion.
opts.notificationHttpMethod CEIC\model\String HTTP Method for push notifications. (default to GET)
opts.frequency Integer 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)

deleteFeed(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\FeedInformation

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

返回值:

一个Promise,数据类型为 CEIC\model\FeedInformation

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

getFeeds(opts)

返回值:

一个Promise,数据类型为 CEIC\model\FeedsResult

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

updateFeed(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\FeedInformation

参数:
名称 類型 描述
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.
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.
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.
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.
opts.notificationUrl String URL for push notification upon dump completion.
opts.notificationHttpMethod CEIC\model\String HTTP Method for push notifications. (default to GET)
opts.frequency Integer 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

命名空间: CEIC\api

类: FiltersApi((CEIC\ApiClient) apiClient = CEIC\ApiClient.instance)


createFilter(opts)

返回值:

一个Promise,数据类型为 CEIC\model\FilterResult

参数:
名称 類型 描述
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.
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 (default to [T])
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* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.direction Array.<CEIC\model\String> Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending

deleteFilters(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\EmptyObject

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

返回值:

一个Promise,数据类型为 CEIC\model\FiltersResult

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

getUserFilters(opts)

返回值:

一个Promise,数据类型为 CEIC\model\FiltersResult

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

updateFilter(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\FilterResult

参数:
名称 類型 描述
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.
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 (default to [T])
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* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
opts.direction Array.<CEIC\model\String> Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending

命名空间: CEIC\api

类: InsightsApi((CEIC\ApiClient) apiClient = CEIC\ApiClient.instance)


downloadInsight(id, fileFormat, opts)

返回值:

一个Promise,数据类型为 CEIC\model\InsightDownloadResult

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

getGalleryInsightsCategories(opts)

返回值:

一个Promise,数据类型为 CEIC\model\InsightsCategoriesResult

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

返回值:

一个Promise,数据类型为 CEIC\model\InsightsResult

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

getInsightSeries(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\InsightSeriesResult

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

返回值:

一个Promise,数据类型为 CEIC\model\InsightSeriesResult

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

getInsightSeriesList(seriesId, opts)

返回值:

一个Promise,数据类型为 CEIC\model\InsightSeriesResult

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

getInsightSeriesListData(seriesId, opts)

返回值:

一个Promise,数据类型为 CEIC\model\InsightSeriesResult

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

getInsightSeriesListMetadata(seriesId, opts)

返回值:

一个Promise,数据类型为 CEIC\model\InsightSeriesResult

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

getInsightSeriesMetadata(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\InsightSeriesResult

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

getInsights(opts)

返回值:

一个Promise,数据类型为 CEIC\model\InsightsResult

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

返回值:

一个Promise,数据类型为 CEIC\model\InsightsCategoriesResult

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

searchInsights(opts)

返回值:

一个Promise,数据类型为 CEIC\model\InsightsSearchResult

参数:
名称 類型 描述
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 String Sort order (default to edit_date)
opts.direction String 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

命名空间: CEIC\api

类: InternalApi((CEIC\ApiClient) apiClient = CEIC\ApiClient.instance)


getInternalRemarks(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\SeriesInternalRemarksResult

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

命名空间: CEIC\api

类: LayoutApi((CEIC\ApiClient) apiClient = CEIC\ApiClient.instance)


getLayoutDatabases(opts)

返回值:

一个Promise,数据类型为 CEIC\model\LayoutItemsResult

参数:
名称 類型 描述
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.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.
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 (default to [T, C, B])
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.

getLayoutFootnote(nodeCode, opts)

返回值:

一个Promise,数据类型为 @link 'String'

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

getLayoutFootnoteMetadata(nodeCode, opts)

返回值:

一个Promise,数据类型为 CEIC\model\LayoutFootnoteMetadataResult

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

getLayoutFootnoteResource(nodeCode, fileName, opts)

返回值:

一个Promise,数据类型为 @link 'String'

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

getLayoutFullMetadata(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\LayoutFullMetadataResult

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

返回值:

一个Promise,数据类型为 CEIC\model\LayoutFullMetadataResult

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

返回值:

一个Promise,数据类型为 CEIC\model\LayoutFullMetadataResult

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

getLayoutSections(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\LayoutItemsResult

参数:
名称 類型 描述
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.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.
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 (default to [T, C, B])
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)

返回值:

一个Promise,数据类型为 CEIC\model\SeriesResult

参数:
名称 類型 描述
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.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.
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 (default to [T, C, B])
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)

返回值:

一个Promise,数据类型为 CEIC\model\LayoutItemsResult

参数:
名称 類型 描述
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.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.
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 (default to [T, C, B])
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)

返回值:

一个Promise,数据类型为 CEIC\model\LayoutItemsResult

参数:
名称 類型 描述
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.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.
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 (default to [T, C, B])
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.

命名空间: CEIC\api

类: ReleasesApi((CEIC\ApiClient) apiClient = CEIC\ApiClient.instance)


getReleaseSeries(code, opts)

返回值:

一个Promise,数据类型为 CEIC\model\ReleaseSeriesResult

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

getSeriesReleases(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\SeriesReleaseScheduleSearchResult

参数:
名称 類型 描述
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 (default to Released)
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.offset2 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)

searchSeriesReleases(opts)

返回值:

一个Promise,数据类型为 CEIC\model\SeriesReleaseScheduleSearchResult

参数:
名称 類型 描述
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* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
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* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
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.
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 (default to [T])
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.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 (default to Released)
opts.offset2 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)

命名空间: CEIC\api

类: SeriesApi((CEIC\ApiClient) apiClient = CEIC\ApiClient.instance)


getSeries(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\SeriesResult

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

getSeriesMetadata(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\SeriesResult

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

getSeriesStatistics(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\SeriesStatisticsResult

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

getSeriesTimePoints(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\SeriesResult

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

getSeriesVisual(id, opts)

返回值:

一个Promise,数据类型为 @link 'String'

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

searchSeries(opts)

返回值:

一个Promise,数据类型为 CEIC\model\SearchSeriesResult

参数:
名称 類型 描述
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* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
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* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database*
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.
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 (default to [T])
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.facet Array.<CEIC\model\String> List of facets to return

命名空间: CEIC\api

类: SessionsApi((CEIC\ApiClient) apiClient = CEIC\ApiClient.instance)


generateImpersonateToken(employeeToken, userId, application, opts)

返回值:

一个Promise,数据类型为 CEIC\model\ImpersonateAPIKeyResult

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

getSubscriptions(opts)

返回值:

一个Promise,数据类型为 CEIC\model\UserSubscriptionsResult

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

login(login, password, application, opts)

返回值:

一个Promise,数据类型为 CEIC\model\UserSessionResult

参数:
名称 類型 描述
login String Username
password String Password
application String Application ID
opts Object Optional parameters
opts.applicationVersion String Application Version

logout(session)

返回值:

一个Promise,数据类型为 CEIC\model\SessionStatusResult

参数:
名称 類型 描述
session String User session

validateCredentials(login, password)

返回值:

一个Promise,数据类型为 CEIC\model\UserCredentialsValidationResult

参数:
名称 類型 描述
login String Username
password String Password

命名空间: CEIC\api

类: WatchlistApi((CEIC\ApiClient) apiClient = CEIC\ApiClient.instance)


createWatchlist(seriesId, opts)

返回值:

一个Promise,数据类型为 CEIC\model\WatchlistProcessedResult

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

deleteWatchlist(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\WatchlistProcessedResult

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

getWatchlist(opts)

返回值:

一个Promise,数据类型为 CEIC\model\WatchlistGetResult

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

updateWatchlist(id, opts)

返回值:

一个Promise,数据类型为 CEIC\model\WatchlistProcessedResult

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

Result Types

CEIC\model.BaseSeriesInformation()
CEIC\model.Classification()
CEIC\model.ClassificationsResult()
CEIC\model.CountriesResult()
CEIC\model.Country()
CEIC\model.DictionaryData()
CEIC\model.DictionaryResult()
CEIC\model.DumpInformation()
CEIC\model.DumpListInformation()
CEIC\model.DumpListResult()
CEIC\model.DumpResult()
CEIC\model.EmptyObject()
CEIC\model.Facet()
CEIC\model.FacetEntry()
CEIC\model.FeedInformation()
CEIC\model.FeedResult()
CEIC\model.FeedsResult()
CEIC\model.FilterDetails()
CEIC\model.FilterDetailsSearch()
CEIC\model.FilterResult()
CEIC\model.FiltersResult()
CEIC\model.FrequenciesResult()
CEIC\model.Frequency()
CEIC\model.Geo()
CEIC\model.GeoInfo()
CEIC\model.GeoResult()
CEIC\model.ImpersonateAPIKey()
CEIC\model.ImpersonateAPIKeyResult()
CEIC\model.Indicator((String) id, (String) name)
CEIC\model.IndicatorsResult()
CEIC\model.InsightDownload()
CEIC\model.InsightDownloadResult()
CEIC\model.InsightSeries()
CEIC\model.InsightSeriesInformation()
CEIC\model.InsightSeriesResult()
CEIC\model.Insights()
CEIC\model.InsightsCategoriesResult()
CEIC\model.InsightsCategory()
CEIC\model.InsightsResult()
CEIC\model.InsightsSearch()
CEIC\model.InsightsSearchResult()
CEIC\model.InternalSeriesRemarks()
CEIC\model.Layout((CEIC\model\Layout.IdEnum) id, (String) name)
CEIC\model.LayoutAncestors()
CEIC\model.LayoutFootnoteMetadata()
CEIC\model.LayoutFootnoteMetadataItem()
CEIC\model.LayoutFootnoteMetadataResult()
CEIC\model.LayoutFootnoteResourceMetadataItem()
CEIC\model.LayoutFullMetadataItem()
CEIC\model.LayoutFullMetadataResult()
CEIC\model.LayoutInformation()
CEIC\model.LayoutItem()
CEIC\model.LayoutItemMetadata()
CEIC\model.LayoutItemUI()
CEIC\model.LayoutItemsResult()
CEIC\model.LayoutsResult()
CEIC\model.Province()
CEIC\model.Region()
CEIC\model.RegionsResult()
CEIC\model.ReleaseScheduleStatus()
CEIC\model.ReleaseScheduleType()
CEIC\model.ReleaseSeries()
CEIC\model.ReleaseSeriesList()
CEIC\model.ReleaseSeriesResult()
CEIC\model.ReleaseStatusesResult()
CEIC\model.ReleaseTypesResult()
CEIC\model.ResponseError((CEIC\model\ResponseError.MessageEnum) message, (CEIC\model\ResponseError.CodeEnum) code)
CEIC\model.SearchSeries()
CEIC\model.SearchSeriesResult()
CEIC\model.Series()
CEIC\model.SeriesData()
CEIC\model.SeriesFilter()
CEIC\model.SeriesGrouping()
CEIC\model.SeriesInformation()
CEIC\model.SeriesInternalRemarksResult()
CEIC\model.SeriesMetadata()
CEIC\model.SeriesMetadataLastChange()
CEIC\model.SeriesReleaseScheduleItem()
CEIC\model.SeriesReleaseScheduleSearchResult()
CEIC\model.SeriesReleases()
CEIC\model.SeriesReleasesSearch()
CEIC\model.SeriesReplacements()
CEIC\model.SeriesResult()
CEIC\model.SeriesStatistics()
CEIC\model.SeriesStatisticsItem()
CEIC\model.SeriesStatisticsResult()
CEIC\model.SeriesUISettings()
CEIC\model.SessionStatus()
CEIC\model.SessionStatusResult()
CEIC\model.Source()
CEIC\model.SourcesResult()
CEIC\model.Status()
CEIC\model.StatusesResult()
CEIC\model.SubscriptionItem()
CEIC\model.TimePoint()
CEIC\model.Unit()
CEIC\model.UnitsResult()
CEIC\model.UserCredentialsValidationResult()
CEIC\model.UserCredentialsValidationResultData()
CEIC\model.UserInformation()
CEIC\model.UserSession()
CEIC\model.UserSessionResult()
CEIC\model.UserSubscriptionsResult()
CEIC\model.WatchlistGetResult()
CEIC\model.WatchlistItem()
CEIC\model.WatchlistProcessedInformation()
CEIC\model.WatchlistProcessedResult()