Full Development Guide

API Clients

Namespace: Ceic\Api\Apis

Class: DefaultApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

dictionaryClassificationsIdIndicatorsOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringClassification ID. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
dictionaryClassificationsIdIndicatorsOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringClassification ID. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
dictionaryClassificationsOptions(())

Returns:

void

dictionaryClassificationsOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

dictionaryCountriesIdSourcesOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringCountry ISO code (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
dictionaryCountriesIdSourcesOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringCountry ISO code (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
dictionaryCountriesOptions(())

Returns:

void

dictionaryCountriesOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

dictionaryFrequenciesOptions(())

Returns:

void

dictionaryFrequenciesOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

dictionaryIndicatorsOptions(())

Returns:

void

dictionaryIndicatorsOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

dictionaryLayoutsOptions(())

Returns:

void

dictionaryLayoutsOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

dictionaryOptions(())

Returns:

void

dictionaryOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

dictionaryRegionsOptions(())

Returns:

void

dictionaryRegionsOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

dictionarySourcesOptions(())

Returns:

void

dictionarySourcesOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

dictionaryStatusesOptions(())

Returns:

void

dictionaryStatusesOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

dictionaryUnitsOptions(())

Returns:

void

dictionaryUnitsOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

dumpsIdOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringDump ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
dumpsIdOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringDump ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
dumpsOptions(())

Returns:

void

dumpsOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

feedsIdOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringFeed ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
feedsIdOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringFeed ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
feedsOptions(())

Returns:

void

feedsOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

filtersIdOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringFilter ID. Accepts one or more comma separated values. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
filtersIdOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringFilter ID. Accepts one or more comma separated values. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
filtersOptions(())

Returns:

void

filtersOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

impersonateTokenOptions(($employeeToken, $userId, $application, $expireAfter = '86400'))

Returns:

void

Parameters:
NameTypeDescription
$employeeTokenstringImpersonate API token generated on CAS service (required)
$userIdstringUser Id (required)
$applicationstringApplication ID (required)
$expireAfterfloatToken will be expired after `expire_after` in seconds (optional, default to 86400)
impersonateTokenOptionsAsync(($employeeToken, $userId, $application, $expireAfter = '86400'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$employeeTokenstringImpersonate API token generated on CAS service (required)
$userIdstringUser Id (required)
$applicationstringApplication ID (required)
$expireAfterfloatToken will be expired after `expire_after` in seconds (optional, default to 86400)
insightsCategoriesEmisOptions(())

Returns:

void

insightsCategoriesEmisOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

insightsCategoriesGalleryOptions(())

Returns:

void

insightsCategoriesGalleryOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

insightsCategoriesOptions(())

Returns:

void

insightsCategoriesOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

insightsIdDownloadFileFormatOptions(($id, $fileFormat, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $ignoreCache = 'false', $adjustColumns = 'no', $startDate = null, $endDate = null, $count = '3650', $blankObservations = 'filter', $orientation = 'cols', $order = 'asc', $decimalPlaces = '3', $dateFormat = null))

Returns:

void

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$fileFormatstringInsight report file format. Available formats: `xlsx`, `pdf` (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$ignoreCacheboolNew file will be generated (optional, default to false)
$adjustColumnsstringNo adjust or wrap text in XLSX cell (optional, default to no)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$blankObservationsstringIf set to true, will return empty time-points which oterwise are omitted. (optional, default to filter)
$orientationstringColumns/rows orientation (optional, default to cols)
$orderstringSort order - Asc/Desc (optional, default to asc)
$decimalPlacesfloatDecimal places for the time-points values (optional, default to 3)
$dateFormatstringTime-points date format (optional)
insightsIdDownloadFileFormatOptionsAsync(($id, $fileFormat, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $ignoreCache = 'false', $adjustColumns = 'no', $startDate = null, $endDate = null, $count = '3650', $blankObservations = 'filter', $orientation = 'cols', $order = 'asc', $decimalPlaces = '3', $dateFormat = null))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$fileFormatstringInsight report file format. Available formats: `xlsx`, `pdf` (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$ignoreCacheboolNew file will be generated (optional, default to false)
$adjustColumnsstringNo adjust or wrap text in XLSX cell (optional, default to no)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$blankObservationsstringIf set to true, will return empty time-points which oterwise are omitted. (optional, default to filter)
$orientationstringColumns/rows orientation (optional, default to cols)
$orderstringSort order - Asc/Desc (optional, default to asc)
$decimalPlacesfloatDecimal places for the time-points values (optional, default to 3)
$dateFormatstringTime-points date format (optional)
insightsIdOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
insightsIdOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
insightsIdSeriesDataOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $limit = '100', $offset = '0'))

Returns:

void

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
insightsIdSeriesDataOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $limit = '100', $offset = '0'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
insightsIdSeriesMetadataOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $limit = '100', $offset = '0'))

Returns:

void

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
insightsIdSeriesMetadataOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $limit = '100', $offset = '0'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
insightsIdSeriesOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $limit = '100', $offset = '0'))

Returns:

void

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
insightsIdSeriesOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $limit = '100', $offset = '0'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
insightsOptions(())

Returns:

void

insightsOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

insightsSearchOptions(())

Returns:

void

insightsSearchOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

insightsSeriesSeriesIdDataOptions(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active'))

Returns:

void

Parameters:
NameTypeDescription
$seriesIdstringInsight Series ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
insightsSeriesSeriesIdDataOptionsAsync(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$seriesIdstringInsight Series ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
insightsSeriesSeriesIdMetadataOptions(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$seriesIdstringInsight Series ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
insightsSeriesSeriesIdMetadataOptionsAsync(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$seriesIdstringInsight Series ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
insightsSeriesSeriesIdOptions(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$seriesIdstringInsight Series ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
insightsSeriesSeriesIdOptionsAsync(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$seriesIdstringInsight Series ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
internalSeriesIdInternalRemarksOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
internalSeriesIdInternalRemarksOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
layoutDatabasesIdTopicsOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

void

Parameters:
NameTypeDescription
$idstringDatabase ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutDatabasesIdTopicsOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringDatabase ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutDatabasesOptions(())

Returns:

void

layoutDatabasesOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

layoutNodeCodeFootnoteDownloadFileNameOptions(($nodeCode, $fileName, $acceptLanguage = 'en', $lang = 'en'))

Returns:

void

Parameters:
NameTypeDescription
$nodeCodestringNode Code - Database ID, Topic ID, Section ID or Table ID (required)
$fileNamestringResource file name (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
layoutNodeCodeFootnoteDownloadFileNameOptionsAsync(($nodeCode, $fileName, $acceptLanguage = 'en', $lang = 'en'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$nodeCodestringNode Code - Database ID, Topic ID, Section ID or Table ID (required)
$fileNamestringResource file name (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
layoutNodeCodeFootnoteDownloadOptions(($nodeCode, $acceptLanguage = 'en', $lang = 'en'))

Returns:

void

Parameters:
NameTypeDescription
$nodeCodestringNode Code - Database ID, Topic ID, Section ID or Table ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
layoutNodeCodeFootnoteDownloadOptionsAsync(($nodeCode, $acceptLanguage = 'en', $lang = 'en'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$nodeCodestringNode Code - Database ID, Topic ID, Section ID or Table ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
layoutNodeCodeFootnoteOptions(($nodeCode, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$nodeCodestringNode Code - Database ID, Topic ID, Section ID or Table ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
layoutNodeCodeFootnoteOptionsAsync(($nodeCode, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$nodeCodestringNode Code - Database ID, Topic ID, Section ID or Table ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
layoutSectionsIdOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

void

Parameters:
NameTypeDescription
$idstringNode ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutSectionsIdOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringNode ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutSectionsIdTablesOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

void

Parameters:
NameTypeDescription
$idstringSection ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutSectionsIdTablesOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSection ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutTablesIdOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

void

Parameters:
NameTypeDescription
$idstringNode ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutTablesIdOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringNode ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutTablesIdSeriesOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

void

Parameters:
NameTypeDescription
$idstringTable ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutTablesIdSeriesOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringTable ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutTopicsIdOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

void

Parameters:
NameTypeDescription
$idstringNode ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutTopicsIdOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringNode ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutTopicsIdSectionsOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

void

Parameters:
NameTypeDescription
$idstringTopic ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
layoutTopicsIdSectionsOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringTopic ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
loginOptions(())

Returns:

void

loginOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

logoutSessionOptions(($session))

Returns:

void

Parameters:
NameTypeDescription
$sessionstringUser session (required)
logoutSessionOptionsAsync(($session))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$sessionstringUser session (required)
releasesCodeSeriesOptions(($code, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $limit = '100', $offset = '0'))

Returns:

void

Parameters:
NameTypeDescription
$codestringRelease identifier code for a group of series with the same release schedule. Accepts only one release identifier code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
releasesCodeSeriesOptionsAsync(($code, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $limit = '100', $offset = '0'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$codestringRelease identifier code for a group of series with the same release schedule. Accepts only one release identifier code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
releasesOptions(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $limit = '100', $offset = '0', $layout = null, $database = null, $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T"]', $dataSource = null, $series = null, $withVintageEnabledOnly = 'false', $headlineOnly = 'false', $topic = null, $section = null, $table = null, $order = null, $direction = null, $filterId = null, $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $facet = null, $releaseDateFrom = null, $releaseDateTo = null, $releaseStatus = null))

Returns:

void

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$layoutstring[]**DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$databasestring[]Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T"])
$dataSourcestring[]Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional)
$seriesstring[]List of series (optional)
$withVintageEnabledOnlyboolIf it is `true` result will contain ONLY vintage enabled series (optional, default to false)
$headlineOnlyboolShow only 'headline' series when set to `true`. (optional, default to false)
$topicstring[]Topic filter. One or more comma separated topic code values. (optional)
$sectionstring[]Section filter. One or more comma separated section code values. (optional)
$tablestring[]Table filter. One or more comma separated table code values. (optional)
$orderstring[]Sort order. Default is `relevance`. (optional)
$directionstring[]Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
$filterIdstring[]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. (optional)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$facetstring[]List of facets to return (optional)
$releaseDateFrom\DateTimeWill return releases with first observation before `release_date_from` (optional)
$releaseDateTo\DateTimeWill return releases with last observation after `release_date_to` (optional)
$releaseStatusstring[]List of release statuses to return (optional)
releasesOptionsAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $limit = '100', $offset = '0', $layout = null, $database = null, $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T"]', $dataSource = null, $series = null, $withVintageEnabledOnly = 'false', $headlineOnly = 'false', $topic = null, $section = null, $table = null, $order = null, $direction = null, $filterId = null, $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $facet = null, $releaseDateFrom = null, $releaseDateTo = null, $releaseStatus = null))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$layoutstring[]**DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$databasestring[]Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T"])
$dataSourcestring[]Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional)
$seriesstring[]List of series (optional)
$withVintageEnabledOnlyboolIf it is `true` result will contain ONLY vintage enabled series (optional, default to false)
$headlineOnlyboolShow only 'headline' series when set to `true`. (optional, default to false)
$topicstring[]Topic filter. One or more comma separated topic code values. (optional)
$sectionstring[]Section filter. One or more comma separated section code values. (optional)
$tablestring[]Table filter. One or more comma separated table code values. (optional)
$orderstring[]Sort order. Default is `relevance`. (optional)
$directionstring[]Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
$filterIdstring[]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. (optional)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$facetstring[]List of facets to return (optional)
$releaseDateFrom\DateTimeWill return releases with first observation before `release_date_from` (optional)
$releaseDateTo\DateTimeWill return releases with last observation after `release_date_to` (optional)
$releaseStatusstring[]List of release statuses to return (optional)
releasesSeriesIdOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $releaseDateFrom = null, $releaseDateTo = null, $releaseStatus = null, $offset = '0', $limit = '100'))

Returns:

void

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$releaseDateFrom\DateTimeWill return releases with first observation before `release_date_from` (optional)
$releaseDateTo\DateTimeWill return releases with last observation after `release_date_to` (optional)
$releaseStatusstring[]List of release statuses to return (optional)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
releasesSeriesIdOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $releaseDateFrom = null, $releaseDateTo = null, $releaseStatus = null, $offset = '0', $limit = '100'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$releaseDateFrom\DateTimeWill return releases with first observation before `release_date_from` (optional)
$releaseDateTo\DateTimeWill return releases with last observation after `release_date_to` (optional)
$releaseStatusstring[]List of release statuses to return (optional)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
seriesIdDataOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active'))

Returns:

void

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
seriesIdDataOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
seriesIdEarliestOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
seriesIdEarliestOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
seriesIdMetadataOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
seriesIdMetadataOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
seriesIdOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
seriesIdOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
seriesIdVintagesDatesOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
seriesIdVintagesDatesOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
seriesIdVintagesOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
seriesIdVintagesOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
seriesIdVisualOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

void

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
seriesIdVisualOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
seriesSearchOptions(())

Returns:

void

seriesSearchOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

subscriptionsOptions(())

Returns:

void

subscriptionsOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

userdefinedSeriesCloneOptions(())

Returns:

void

userdefinedSeriesCloneOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

userdefinedSeriesIdDataOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active'))

Returns:

void

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
userdefinedSeriesIdDataOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
userdefinedSeriesIdTimepointsDateOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active'))

Returns:

void

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
userdefinedSeriesIdTimepointsDateOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
userdefinedSeriesIdTimepointsOptions(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active'))

Returns:

void

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
userdefinedSeriesIdTimepointsOptionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active'))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
userdefinedSeriesOptions(())

Returns:

void

userdefinedSeriesOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

validateCredentialsOptions(())

Returns:

void

validateCredentialsOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

watchlistIdOptions(())

Returns:

void

watchlistIdOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

watchlistOptions(())

Returns:

void

watchlistOptionsAsync(())

Returns:

\GuzzleHttp\Promise\PromiseInterface

dictionaryClassificationsIdIndicatorsOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
dictionaryClassificationsIdIndicatorsOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
dictionaryCountriesIdSourcesOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
dictionaryCountriesIdSourcesOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
dumpsIdOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
dumpsIdOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
feedsIdOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
feedsIdOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
filtersIdOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
filtersIdOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
impersonateTokenOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
impersonateTokenOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsIdDownloadFileFormatOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsIdDownloadFileFormatOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsIdOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsIdOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsIdSeriesDataOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsIdSeriesDataOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsIdSeriesMetadataOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsIdSeriesMetadataOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsIdSeriesOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsIdSeriesOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsSeriesSeriesIdDataOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsSeriesSeriesIdDataOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsSeriesSeriesIdMetadataOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsSeriesSeriesIdMetadataOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsSeriesSeriesIdOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
insightsSeriesSeriesIdOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
internalSeriesIdInternalRemarksOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
internalSeriesIdInternalRemarksOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutDatabasesIdTopicsOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutDatabasesIdTopicsOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutNodeCodeFootnoteDownloadFileNameOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutNodeCodeFootnoteDownloadFileNameOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutNodeCodeFootnoteDownloadOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutNodeCodeFootnoteDownloadOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutNodeCodeFootnoteOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutNodeCodeFootnoteOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutSectionsIdOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutSectionsIdOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutSectionsIdTablesOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutSectionsIdTablesOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutTablesIdOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutTablesIdOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutTablesIdSeriesOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutTablesIdSeriesOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutTopicsIdOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutTopicsIdOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutTopicsIdSectionsOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
layoutTopicsIdSectionsOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
releasesCodeSeriesOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
releasesCodeSeriesOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
releasesOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
releasesOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
releasesSeriesIdOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
releasesSeriesIdOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdDataOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdDataOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdEarliestOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdEarliestOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdMetadataOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdMetadataOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdVintagesDatesOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdVintagesDatesOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdVintagesOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdVintagesOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdVisualOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
seriesIdVisualOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
userdefinedSeriesIdDataOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
userdefinedSeriesIdDataOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
userdefinedSeriesIdTimepointsDateOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
userdefinedSeriesIdTimepointsDateOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
userdefinedSeriesIdTimepointsOptionsQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

void

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)
userdefinedSeriesIdTimepointsOptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DefaultApiQueryEntityQuery entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: UserdefinedApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

cloneCeicSeries(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $referenceSeriesId = null))

Clone CEIC series to a new userdefined series

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedClonedSeriesResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$referenceSeriesIdintCEIC series id, which the current userdefined series refers to. (optional)
cloneCeicSeriesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $referenceSeriesId = null))

Clone CEIC series to a new userdefined series

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$referenceSeriesIdintCEIC series id, which the current userdefined series refers to. (optional)
deleteAllUddSeriesTimePoints(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Deletes ALL series time-points

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedDeletedSeriesDataBulkDataResult

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
deleteAllUddSeriesTimePointsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Deletes ALL series time-points

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
deleteSingleUddSeries(($id))

Delete single userdefined series

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedDeletedSeriesResult

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
deleteSingleUddSeriesAsync(($id))

Delete single userdefined series

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
deleteUddSeriesTimePoint(($id, $date, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Delete series time-point

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedDeleteSeriesDataResult

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
$date\DateTimeTimepoint date in format `YYYY-MM-DD` (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
deleteUddSeriesTimePointAsync(($id, $date, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Delete series time-point

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
$date\DateTimeTimepoint date in format `YYYY-MM-DD` (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getSingleUddSeries(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Userdefined series list

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedSeriesResult

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getSingleUddSeriesAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Userdefined series list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getUddSeries(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $limit = '100', $offset = '0'))

Userdefined series list

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedSeriesResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getUddSeriesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $limit = '100', $offset = '0'))

Userdefined series list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getUddSeriesTimePoints(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns series time-points

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedSeriesDataResult

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getUddSeriesTimePointsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns series time-points

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
patchUddSeries(($frequency, $name, $unit, $id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $country = null, $remarks = null, $startDate = null, $subnational = null, $userSeriesId = null, $category = null))

Updates userdefined series with metadata

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedCreatedSeriesResult

Parameters:
NameTypeDescription
$frequencystringThe frequency name. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (required)
$namestringSeries name. (required)
$unitstringUnit abbreviation, ex: `kg`, `ha`, `m3`, etc. (required)
$idstringUserdefined series id. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countrystringCountry name or ISO code. (optional)
$remarksstringRemark for the current series. (optional)
$startDate\DateTimeSeries start date in ISO format. (optional)
$subnationalstringSubnational. (optional)
$userSeriesIdstringThe series id in the user source (optional)
$categorystringThe series category (optional)
patchUddSeriesAsync(($frequency, $name, $unit, $id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $country = null, $remarks = null, $startDate = null, $subnational = null, $userSeriesId = null, $category = null))

Updates userdefined series with metadata

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$frequencystringThe frequency name. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (required)
$namestringSeries name. (required)
$unitstringUnit abbreviation, ex: `kg`, `ha`, `m3`, etc. (required)
$idstringUserdefined series id. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countrystringCountry name or ISO code. (optional)
$remarksstringRemark for the current series. (optional)
$startDate\DateTimeSeries start date in ISO format. (optional)
$subnationalstringSubnational. (optional)
$userSeriesIdstringThe series id in the user source (optional)
$categorystringThe series category (optional)
patchUddSeriesTimePoint(($id, $date, $value, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Patch series time-point

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedCreateSeriesDataResult

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
$date\DateTimeTimepoint date in format `YYYY-MM-DD` (required)
$valuedoubleTimepoint value (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
patchUddSeriesTimePointAsync(($id, $date, $value, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Patch series time-point

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
$date\DateTimeTimepoint date in format `YYYY-MM-DD` (required)
$valuedoubleTimepoint value (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
postUddSeries(($frequency, $name, $unit, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $country = null, $remarks = null, $startDate = null, $referenceSeriesId = null, $subnational = null, $multiplier = null, $sourceName = null, $userSeriesId = null, $category = null))

Create userdefined series with metadata

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedCreatedSeriesResult

Parameters:
NameTypeDescription
$frequencystringThe frequency name. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (required)
$namestringSeries name. (required)
$unitstringUnit abbreviation, ex: `kg`, `ha`, `m3`, etc. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countrystringCountry name or ISO code. (optional)
$remarksstringRemark for the current series. (optional)
$startDate\DateTimeSeries start date in ISO format. (optional)
$referenceSeriesIdintCEIC series id, which the current userdefined series refers to. (optional)
$subnationalstringSubnational. (optional)
$multiplierstringUnit multiplier. (optional)
$sourceNamestringName of the series source. (optional)
$userSeriesIdstringThe series id in the user source (optional)
$categorystringThe series category (optional)
postUddSeriesAsync(($frequency, $name, $unit, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $country = null, $remarks = null, $startDate = null, $referenceSeriesId = null, $subnational = null, $multiplier = null, $sourceName = null, $userSeriesId = null, $category = null))

Create userdefined series with metadata

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$frequencystringThe frequency name. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (required)
$namestringSeries name. (required)
$unitstringUnit abbreviation, ex: `kg`, `ha`, `m3`, etc. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countrystringCountry name or ISO code. (optional)
$remarksstringRemark for the current series. (optional)
$startDate\DateTimeSeries start date in ISO format. (optional)
$referenceSeriesIdintCEIC series id, which the current userdefined series refers to. (optional)
$subnationalstringSubnational. (optional)
$multiplierstringUnit multiplier. (optional)
$sourceNamestringName of the series source. (optional)
$userSeriesIdstringThe series id in the user source (optional)
$categorystringThe series category (optional)
postUddSeriesTimePoints(($id, $body, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Creates series time-points

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedCreateSeriesDataResult

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
$body\Ceic\Api\Ceic\Api\Models\UserdefinedTimepointData[]Timepoints data - list of timepoints to create. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
postUddSeriesTimePointsAsync(($id, $body, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Creates series time-points

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringUserdefined series id. (required)
$body\Ceic\Api\Ceic\Api\Models\UserdefinedTimepointData[]Timepoints data - list of timepoints to create. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
cloneCeicSeriesQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedClonedSeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
cloneCeicSeriesAsyncQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
deleteAllUddSeriesTimePointsQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedDeletedSeriesDataBulkDataResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
deleteAllUddSeriesTimePointsAsyncQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
deleteUddSeriesTimePointQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedDeleteSeriesDataResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
deleteUddSeriesTimePointAsyncQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
getSingleUddSeriesQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedSeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
getSingleUddSeriesAsyncQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
getUddSeriesQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedSeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
getUddSeriesAsyncQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
getUddSeriesTimePointsQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedSeriesDataResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
getUddSeriesTimePointsAsyncQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
patchUddSeriesQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedCreatedSeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
patchUddSeriesAsyncQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
patchUddSeriesTimePointQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedCreateSeriesDataResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
patchUddSeriesTimePointAsyncQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
postUddSeriesQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedCreatedSeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
postUddSeriesAsyncQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
postUddSeriesTimePointsQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UserdefinedCreateSeriesDataResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)
postUddSeriesTimePointsAsyncQuery((\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\UserdefinedApiQueryEntityQuery entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: DictionaryApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

getClassificationIndicators(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

List of indicators for specific classification

Returns:

\Ceic\Api\Ceic\Api\Models\IndicatorsResult

Parameters:
NameTypeDescription
$idstringClassification ID. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getClassificationIndicatorsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

List of indicators for specific classification

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringClassification ID. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getClassifications(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Classifications list

Returns:

\Ceic\Api\Ceic\Api\Models\ClassificationsResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getClassificationsAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Classifications list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getCountries(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

DEPRECATED. Please use `/dictionary/geo`. Countries list

Returns:

\Ceic\Api\Ceic\Api\Models\CountriesResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getCountriesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

DEPRECATED. Please use `/dictionary/geo`. Countries list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getCountrySources(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

List of sources for a specific country

Returns:

\Ceic\Api\Ceic\Api\Models\SourcesResult

Parameters:
NameTypeDescription
$idstringCountry ISO code (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getCountrySourcesAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

List of sources for a specific country

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringCountry ISO code (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getDictionaries(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Full dictionary list

Returns:

\Ceic\Api\Ceic\Api\Models\DictionaryResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getDictionariesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Full dictionary list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getFrequencies(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Frequencies list

Returns:

\Ceic\Api\Ceic\Api\Models\FrequenciesResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getFrequenciesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Frequencies list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getGeo(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Geo list

Returns:

\Ceic\Api\Ceic\Api\Models\GeoResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getGeoAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Geo list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getIndicators(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Indicators list

Returns:

\Ceic\Api\Ceic\Api\Models\IndicatorsResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getIndicatorsAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Indicators list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getLayouts(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

DEPRECATED. Please use `/layout/databases`. Database layouts list

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutsResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getLayoutsAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

DEPRECATED. Please use `/layout/databases`. Database layouts list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getRegions(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Regions list

Returns:

\Ceic\Api\Ceic\Api\Models\RegionsResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getRegionsAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Regions list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getReleaseStatuses(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Release schedule statuses list

Returns:

\Ceic\Api\Ceic\Api\Models\ReleaseStatusesResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getReleaseStatusesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Release schedule statuses list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getReleaseTypes(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Release schedule types list

Returns:

\Ceic\Api\Ceic\Api\Models\ReleaseTypesResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getReleaseTypesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Release schedule types list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getSources(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Sources list

Returns:

\Ceic\Api\Ceic\Api\Models\SourcesResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getSourcesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Sources list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getStatuses(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Statuses list

Returns:

\Ceic\Api\Ceic\Api\Models\StatusesResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getStatusesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Statuses list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getUnits(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Units list

Returns:

\Ceic\Api\Ceic\Api\Models\UnitsResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getUnitsAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Units list

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getClassificationIndicatorsQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\IndicatorsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getClassificationIndicatorsAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getClassificationsQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\ClassificationsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getClassificationsAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getCountriesQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\CountriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getCountriesAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getCountrySourcesQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SourcesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getCountrySourcesAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getDictionariesQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\DictionaryResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getDictionariesAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getFrequenciesQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\FrequenciesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getFrequenciesAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getGeoQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\GeoResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getGeoAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getIndicatorsQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\IndicatorsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getIndicatorsAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getLayoutsQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getLayoutsAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getRegionsQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\RegionsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getRegionsAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getReleaseStatusesQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\ReleaseStatusesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getReleaseStatusesAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getReleaseTypesQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\ReleaseTypesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getReleaseTypesAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getSourcesQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SourcesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getSourcesAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getStatusesQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\StatusesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getStatusesAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getUnitsQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UnitsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)
getUnitsAsyncQuery((\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntityQuery entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: DumpsApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

cancelDump(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Cancel dump

Returns:

\Ceic\Api\Ceic\Api\Models\DumpResult

Parameters:
NameTypeDescription
$idstringDump ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
cancelDumpAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Cancel dump

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringDump ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
createDataDump(($filterId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $name = null, $description = null, $consolidation = 'zip', $delivery = 'web', $userFtpUrl = 'null', $userFtpPath = '/ceic_data_dumps/', $userFtpUsername = 'null', $userFtpPassword = 'null', $notificationEmail = 'null', $notificationUrl = 'null', $notificationHttpMethod = 'GET'))

Create dump

Returns:

\Ceic\Api\Ceic\Api\Models\DumpResult

Parameters:
NameTypeDescription
$filterIdstringFilter ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$namestringName of the new record. Max length 100 (optional)
$descriptionstringDescription of the new record. Max length 1000 (optional)
$consolidationstringConsolidation Method (optional, default to zip)
$deliverystringDelivery Method (optional, default to web)
$userFtpUrlstringResult delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (optional, default to null)
$userFtpPathstringResult delivery path for local FTP server. Only valid when the localftp delivery method is selected. (optional, default to /ceic_data_dumps/)
$userFtpUsernamestringUsername for the local FTP server. Only valid when the localftp delivery method is selected. (optional, default to null)
$userFtpPasswordstringPassword for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (optional, default to null)
$notificationEmailstringWhen set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (optional, default to null)
$notificationUrlstringURL for push notification upon dump completion. (optional, default to null)
$notificationHttpMethodstringHTTP Method for push notifications. (optional, default to GET)
createDataDumpAsync(($filterId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $name = null, $description = null, $consolidation = 'zip', $delivery = 'web', $userFtpUrl = 'null', $userFtpPath = '/ceic_data_dumps/', $userFtpUsername = 'null', $userFtpPassword = 'null', $notificationEmail = 'null', $notificationUrl = 'null', $notificationHttpMethod = 'GET'))

Create dump

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$filterIdstringFilter ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$namestringName of the new record. Max length 100 (optional)
$descriptionstringDescription of the new record. Max length 1000 (optional)
$consolidationstringConsolidation Method (optional, default to zip)
$deliverystringDelivery Method (optional, default to web)
$userFtpUrlstringResult delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (optional, default to null)
$userFtpPathstringResult delivery path for local FTP server. Only valid when the localftp delivery method is selected. (optional, default to /ceic_data_dumps/)
$userFtpUsernamestringUsername for the local FTP server. Only valid when the localftp delivery method is selected. (optional, default to null)
$userFtpPasswordstringPassword for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (optional, default to null)
$notificationEmailstringWhen set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (optional, default to null)
$notificationUrlstringURL for push notification upon dump completion. (optional, default to null)
$notificationHttpMethodstringHTTP Method for push notifications. (optional, default to GET)
getDataDump(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Get dump

Returns:

\Ceic\Api\Ceic\Api\Models\DumpResult

Parameters:
NameTypeDescription
$idstringDump ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getDataDumpAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Get dump

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringDump ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
listUserDumps(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $offset = '0', $limit = '100', $createdAfter = null, $createdBefore = null, $filterId = null, $createdOrder = 'ASC', $status = null, $feedId = null))

List dumps

Returns:

\Ceic\Api\Ceic\Api\Models\DumpListResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$createdBefore\DateTimeWill return entries created after `created_before` date (optional)
$filterIdstringFilter 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. (optional)
$createdOrderstringChoose whether to order the entries ascending or descending. Default is Ascending (optional, default to ASC)
$statusstring[]Dump status (optional)
$feedIdstringFeed ID (optional)
listUserDumpsAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $offset = '0', $limit = '100', $createdAfter = null, $createdBefore = null, $filterId = null, $createdOrder = 'ASC', $status = null, $feedId = null))

List dumps

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$createdBefore\DateTimeWill return entries created after `created_before` date (optional)
$filterIdstringFilter 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. (optional)
$createdOrderstringChoose whether to order the entries ascending or descending. Default is Ascending (optional, default to ASC)
$statusstring[]Dump status (optional)
$feedIdstringFeed ID (optional)
cancelDumpQuery((\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\DumpResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntityQuery entity object which contains the search information (required)
cancelDumpAsyncQuery((\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntityQuery entity object which contains the search information (required)
createDataDumpQuery((\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\DumpResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntityQuery entity object which contains the search information (required)
createDataDumpAsyncQuery((\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntityQuery entity object which contains the search information (required)
getDataDumpQuery((\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\DumpResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntityQuery entity object which contains the search information (required)
getDataDumpAsyncQuery((\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntityQuery entity object which contains the search information (required)
listUserDumpsQuery((\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\DumpListResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntityQuery entity object which contains the search information (required)
listUserDumpsAsyncQuery((\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntityQuery entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: FeedsApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

createFeed(($filterId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $name = null, $description = null, $consolidation = 'zip', $delivery = 'web', $userFtpUrl = 'null', $userFtpPath = '/ceic_data_dumps/', $userFtpUsername = 'null', $userFtpPassword = 'null', $notificationEmail = 'null', $notificationUrl = 'null', $notificationHttpMethod = 'GET', $frequency = '1440', $fullDump = 'false'))

Subscribe for a feed

Returns:

\Ceic\Api\Ceic\Api\Models\FeedResult

Parameters:
NameTypeDescription
$filterIdstringFilter ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$namestringName of the new record. Max length 100 (optional)
$descriptionstringDescription of the new record. Max length 1000 (optional)
$consolidationstringConsolidation Method (optional, default to zip)
$deliverystringDelivery Method (optional, default to web)
$userFtpUrlstringResult delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (optional, default to null)
$userFtpPathstringResult delivery path for local FTP server. Only valid when the localftp delivery method is selected. (optional, default to /ceic_data_dumps/)
$userFtpUsernamestringUsername for the local FTP server. Only valid when the localftp delivery method is selected. (optional, default to null)
$userFtpPasswordstringPassword for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (optional, default to null)
$notificationEmailstringWhen set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (optional, default to null)
$notificationUrlstringURL for push notification upon dump completion. (optional, default to null)
$notificationHttpMethodstringHTTP Method for push notifications. (optional, default to GET)
$frequencyintFeed generation frequency (optional, default to 1440)
$fullDumpboolWhen 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. (optional, default to false)
createFeedAsync(($filterId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $name = null, $description = null, $consolidation = 'zip', $delivery = 'web', $userFtpUrl = 'null', $userFtpPath = '/ceic_data_dumps/', $userFtpUsername = 'null', $userFtpPassword = 'null', $notificationEmail = 'null', $notificationUrl = 'null', $notificationHttpMethod = 'GET', $frequency = '1440', $fullDump = 'false'))

Subscribe for a feed

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$filterIdstringFilter ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$namestringName of the new record. Max length 100 (optional)
$descriptionstringDescription of the new record. Max length 1000 (optional)
$consolidationstringConsolidation Method (optional, default to zip)
$deliverystringDelivery Method (optional, default to web)
$userFtpUrlstringResult delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (optional, default to null)
$userFtpPathstringResult delivery path for local FTP server. Only valid when the localftp delivery method is selected. (optional, default to /ceic_data_dumps/)
$userFtpUsernamestringUsername for the local FTP server. Only valid when the localftp delivery method is selected. (optional, default to null)
$userFtpPasswordstringPassword for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (optional, default to null)
$notificationEmailstringWhen set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (optional, default to null)
$notificationUrlstringURL for push notification upon dump completion. (optional, default to null)
$notificationHttpMethodstringHTTP Method for push notifications. (optional, default to GET)
$frequencyintFeed generation frequency (optional, default to 1440)
$fullDumpboolWhen 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. (optional, default to false)
deleteFeed(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Delete feed

Returns:

\Ceic\Api\Ceic\Api\Models\FeedInformation

Parameters:
NameTypeDescription
$idstringFeed ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
deleteFeedAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Delete feed

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringFeed ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getFeed(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Get feed

Returns:

\Ceic\Api\Ceic\Api\Models\FeedInformation

Parameters:
NameTypeDescription
$idstringFeed ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getFeedAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Get feed

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringFeed ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getFeeds(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $offset = '0', $limit = '100', $createdAfter = null, $createdBefore = null, $filterId = null, $createdOrder = 'ASC', $status = null))

List all feed subscriptions

Returns:

\Ceic\Api\Ceic\Api\Models\FeedsResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$createdBefore\DateTimeWill return entries created after `created_before` date (optional)
$filterIdstringFilter 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. (optional)
$createdOrderstringChoose whether to order the entries ascending or descending. Default is Ascending (optional, default to ASC)
$statusstring[]Feed status (optional)
getFeedsAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $offset = '0', $limit = '100', $createdAfter = null, $createdBefore = null, $filterId = null, $createdOrder = 'ASC', $status = null))

List all feed subscriptions

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$createdBefore\DateTimeWill return entries created after `created_before` date (optional)
$filterIdstringFilter 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. (optional)
$createdOrderstringChoose whether to order the entries ascending or descending. Default is Ascending (optional, default to ASC)
$statusstring[]Feed status (optional)
updateFeed(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $name = null, $description = null, $consolidation = 'zip', $delivery = 'web', $userFtpUrl = 'null', $userFtpPath = '/ceic_data_dumps/', $userFtpUsername = 'null', $userFtpPassword = 'null', $notificationEmail = 'null', $notificationUrl = 'null', $notificationHttpMethod = 'GET', $frequency = '1440', $fullDump = 'false', $status = null, $filterId = null))

Update feed

Returns:

\Ceic\Api\Ceic\Api\Models\FeedInformation

Parameters:
NameTypeDescription
$idstringFeed ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$namestringName of the new record. Max length 100 (optional)
$descriptionstringDescription of the new record. Max length 1000 (optional)
$consolidationstringConsolidation Method (optional, default to zip)
$deliverystringDelivery Method (optional, default to web)
$userFtpUrlstringResult delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (optional, default to null)
$userFtpPathstringResult delivery path for local FTP server. Only valid when the localftp delivery method is selected. (optional, default to /ceic_data_dumps/)
$userFtpUsernamestringUsername for the local FTP server. Only valid when the localftp delivery method is selected. (optional, default to null)
$userFtpPasswordstringPassword for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (optional, default to null)
$notificationEmailstringWhen set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (optional, default to null)
$notificationUrlstringURL for push notification upon dump completion. (optional, default to null)
$notificationHttpMethodstringHTTP Method for push notifications. (optional, default to GET)
$frequencyintFeed generation frequency (optional, default to 1440)
$fullDumpboolWhen 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. (optional, default to false)
$statusstringFeed status (optional)
$filterIdstringFilter ID (optional)
updateFeedAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $name = null, $description = null, $consolidation = 'zip', $delivery = 'web', $userFtpUrl = 'null', $userFtpPath = '/ceic_data_dumps/', $userFtpUsername = 'null', $userFtpPassword = 'null', $notificationEmail = 'null', $notificationUrl = 'null', $notificationHttpMethod = 'GET', $frequency = '1440', $fullDump = 'false', $status = null, $filterId = null))

Update feed

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringFeed ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$namestringName of the new record. Max length 100 (optional)
$descriptionstringDescription of the new record. Max length 1000 (optional)
$consolidationstringConsolidation Method (optional, default to zip)
$deliverystringDelivery Method (optional, default to web)
$userFtpUrlstringResult delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (optional, default to null)
$userFtpPathstringResult delivery path for local FTP server. Only valid when the localftp delivery method is selected. (optional, default to /ceic_data_dumps/)
$userFtpUsernamestringUsername for the local FTP server. Only valid when the localftp delivery method is selected. (optional, default to null)
$userFtpPasswordstringPassword for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (optional, default to null)
$notificationEmailstringWhen set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (optional, default to null)
$notificationUrlstringURL for push notification upon dump completion. (optional, default to null)
$notificationHttpMethodstringHTTP Method for push notifications. (optional, default to GET)
$frequencyintFeed generation frequency (optional, default to 1440)
$fullDumpboolWhen 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. (optional, default to false)
$statusstringFeed status (optional)
$filterIdstringFilter ID (optional)
createFeedQuery((\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\FeedResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntityQuery entity object which contains the search information (required)
createFeedAsyncQuery((\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntityQuery entity object which contains the search information (required)
deleteFeedQuery((\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\FeedInformation

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntityQuery entity object which contains the search information (required)
deleteFeedAsyncQuery((\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntityQuery entity object which contains the search information (required)
getFeedQuery((\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\FeedInformation

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntityQuery entity object which contains the search information (required)
getFeedAsyncQuery((\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntityQuery entity object which contains the search information (required)
getFeedsQuery((\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\FeedsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntityQuery entity object which contains the search information (required)
getFeedsAsyncQuery((\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntityQuery entity object which contains the search information (required)
updateFeedQuery((\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\FeedInformation

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntityQuery entity object which contains the search information (required)
updateFeedAsyncQuery((\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntityQuery entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: FiltersApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

createFilter(($accept = 'json', $format = 'json', $token = null, $withModelInformation = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $series = null, $name = null, $description = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $topic = null, $section = null, $table = null, $status = '["T"]', $dataSource = null, $order = null, $database = null, $direction = null))

Create a filter

Returns:

\Ceic\Api\Ceic\Api\Models\FilterResult

Parameters:
NameTypeDescription
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$seriesstring[]List of series, comma separated. Its length cannot be more than 100000. (optional)
$namestringName of the new record. Max length 100 (optional)
$descriptionstringDescription of the new record. Max length 1000 (optional)
$keywordstringSearch 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 (optional)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$topicstring[]Topic filter. One or more comma separated topic code values. (optional)
$sectionstring[]Section filter. One or more comma separated section code values. (optional)
$tablestring[]Table filter. One or more comma separated table code values. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T"])
$dataSourcestring[]Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional)
$orderstring[]Sort order. Default is `relevance`. (optional)
$databasestring[]Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$directionstring[]Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
createFilterAsync(($accept = 'json', $format = 'json', $token = null, $withModelInformation = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $series = null, $name = null, $description = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $topic = null, $section = null, $table = null, $status = '["T"]', $dataSource = null, $order = null, $database = null, $direction = null))

Create a filter

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$seriesstring[]List of series, comma separated. Its length cannot be more than 100000. (optional)
$namestringName of the new record. Max length 100 (optional)
$descriptionstringDescription of the new record. Max length 1000 (optional)
$keywordstringSearch 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 (optional)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$topicstring[]Topic filter. One or more comma separated topic code values. (optional)
$sectionstring[]Section filter. One or more comma separated section code values. (optional)
$tablestring[]Table filter. One or more comma separated table code values. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T"])
$dataSourcestring[]Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional)
$orderstring[]Sort order. Default is `relevance`. (optional)
$databasestring[]Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$directionstring[]Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
deleteFilters(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Delete filters

Returns:

\Ceic\Api\Ceic\Api\Models\EmptyObject

Parameters:
NameTypeDescription
$idstringFilter ID. Accepts one or more comma separated values. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
deleteFiltersAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Delete filters

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringFilter ID. Accepts one or more comma separated values. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getFilters(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Get filter details

Returns:

\Ceic\Api\Ceic\Api\Models\FiltersResult

Parameters:
NameTypeDescription
$idstringFilter ID. Accepts one or more comma separated values. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getFiltersAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Get filter details

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringFilter ID. Accepts one or more comma separated values. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getUserFilters(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Get user filters

Returns:

\Ceic\Api\Ceic\Api\Models\FiltersResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getUserFiltersAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Get user filters

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
updateFilter(($id, $accept = 'json', $format = 'json', $token = null, $withModelInformation = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $series = null, $name = null, $description = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $topic = null, $section = null, $table = null, $status = '["T"]', $dataSource = null, $order = null, $database = null, $direction = null))

Update filter details

Returns:

\Ceic\Api\Ceic\Api\Models\FilterResult

Parameters:
NameTypeDescription
$idstringA single Filter ID value (required)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$seriesstring[]List of series, comma separated. Its length cannot be more than 100000. (optional)
$namestringName of the new record. Max length 100 (optional)
$descriptionstringDescription of the new record. Max length 1000 (optional)
$keywordstringSearch 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 (optional)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$topicstring[]Topic filter. One or more comma separated topic code values. (optional)
$sectionstring[]Section filter. One or more comma separated section code values. (optional)
$tablestring[]Table filter. One or more comma separated table code values. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T"])
$dataSourcestring[]Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional)
$orderstring[]Sort order. Default is `relevance`. (optional)
$databasestring[]Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$directionstring[]Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
updateFilterAsync(($id, $accept = 'json', $format = 'json', $token = null, $withModelInformation = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $series = null, $name = null, $description = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $topic = null, $section = null, $table = null, $status = '["T"]', $dataSource = null, $order = null, $database = null, $direction = null))

Update filter details

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringA single Filter ID value (required)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$seriesstring[]List of series, comma separated. Its length cannot be more than 100000. (optional)
$namestringName of the new record. Max length 100 (optional)
$descriptionstringDescription of the new record. Max length 1000 (optional)
$keywordstringSearch 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 (optional)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$topicstring[]Topic filter. One or more comma separated topic code values. (optional)
$sectionstring[]Section filter. One or more comma separated section code values. (optional)
$tablestring[]Table filter. One or more comma separated table code values. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T"])
$dataSourcestring[]Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional)
$orderstring[]Sort order. Default is `relevance`. (optional)
$databasestring[]Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$directionstring[]Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
createFilterQuery((\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\FilterResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntityQuery entity object which contains the search information (required)
createFilterAsyncQuery((\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntityQuery entity object which contains the search information (required)
deleteFiltersQuery((\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\EmptyObject

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntityQuery entity object which contains the search information (required)
deleteFiltersAsyncQuery((\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntityQuery entity object which contains the search information (required)
getFiltersQuery((\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\FiltersResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntityQuery entity object which contains the search information (required)
getFiltersAsyncQuery((\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntityQuery entity object which contains the search information (required)
getUserFiltersQuery((\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\FiltersResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntityQuery entity object which contains the search information (required)
getUserFiltersAsyncQuery((\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntityQuery entity object which contains the search information (required)
updateFilterQuery((\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\FilterResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntityQuery entity object which contains the search information (required)
updateFilterAsyncQuery((\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntityQuery entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: InsightsApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

downloadInsight(($id, $fileFormat, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $ignoreCache = 'false', $adjustColumns = 'no', $startDate = null, $endDate = null, $count = '3650', $blankObservations = 'filter', $orientation = 'cols', $order = 'asc', $decimalPlaces = '3', $dateFormat = null))

Request a downloadable insight report

Returns:

\Ceic\Api\Ceic\Api\Models\InsightDownloadResult

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$fileFormatstringInsight report file format. Available formats: `xlsx`, `pdf` (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$ignoreCacheboolNew file will be generated (optional, default to false)
$adjustColumnsstringNo adjust or wrap text in XLSX cell (optional, default to no)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$blankObservationsstringIf set to true, will return empty time-points which oterwise are omitted. (optional, default to filter)
$orientationstringColumns/rows orientation (optional, default to cols)
$orderstringSort order - Asc/Desc (optional, default to asc)
$decimalPlacesfloatDecimal places for the time-points values (optional, default to 3)
$dateFormatstringTime-points date format (optional)
downloadInsightAsync(($id, $fileFormat, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $ignoreCache = 'false', $adjustColumns = 'no', $startDate = null, $endDate = null, $count = '3650', $blankObservations = 'filter', $orientation = 'cols', $order = 'asc', $decimalPlaces = '3', $dateFormat = null))

Request a downloadable insight report

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$fileFormatstringInsight report file format. Available formats: `xlsx`, `pdf` (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$ignoreCacheboolNew file will be generated (optional, default to false)
$adjustColumnsstringNo adjust or wrap text in XLSX cell (optional, default to no)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$blankObservationsstringIf set to true, will return empty time-points which oterwise are omitted. (optional, default to filter)
$orientationstringColumns/rows orientation (optional, default to cols)
$orderstringSort order - Asc/Desc (optional, default to asc)
$decimalPlacesfloatDecimal places for the time-points values (optional, default to 3)
$dateFormatstringTime-points date format (optional)
getGalleryInsightsCategories(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Insight gallery categories

Returns:

\Ceic\Api\Ceic\Api\Models\InsightsCategoriesResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getGalleryInsightsCategoriesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Insight gallery categories

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getInsight(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Insights details

Returns:

\Ceic\Api\Ceic\Api\Models\InsightsResult

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getInsightAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Insights details

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getInsightSeries(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $limit = '100', $offset = '0'))

List of all series for a particular insight

Returns:

\Ceic\Api\Ceic\Api\Models\InsightSeriesPaginatedResult

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getInsightSeriesAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $limit = '100', $offset = '0'))

List of all series for a particular insight

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getInsightSeriesData(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $limit = '100', $offset = '0'))

List of all series time-points for a particular insight

Returns:

\Ceic\Api\Ceic\Api\Models\InsightSeriesPaginatedResult

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getInsightSeriesDataAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $limit = '100', $offset = '0'))

List of all series time-points for a particular insight

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getInsightSeriesList(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

List of series based on their insight series ID

Returns:

\Ceic\Api\Ceic\Api\Models\InsightSeriesResult

Parameters:
NameTypeDescription
$seriesIdstringInsight Series ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
getInsightSeriesListAsync(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

List of series based on their insight series ID

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$seriesIdstringInsight Series ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
getInsightSeriesListData(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active'))

List of series time-points based on their insight series ID

Returns:

\Ceic\Api\Ceic\Api\Models\InsightSeriesResult

Parameters:
NameTypeDescription
$seriesIdstringInsight Series ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
getInsightSeriesListDataAsync(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active'))

List of series time-points based on their insight series ID

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$seriesIdstringInsight Series ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
getInsightSeriesListMetadata(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

List of series metadata based on their insight series ID

Returns:

\Ceic\Api\Ceic\Api\Models\InsightSeriesResult

Parameters:
NameTypeDescription
$seriesIdstringInsight Series ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
getInsightSeriesListMetadataAsync(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

List of series metadata based on their insight series ID

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$seriesIdstringInsight Series ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
getInsightSeriesMetadata(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $limit = '100', $offset = '0'))

List of all series metadata for a particular insight

Returns:

\Ceic\Api\Ceic\Api\Models\InsightSeriesPaginatedResult

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getInsightSeriesMetadataAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $limit = '100', $offset = '0'))

List of all series metadata for a particular insight

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringInsight ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getInsights(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

List of User Created Insights

Returns:

\Ceic\Api\Ceic\Api\Models\InsightsResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getInsightsAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

List of User Created Insights

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getInsightsCategories(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Insight categories

Returns:

\Ceic\Api\Ceic\Api\Models\InsightsCategoriesResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getInsightsCategoriesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Insight categories

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
searchInsights(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $group = 'my', $limit = '30', $offset = '0', $keyword = null, $order = 'edit_date', $direction = 'asc', $tags = null, $categories = null))

Insights search

Returns:

\Ceic\Api\Ceic\Api\Models\InsightsSearchResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$groupstringInsights group. Default is `my`. (optional, default to my)
$limitfloatNumber of records to return (optional, default to 30)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$keywordstringSearch 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 (optional)
$orderobjectSort order (optional, default to edit_date)
$directionobjectSort order direction (optional, default to asc)
$tagsstring[]List of insight tags to search by tag (optional)
$categoriesstring[]List of insights categories to search by category (optional)
searchInsightsAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $group = 'my', $limit = '30', $offset = '0', $keyword = null, $order = 'edit_date', $direction = 'asc', $tags = null, $categories = null))

Insights search

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$groupstringInsights group. Default is `my`. (optional, default to my)
$limitfloatNumber of records to return (optional, default to 30)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$keywordstringSearch 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 (optional)
$orderobjectSort order (optional, default to edit_date)
$directionobjectSort order direction (optional, default to asc)
$tagsstring[]List of insight tags to search by tag (optional)
$categoriesstring[]List of insights categories to search by category (optional)
downloadInsightQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\InsightDownloadResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
downloadInsightAsyncQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getGalleryInsightsCategoriesQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\InsightsCategoriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getGalleryInsightsCategoriesAsyncQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\InsightsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightAsyncQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightSeriesQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\InsightSeriesPaginatedResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightSeriesAsyncQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightSeriesDataQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\InsightSeriesPaginatedResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightSeriesDataAsyncQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightSeriesListQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\InsightSeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightSeriesListAsyncQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightSeriesListDataQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\InsightSeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightSeriesListDataAsyncQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightSeriesListMetadataQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\InsightSeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightSeriesListMetadataAsyncQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightSeriesMetadataQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\InsightSeriesPaginatedResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightSeriesMetadataAsyncQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightsQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\InsightsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightsAsyncQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightsCategoriesQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\InsightsCategoriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
getInsightsCategoriesAsyncQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
searchInsightsQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\InsightsSearchResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)
searchInsightsAsyncQuery((\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntityQuery entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: InternalApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

getInternalRemarks(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns list of internal remarks

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesInternalRemarksResult

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
getInternalRemarksAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns list of internal remarks

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
getInternalRemarksQuery((\Ceic\Api\Models\QueryEntities\InternalApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesInternalRemarksResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InternalApiQueryEntityQuery entity object which contains the search information (required)
getInternalRemarksAsyncQuery((\Ceic\Api\Models\QueryEntities\InternalApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\InternalApiQueryEntityQuery entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: LayoutApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

getLayoutDatabases(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

List of databases

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutItemsResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
getLayoutDatabasesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

List of databases

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
getLayoutFootnote(($nodeCode, $acceptLanguage = 'en', $lang = 'en'))

Returns footnote of a node

Returns:

string

Parameters:
NameTypeDescription
$nodeCodestringNode Code - Database ID, Topic ID, Section ID or Table ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
getLayoutFootnoteAsync(($nodeCode, $acceptLanguage = 'en', $lang = 'en'))

Returns footnote of a node

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$nodeCodestringNode Code - Database ID, Topic ID, Section ID or Table ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
getLayoutFootnoteMetadata(($nodeCode, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns footnote metadata for a node

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutFootnoteMetadataResult

Parameters:
NameTypeDescription
$nodeCodestringNode Code - Database ID, Topic ID, Section ID or Table ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getLayoutFootnoteMetadataAsync(($nodeCode, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns footnote metadata for a node

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$nodeCodestringNode Code - Database ID, Topic ID, Section ID or Table ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getLayoutFootnoteResource(($nodeCode, $fileName, $acceptLanguage = 'en', $lang = 'en'))

Returns footnote resource file

Returns:

string

Parameters:
NameTypeDescription
$nodeCodestringNode Code - Database ID, Topic ID, Section ID or Table ID (required)
$fileNamestringResource file name (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
getLayoutFootnoteResourceAsync(($nodeCode, $fileName, $acceptLanguage = 'en', $lang = 'en'))

Returns footnote resource file

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$nodeCodestringNode Code - Database ID, Topic ID, Section ID or Table ID (required)
$fileNamestringResource file name (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
getLayoutFullMetadata(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Metadata including list of ancestors for node of particular type (topic) and code.

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutFullMetadataResult

Parameters:
NameTypeDescription
$idstringNode ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getLayoutFullMetadataAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Metadata including list of ancestors for node of particular type (topic) and code.

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringNode ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getLayoutSections(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

List of Sections

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutItemsResult

Parameters:
NameTypeDescription
$idstringTopic ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
getLayoutSectionsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

List of Sections

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringTopic ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
getLayoutSeries(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

List of Series

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesResult

Parameters:
NameTypeDescription
$idstringTable ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
getLayoutSeriesAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

List of Series

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringTable ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
getLayoutTables(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

List of Tables

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutItemsResult

Parameters:
NameTypeDescription
$idstringSection ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
getLayoutTablesAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

List of Tables

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSection ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
getLayoutTopics(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

List of Topics

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutItemsResult

Parameters:
NameTypeDescription
$idstringDatabase ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
getLayoutTopicsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T","C","B","D"]', $filterId = null))

List of Topics

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringDatabase ID (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T","C","B","D"])
$filterIdstring[]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. (optional)
getLayoutDatabasesQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutItemsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutDatabasesAsyncQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutFootnoteQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

string

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutFootnoteAsyncQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutFootnoteMetadataQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutFootnoteMetadataResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutFootnoteMetadataAsyncQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutFootnoteResourceQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

string

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutFootnoteResourceAsyncQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutFullMetadataQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutFullMetadataResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutFullMetadataAsyncQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutSectionsQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutFullMetadataResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutSectionsAsyncQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutSeriesQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutSeriesAsyncQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutTablesQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutItemsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutTablesAsyncQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutTopicsQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\LayoutItemsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)
getLayoutTopicsAsyncQuery((\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntityQuery entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: ReleasesApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

getReleaseSeries(($code, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $limit = '100', $offset = '0'))

List release code series.

Returns:

\Ceic\Api\Ceic\Api\Models\ReleaseSeriesResult

Parameters:
NameTypeDescription
$codestringRelease identifier code for a group of series with the same release schedule. Accepts only one release identifier code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getReleaseSeriesAsync(($code, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $limit = '100', $offset = '0'))

List release code series.

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$codestringRelease identifier code for a group of series with the same release schedule. Accepts only one release identifier code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getSeriesReleases(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $releaseDateFrom = null, $releaseDateTo = null, $releaseStatus = null, $offset = '0', $limit = '100'))

List of releases for a single series id

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesReleaseScheduleSearchResult

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$releaseDateFrom\DateTimeWill return releases with first observation before `release_date_from` (optional)
$releaseDateTo\DateTimeWill return releases with last observation after `release_date_to` (optional)
$releaseStatusstring[]List of release statuses to return (optional)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
getSeriesReleasesAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $releaseDateFrom = null, $releaseDateTo = null, $releaseStatus = null, $offset = '0', $limit = '100'))

List of releases for a single series id

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$releaseDateFrom\DateTimeWill return releases with first observation before `release_date_from` (optional)
$releaseDateTo\DateTimeWill return releases with last observation after `release_date_to` (optional)
$releaseStatusstring[]List of release statuses to return (optional)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
searchSeriesReleases(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $limit = '100', $offset = '0', $layout = null, $database = null, $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T"]', $dataSource = null, $series = null, $withVintageEnabledOnly = 'false', $headlineOnly = 'false', $topic = null, $section = null, $table = null, $order = null, $direction = null, $filterId = null, $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $facet = null, $releaseDateFrom = null, $releaseDateTo = null, $releaseStatus = null))

Released schedule search

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesReleaseScheduleSearchResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$layoutstring[]**DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$databasestring[]Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T"])
$dataSourcestring[]Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional)
$seriesstring[]List of series (optional)
$withVintageEnabledOnlyboolIf it is `true` result will contain ONLY vintage enabled series (optional, default to false)
$headlineOnlyboolShow only 'headline' series when set to `true`. (optional, default to false)
$topicstring[]Topic filter. One or more comma separated topic code values. (optional)
$sectionstring[]Section filter. One or more comma separated section code values. (optional)
$tablestring[]Table filter. One or more comma separated table code values. (optional)
$orderstring[]Sort order. Default is `relevance`. (optional)
$directionstring[]Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
$filterIdstring[]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. (optional)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$facetstring[]List of facets to return (optional)
$releaseDateFrom\DateTimeWill return releases with first observation before `release_date_from` (optional)
$releaseDateTo\DateTimeWill return releases with last observation after `release_date_to` (optional)
$releaseStatusstring[]List of release statuses to return (optional)
searchSeriesReleasesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $limit = '100', $offset = '0', $layout = null, $database = null, $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T"]', $dataSource = null, $series = null, $withVintageEnabledOnly = 'false', $headlineOnly = 'false', $topic = null, $section = null, $table = null, $order = null, $direction = null, $filterId = null, $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $facet = null, $releaseDateFrom = null, $releaseDateTo = null, $releaseStatus = null))

Released schedule search

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$layoutstring[]**DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$databasestring[]Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T"])
$dataSourcestring[]Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional)
$seriesstring[]List of series (optional)
$withVintageEnabledOnlyboolIf it is `true` result will contain ONLY vintage enabled series (optional, default to false)
$headlineOnlyboolShow only 'headline' series when set to `true`. (optional, default to false)
$topicstring[]Topic filter. One or more comma separated topic code values. (optional)
$sectionstring[]Section filter. One or more comma separated section code values. (optional)
$tablestring[]Table filter. One or more comma separated table code values. (optional)
$orderstring[]Sort order. Default is `relevance`. (optional)
$directionstring[]Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
$filterIdstring[]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. (optional)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$facetstring[]List of facets to return (optional)
$releaseDateFrom\DateTimeWill return releases with first observation before `release_date_from` (optional)
$releaseDateTo\DateTimeWill return releases with last observation after `release_date_to` (optional)
$releaseStatusstring[]List of release statuses to return (optional)
getReleaseSeriesQuery((\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\ReleaseSeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntityQuery entity object which contains the search information (required)
getReleaseSeriesAsyncQuery((\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesReleasesQuery((\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesReleaseScheduleSearchResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesReleasesAsyncQuery((\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntityQuery entity object which contains the search information (required)
searchSeriesReleasesQuery((\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesReleaseScheduleSearchResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntityQuery entity object which contains the search information (required)
searchSeriesReleasesAsyncQuery((\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntityQuery entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: SeriesApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

getContinuousSeries(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns continuous series information

Returns:

\Ceic\Api\Ceic\Api\Models\ContinuousSeriesResult

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getContinuousSeriesAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns continuous series information

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getContinuousSeriesTimePoints(($id, $chainId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns continuous series timepoints information

Returns:

\Ceic\Api\Ceic\Api\Models\ContinuousSeriesWithAppliedFunctionsResult

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$chainIdstringThe ID of the chain. Accepts only one ID. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getContinuousSeriesTimePointsAsync(($id, $chainId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns continuous series timepoints information

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$chainIdstringThe ID of the chain. Accepts only one ID. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getSeries(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $withHistoricalExtension = 'false'))

Returns full series data

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesResult

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$withHistoricalExtensionboolWhen set to true, series will include extended historical timepoints (optional, default to false)
getSeriesAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $withHistoricalExtension = 'false'))

Returns full series data

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$withHistoricalExtensionboolWhen set to true, series will include extended historical timepoints (optional, default to false)
getSeriesEarliest(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $withHistoricalExtension = 'false'))

Returns earliest possible data for PIT enabled series.

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesResult

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$withHistoricalExtensionboolWhen set to true, series will include extended historical timepoints (optional, default to false)
getSeriesEarliestAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $withHistoricalExtension = 'false'))

Returns earliest possible data for PIT enabled series.

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$withHistoricalExtensionboolWhen set to true, series will include extended historical timepoints (optional, default to false)
getSeriesMetadata(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns list of metadata items

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesResult

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
getSeriesMetadataAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false'))

Returns list of metadata items

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
getSeriesStatistics(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null'))

Returns list of items' statistics

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesStatisticsResult

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
getSeriesStatisticsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null'))

Returns list of items' statistics

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
getSeriesTimePoints(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withHistoricalExtension = 'false'))

Returns series time-points

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesResult

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withHistoricalExtensionboolWhen set to true, series will include extended historical timepoints (optional, default to false)
getSeriesTimePointsAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $vintageRevisionDate = 'null', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withHistoricalExtension = 'false'))

Returns series time-points

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withHistoricalExtensionboolWhen set to true, series will include extended historical timepoints (optional, default to false)
getSeriesVintages(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withHistoricalExtension = 'false'))

Vintage timepoints

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesResultWithVintages

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withHistoricalExtensionboolWhen set to true, series will include extended historical timepoints (optional, default to false)
getSeriesVintagesAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $count = '3650', $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = 'false', $timePointsStatus = 'active', $withHistoricalExtension = 'false'))

Vintage timepoints

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$countintLimit the amount of latest time-points returned, by the number specified. (optional, default to 3650)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$updatedAfter\DateTimeReturns only the updated time-points after the date specified. (optional)
$blankObservationsboolIf it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatusstringTime points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withHistoricalExtensionboolWhen set to true, series will include extended historical timepoints (optional, default to false)
getSeriesVintagesDates(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $startDate = null, $endDate = null, $count = null))

Lists vintage dates

Returns:

\Ceic\Api\Ceic\Api\Models\VintageDatesResult

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$startDate\DateTimeVintages dates start date in ISO format. (optional)
$endDate\DateTimeVintages dates end date in ISO format. (optional)
$countfloatNumber of timepoints to consider when extracting revision dates. (optional)
getSeriesVintagesDatesAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $startDate = null, $endDate = null, $count = null))

Lists vintage dates

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$startDate\DateTimeVintages dates start date in ISO format. (optional)
$endDate\DateTimeVintages dates end date in ISO format. (optional)
$countfloatNumber of timepoints to consider when extracting revision dates. (optional)
getSeriesVisual(($id, $accept = 'image/png', $format = 'png', $acceptLanguage = 'en', $lang = 'en', $token = null, $vintageRevisionDate = 'null', $startDate = null, $endDate = null, $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $width = null, $height = null, $period = null, $type = 'chart'))

Returns visual image

Returns:

string

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptstringResponse data format. Default is `image/png`. (optional, default to image/png)
$formatstringResponse data format. Default is `png` (optional, default to png)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$tokenstringAccess API key. (optional)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$widthfloatImage width (optional)
$heightfloatImage height (optional)
$periodfloatSeries time-pints mask. Example: 10y, 20m, 12d, 4w (optional)
$typestringVisual type (optional, default to chart)
getSeriesVisualAsync(($id, $accept = 'image/png', $format = 'png', $acceptLanguage = 'en', $lang = 'en', $token = null, $vintageRevisionDate = 'null', $startDate = null, $endDate = null, $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $width = null, $height = null, $period = null, $type = 'chart'))

Returns visual image

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptstringResponse data format. Default is `image/png`. (optional, default to image/png)
$formatstringResponse data format. Default is `png` (optional, default to png)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$tokenstringAccess API key. (optional)
$vintageRevisionDatestringWhen specified will return vintages snapshot at the specified revision date (YYYY-MM-DD). (optional, default to null)
$startDate\DateTimeLimits the start date after which the time-points will be returned. (optional)
$endDate\DateTimeLimits the end date before which the time-points will be returned. (optional)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$widthfloatImage width (optional)
$heightfloatImage height (optional)
$periodfloatSeries time-pints mask. Example: 10y, 20m, 12d, 4w (optional)
$typestringVisual type (optional, default to chart)
getVintageContinuousSeries(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns vintage continuous series information

Returns:

\Ceic\Api\Ceic\Api\Models\ContinuousSeriesResult

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getVintageContinuousSeriesAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns vintage continuous series information

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getVintageContinuousSeriesTimePoints(($id, $chainId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns vintage continuous series timepoints information

Returns:

\Ceic\Api\Ceic\Api\Models\ContinuousSeriesWithAppliedFunctionsResult

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$chainIdstringThe ID of the chain. Accepts only one ID. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getVintageContinuousSeriesTimePointsAsync(($id, $chainId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Returns vintage continuous series timepoints information

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringSeries ID or Series Code to return. Accepts only one series ID or series Code. (required)
$chainIdstringThe ID of the chain. Accepts only one ID. (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
searchSeries(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $limit = '100', $offset = '0', $layout = null, $database = null, $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T"]', $dataSource = null, $series = null, $withVintageEnabledOnly = 'false', $headlineOnly = 'false', $topic = null, $section = null, $table = null, $order = null, $direction = null, $filterId = null, $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $facet = null))

Series search

Returns:

\Ceic\Api\Ceic\Api\Models\SearchSeriesResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$layoutstring[]**DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$databasestring[]Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T"])
$dataSourcestring[]Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional)
$seriesstring[]List of series (optional)
$withVintageEnabledOnlyboolIf it is `true` result will contain ONLY vintage enabled series (optional, default to false)
$headlineOnlyboolShow only 'headline' series when set to `true`. (optional, default to false)
$topicstring[]Topic filter. One or more comma separated topic code values. (optional)
$sectionstring[]Section filter. One or more comma separated section code values. (optional)
$tablestring[]Table filter. One or more comma separated table code values. (optional)
$orderstring[]Sort order. Default is `relevance`. (optional)
$directionstring[]Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
$filterIdstring[]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. (optional)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$facetstring[]List of facets to return (optional)
searchSeriesAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $limit = '100', $offset = '0', $layout = null, $database = null, $keyword = null, $strictKeywordSearch = 'false', $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = 'false', $keyOnly = 'false', $newOnly = 'false', $nameOnly = 'false', $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $timepointsUpdatedAfter = null, $geo = null, $status = '["T"]', $dataSource = null, $series = null, $withVintageEnabledOnly = 'false', $headlineOnly = 'false', $topic = null, $section = null, $table = null, $order = null, $direction = null, $filterId = null, $withReplacementsMetadata = 'false', $forecastOnly = 'false', $withReleaseOnly = 'false', $withReplacementsOnly = 'false', $withObservationsOnly = 'false', $withContinuousOnly = 'false', $facet = null))

Series search

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$limitfloatNumber of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offsetfloatThe offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$layoutstring[]**DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$databasestring[]Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* CEICEPFRLI - *EPFR Macro Flows* CEICEPFRCF - *EPFR Country Flow* CEICEPFRCA - *EPFR Country Allocations* CEICEPFRFF - *EPFR Fund Flow* CEICGFI - *GFI Fenics Market Data* CEICMSCI - *MSCI Global Equity Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* ASEAN - *ASEAN Premium Database* APBN - *ASEAN: Brunei* APKH - *ASEAN: Cambodia* APLA - *ASEAN: Laos* APMY - *ASEAN: Malaysia* APMM - *ASEAN: Myanmar* APPH - *ASEAN: Philippines* APSG - *ASEAN: Singapore* APTH - *ASEAN: Thailand* APVN - *ASEAN: Vietnam* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional)
$keywordstringSearch 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 (optional)
$strictKeywordSearchboolWhen true, will make a strict keywords search instead of fuzzy search. (optional, default to false)
$frequencystring[]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 (optional)
$countrystring[]**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. (optional)
$sourcestring[]Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unitstring[]Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicatorstring[]Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional)
$regionstring[]Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnlyboolShow only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnlyboolShow only 'key' series when set to `true`. (optional, default to false)
$newOnlyboolShow only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnlyboolThis filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore\DateTimeWill return series with first observation before `start_date_before` (optional)
$endDateAfter\DateTimeWill return series with last observation after `end_date_after` (optional)
$createdAfter\DateTimeWill return entries created after `created_after` date (optional)
$updatedAfter\DateTimeWill return series last time updated after `updated_after` date and time (optional)
$timepointsUpdatedAfter\DateTimeWill return series containing timepoints' last time updated after updated_after date and time (optional)
$geostring[]Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$statusstring[]Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to ["T"])
$dataSourcestring[]Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional)
$seriesstring[]List of series (optional)
$withVintageEnabledOnlyboolIf it is `true` result will contain ONLY vintage enabled series (optional, default to false)
$headlineOnlyboolShow only 'headline' series when set to `true`. (optional, default to false)
$topicstring[]Topic filter. One or more comma separated topic code values. (optional)
$sectionstring[]Section filter. One or more comma separated section code values. (optional)
$tablestring[]Table filter. One or more comma separated table code values. (optional)
$orderstring[]Sort order. Default is `relevance`. (optional)
$directionstring[]Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
$filterIdstring[]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. (optional)
$withReplacementsMetadataboolIf it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnlyboolIf it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnlyboolIf it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnlyboolIf it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnlyboolIf it is `true` result will not contain series without observations (optional, default to false)
$withContinuousOnlyboolIf set to `true` results will contain only series with available historical extensions (optional, default to false)
$facetstring[]List of facets to return (optional)
getContinuousSeriesQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\ContinuousSeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getContinuousSeriesAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getContinuousSeriesTimePointsQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\ContinuousSeriesWithAppliedFunctionsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getContinuousSeriesTimePointsAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesEarliestQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesEarliestAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesMetadataQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesMetadataAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesStatisticsQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesStatisticsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesStatisticsAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesTimePointsQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesTimePointsAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesVintagesQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SeriesResultWithVintages

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesVintagesAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesVintagesDatesQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\VintageDatesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesVintagesDatesAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesVisualQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

string

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getSeriesVisualAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getVintageContinuousSeriesQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\ContinuousSeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getVintageContinuousSeriesAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getVintageContinuousSeriesTimePointsQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\ContinuousSeriesWithAppliedFunctionsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
getVintageContinuousSeriesTimePointsAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
searchSeriesQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\SearchSeriesResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)
searchSeriesAsyncQuery((\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntityQuery entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: SessionsApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

generateImpersonateToken(($employeeToken, $userId, $application, $expireAfter = '86400'))

Generate impersonate token

Returns:

\Ceic\Api\Ceic\Api\Models\ImpersonateAPIKeyResult

Parameters:
NameTypeDescription
$employeeTokenstringImpersonate API token generated on CAS service (required)
$userIdstringUser Id (required)
$applicationstringApplication ID (required)
$expireAfterfloatToken will be expired after `expire_after` in seconds (optional, default to 86400)
generateImpersonateTokenAsync(($employeeToken, $userId, $application, $expireAfter = '86400'))

Generate impersonate token

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$employeeTokenstringImpersonate API token generated on CAS service (required)
$userIdstringUser Id (required)
$applicationstringApplication ID (required)
$expireAfterfloatToken will be expired after `expire_after` in seconds (optional, default to 86400)
getSubscriptions(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Get user subscriptions

Returns:

\Ceic\Api\Ceic\Api\Models\UserSubscriptionsResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getSubscriptionsAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Get user subscriptions

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
login(($login, $password, $application, $applicationVersion = null))

Authenticates the user, creating a new session.

Returns:

\Ceic\Api\Ceic\Api\Models\UserSessionResult

Parameters:
NameTypeDescription
$loginstringUsername (required)
$passwordstringPassword (required)
$applicationstringApplication ID (required)
$applicationVersionstringApplication Version (optional)
loginAsync(($login, $password, $application, $applicationVersion = null))

Authenticates the user, creating a new session.

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$loginstringUsername (required)
$passwordstringPassword (required)
$applicationstringApplication ID (required)
$applicationVersionstringApplication Version (optional)
logout(($session))

Close existing API session.

Returns:

\Ceic\Api\Ceic\Api\Models\SessionStatusResult

Parameters:
NameTypeDescription
$sessionstringUser session (required)
logoutAsync(($session))

Close existing API session.

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$sessionstringUser session (required)
validateCredentials(($login, $password))

Check if user's login/password are valid

Returns:

\Ceic\Api\Ceic\Api\Models\UserCredentialsValidationResult

Parameters:
NameTypeDescription
$loginstringUsername (required)
$passwordstringPassword (required)
validateCredentialsAsync(($login, $password))

Check if user's login/password are valid

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$loginstringUsername (required)
$passwordstringPassword (required)
generateImpersonateTokenQuery((\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\ImpersonateAPIKeyResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntityQuery entity object which contains the search information (required)
generateImpersonateTokenAsyncQuery((\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntityQuery entity object which contains the search information (required)
getSubscriptionsQuery((\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UserSubscriptionsResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntityQuery entity object which contains the search information (required)
getSubscriptionsAsyncQuery((\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntityQuery entity object which contains the search information (required)
loginQuery((\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\UserSessionResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntityQuery entity object which contains the search information (required)
loginAsyncQuery((\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntityQuery entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: WatchlistApi( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null )

getConfig(())

Returns:

Configuration

createWatchlist(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $popupNotifications = null, $emailNotifications = null))

Create Watchlist

Returns:

\Ceic\Api\Ceic\Api\Models\WatchlistProcessedResult

Parameters:
NameTypeDescription
$seriesIdstringWatchlist Series IDs, comma separated (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$popupNotificationsboolIf set to true enables popup notifications for watchlist subscription (optional)
$emailNotificationsstringIf set, specifies the email notification frequency (optional)
createWatchlistAsync(($seriesId, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $popupNotifications = null, $emailNotifications = null))

Create Watchlist

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$seriesIdstringWatchlist Series IDs, comma separated (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$popupNotificationsboolIf set to true enables popup notifications for watchlist subscription (optional)
$emailNotificationsstringIf set, specifies the email notification frequency (optional)
deleteWatchlist(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Delete watchlist

Returns:

\Ceic\Api\Ceic\Api\Models\WatchlistProcessedResult

Parameters:
NameTypeDescription
$idstringWatchlist Series IDs, comma separated (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
deleteWatchlistAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Delete watchlist

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringWatchlist Series IDs, comma separated (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getWatchlist(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Lists all watchlist subscriptions

Returns:

\Ceic\Api\Ceic\Api\Models\WatchlistGetResult

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
getWatchlistAsync(($acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false'))

Lists all watchlist subscriptions

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
updateWatchlist(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $popupNotifications = null, $emailNotifications = null))

Update watchlist

Returns:

\Ceic\Api\Ceic\Api\Models\WatchlistProcessedResult

Parameters:
NameTypeDescription
$idstringWatchlist Series IDs, comma separated (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$popupNotificationsboolIf set to true enables popup notifications for watchlist subscription (optional)
$emailNotificationsstringIf set, specifies the email notification frequency (optional)
updateWatchlistAsync(($id, $acceptLanguage = 'en', $accept = 'json', $lang = 'en', $format = 'json', $token = null, $withModelInformation = 'false', $popupNotifications = null, $emailNotifications = null))

Update watchlist

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$idstringWatchlist Series IDs, comma separated (required)
$acceptLanguagestringPreferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$acceptstringResponse data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$langstringPreferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$formatstringResponse data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$tokenstringAccess API key. (optional)
$withModelInformationboolIf set to `true` returns the model names as part of the response. (optional, default to false)
$popupNotificationsboolIf set to true enables popup notifications for watchlist subscription (optional)
$emailNotificationsstringIf set, specifies the email notification frequency (optional)
createWatchlistQuery((\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\WatchlistProcessedResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntityQuery entity object which contains the search information (required)
createWatchlistAsyncQuery((\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntityQuery entity object which contains the search information (required)
deleteWatchlistQuery((\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\WatchlistProcessedResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntityQuery entity object which contains the search information (required)
deleteWatchlistAsyncQuery((\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntityQuery entity object which contains the search information (required)
getWatchlistQuery((\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\WatchlistGetResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntityQuery entity object which contains the search information (required)
getWatchlistAsyncQuery((\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntityQuery entity object which contains the search information (required)
updateWatchlistQuery((\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntity $queryEntity))

Returns:

\Ceic\Api\Ceic\Api\Models\WatchlistProcessedResult

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntityQuery entity object which contains the search information (required)
updateWatchlistAsyncQuery((\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntity $queryEntity))

Returns:

\GuzzleHttp\Promise\PromiseInterface

Parameters:
NameTypeDescription
$queryEntity\Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntityQuery entity object which contains the search information (required)

Result Types:

Ceic\Api\Models.BaseSeriesInformation(array $data = null)
Ceic\Api\Models.Classification(array $data = null)
Ceic\Api\Models.ClassificationsResult(array $data = null)
Ceic\Api\Models.ContinuousSeriesItem(array $data = null)
Ceic\Api\Models.ContinuousSeriesList(array $data = null)
Ceic\Api\Models.ContinuousSeriesResult(array $data = null)
Ceic\Api\Models.ContinuousSeriesResultData(array $data = null)
Ceic\Api\Models.ContinuousSeriesTimePointItem(array $data = null)
Ceic\Api\Models.ContinuousSeriesWithAppliedFunctionsList(array $data = null)
Ceic\Api\Models.ContinuousSeriesWithAppliedFunctionsResult(array $data = null)
Ceic\Api\Models.ContinuousSeriesWithAppliedFunctionsResultData(array $data = null)
Ceic\Api\Models.CountriesResult(array $data = null)
Ceic\Api\Models.Country(array $data = null)
Ceic\Api\Models.DictionaryData(array $data = null)
Ceic\Api\Models.DictionaryResult(array $data = null)
Ceic\Api\Models.DumpInformation(array $data = null)
Ceic\Api\Models.DumpListInformation(array $data = null)
Ceic\Api\Models.DumpListResult(array $data = null)
Ceic\Api\Models.DumpResult(array $data = null)
Ceic\Api\Models.EmptyObject(array $data = null)
Ceic\Api\Models.Facet(array $data = null)
Ceic\Api\Models.FacetEntry(array $data = null)
Ceic\Api\Models.FeedInformation(array $data = null)
Ceic\Api\Models.FeedResult(array $data = null)
Ceic\Api\Models.FeedsResult(array $data = null)
Ceic\Api\Models.FilterDetails(array $data = null)
Ceic\Api\Models.FilterDetailsSearch(array $data = null)
Ceic\Api\Models.FilterResult(array $data = null)
Ceic\Api\Models.FiltersResult(array $data = null)
Ceic\Api\Models.FrequenciesResult(array $data = null)
Ceic\Api\Models.Frequency(array $data = null)
Ceic\Api\Models.Geo(array $data = null)
Ceic\Api\Models.GeoInfo(array $data = null)
Ceic\Api\Models.GeoInfoInner(array $data = null)
Ceic\Api\Models.GeoResult(array $data = null)
Ceic\Api\Models.ImpersonateAPIKey(array $data = null)
Ceic\Api\Models.ImpersonateAPIKeyResult(array $data = null)
Ceic\Api\Models.Indicator(array $data = null)
Ceic\Api\Models.IndicatorsChain(array $data = null)
Ceic\Api\Models.IndicatorsChainItem(array $data = null)
Ceic\Api\Models.IndicatorsResult(array $data = null)
Ceic\Api\Models.InsightDownload(array $data = null)
Ceic\Api\Models.InsightDownloadResult(array $data = null)
Ceic\Api\Models.InsightDownloadResultData(array $data = null)
Ceic\Api\Models.InsightSeries(array $data = null)
Ceic\Api\Models.InsightSeriesInformation(array $data = null)
Ceic\Api\Models.InsightSeriesPaginatedResult(array $data = null)
Ceic\Api\Models.InsightSeriesPaginatedResultData(array $data = null)
Ceic\Api\Models.InsightSeriesResult(array $data = null)
Ceic\Api\Models.Insights(array $data = null)
Ceic\Api\Models.InsightsCategoriesResult(array $data = null)
Ceic\Api\Models.InsightsCategory(array $data = null)
Ceic\Api\Models.InsightsResult(array $data = null)
Ceic\Api\Models.InsightsSearch(array $data = null)
Ceic\Api\Models.InsightsSearchResult(array $data = null)
Ceic\Api\Models.InternalSeriesRemarks(array $data = null)
Ceic\Api\Models.Layout(array $data = null)
Ceic\Api\Models.LayoutAncestors(array $data = null)
Ceic\Api\Models.LayoutFootnoteMetadata(array $data = null)
Ceic\Api\Models.LayoutFootnoteMetadataItem(array $data = null)
Ceic\Api\Models.LayoutFootnoteMetadataResult(array $data = null)
Ceic\Api\Models.LayoutFootnoteResourceMetadataItem(array $data = null)
Ceic\Api\Models.LayoutFullMetadataItem(array $data = null)
Ceic\Api\Models.LayoutFullMetadataResult(array $data = null)
Ceic\Api\Models.LayoutInformation(array $data = null)
Ceic\Api\Models.LayoutInformationList(array $data = null)
Ceic\Api\Models.LayoutItem(array $data = null)
Ceic\Api\Models.LayoutItemMetadata(array $data = null)
Ceic\Api\Models.LayoutItemUI(array $data = null)
Ceic\Api\Models.LayoutItemsResult(array $data = null)
Ceic\Api\Models.LayoutsResult(array $data = null)
Ceic\Api\Models.Province(array $data = null)
Ceic\Api\Models.Region(array $data = null)
Ceic\Api\Models.RegionsResult(array $data = null)
Ceic\Api\Models.ReleaseScheduleStatus(array $data = null)
Ceic\Api\Models.ReleaseScheduleType(array $data = null)
Ceic\Api\Models.ReleaseSeries(array $data = null)
Ceic\Api\Models.ReleaseSeriesList(array $data = null)
Ceic\Api\Models.ReleaseSeriesResult(array $data = null)
Ceic\Api\Models.ReleaseStatusesResult(array $data = null)
Ceic\Api\Models.ReleaseTypesResult(array $data = null)
Ceic\Api\Models.ResponseError(array $data = null)
Ceic\Api\Models.SearchSeries(array $data = null)
Ceic\Api\Models.SearchSeriesResult(array $data = null)
Ceic\Api\Models.Series(array $data = null)
Ceic\Api\Models.SeriesData(array $data = null)
Ceic\Api\Models.SeriesFilter(array $data = null)
Ceic\Api\Models.SeriesGrouping(array $data = null)
Ceic\Api\Models.SeriesInformation(array $data = null)
Ceic\Api\Models.SeriesInternalRemarksResult(array $data = null)
Ceic\Api\Models.SeriesMetadata(array $data = null)
Ceic\Api\Models.SeriesMetadataLastChange(array $data = null)
Ceic\Api\Models.SeriesReleaseScheduleItem(array $data = null)
Ceic\Api\Models.SeriesReleaseScheduleResult(array $data = null)
Ceic\Api\Models.SeriesReleaseScheduleSearchResult(array $data = null)
Ceic\Api\Models.SeriesReleases(array $data = null)
Ceic\Api\Models.SeriesReleasesSearch(array $data = null)
Ceic\Api\Models.SeriesReplacements(array $data = null)
Ceic\Api\Models.SeriesResult(array $data = null)
Ceic\Api\Models.SeriesStatistics(array $data = null)
Ceic\Api\Models.SeriesStatisticsItem(array $data = null)
Ceic\Api\Models.SeriesStatisticsResult(array $data = null)
Ceic\Api\Models.SeriesUISettings(array $data = null)
Ceic\Api\Models.SessionStatus(array $data = null)
Ceic\Api\Models.SessionStatusResult(array $data = null)
Ceic\Api\Models.Source(array $data = null)
Ceic\Api\Models.Status(array $data = null)
Ceic\Api\Models.SeriesResultWithVintages(array $data = null)
Ceic\Api\Models.SeriesWithVintages(array $data = null)
Ceic\Api\Models.TimePointWithVintages(array $data = null)
Ceic\Api\Models.UserdefinedClonedSeries(array $data = null)
Ceic\Api\Models.UserdefinedClonedSeriesResponse(array $data = null)
Ceic\Api\Models.UserdefinedClonedSeriesResult(array $data = null)
Ceic\Api\Models.UserdefinedCreateSeriesDataResult(array $data = null)
Ceic\Api\Models.UserdefinedCreatedSeries(array $data = null)
Ceic\Api\Models.UserdefinedCreatedSeriesDataResponse(array $data = null)
Ceic\Api\Models.UserdefinedCreatedSeriesResponse(array $data = null)
Ceic\Api\Models.UserdefinedCreatedSeriesResult(array $data = null)
Ceic\Api\Models.UserdefinedCreatedTimePoint(array $data = null)
Ceic\Api\Models.UserdefinedDeleteSeriesDataResult(array $data = null)
Ceic\Api\Models.UserdefinedDeletedSeries(array $data = null)
Ceic\Api\Models.UserdefinedDeletedSeriesDataBulkResponse(array $data = null)
Ceic\Api\Models.UserdefinedDeletedSeriesDataBulkResult(array $data = null)
Ceic\Api\Models.UserdefinedDeletedSeriesDataResponse(array $data = null)
Ceic\Api\Models.UserdefinedDeletedSeriesResponse(array $data = null)
Ceic\Api\Models.UserdefinedDeletedSeriesResult(array $data = null)
Ceic\Api\Models.UserdefinedDeletedTimePoint(array $data = null)
Ceic\Api\Models.UserdefinedPatchSeriesDataResult(array $data = null)
Ceic\Api\Models.UserdefinedPatchedSeriesDataResponse(array $data = null)
Ceic\Api\Models.UserdefinedPatchedTimePoint(array $data = null)
Ceic\Api\Models.UserdefinedSeries(array $data = null)
Ceic\Api\Models.UserdefinedSeriesDataResponse(array $data = null)
Ceic\Api\Models.UserdefinedSeriesDataResult(array $data = null)
Ceic\Api\Models.UserdefinedSeriesMetadata(array $data = null)
Ceic\Api\Models.UserdefinedSeriesResponse(array $data = null)
Ceic\Api\Models.UserdefinedSeriesResult(array $data = null)
Ceic\Api\Models.UserdefinedTimePoint(array $data = null)
Ceic\Api\Models.UserdefinedTimepointData(array $data = null)
Ceic\Api\Models.VintageDate(array $data = null)
Ceic\Api\Models.VintageDatesResult(array $data = null)
Ceic\Api\Models.VintageTimepoint(array $data = null)
Ceic\Api\Models.Unit(array $data = null)
Ceic\Api\Models.UnitsResult(array $data = null)
Ceic\Api\Models.UserCredentialsValidationResult(array $data = null)
Ceic\Api\Models.UserCredentialsValidationResultData(array $data = null)
Ceic\Api\Models.UserInformation(array $data = null)
Ceic\Api\Models.UserSession(array $data = null)
Ceic\Api\Models.UserSessionResult(array $data = null)
Ceic\Api\Models.UserSubscriptionsResult(array $data = null)
Ceic\Api\Models.WatchlistGetResult(array $data = null)
Ceic\Api\Models.WatchlistItem(array $data = null)
Ceic\Api\Models.WatchlistProcessedInformation(array $data = null)
Ceic\Api\Models.WatchlistProcessedResult(array $data = null)
Ceic\Api\Models.SourcesResult(array $data = null)
Ceic\Api\Models.StatusesResult(array $data = null)
Ceic\Api\Models.SubscriptionItem(array $data = null)
Ceic\Api\Models.TimePoint(array $data = null)
Ceic\Api\Models\QueryEntities.DefaultApiQueryEntity()
Ceic\Api\Models\QueryEntities.UserdefinedApiQueryEntity()
Ceic\Api\Models\QueryEntities.DictionaryApiQueryEntity()
Ceic\Api\Models\QueryEntities.DumpsApiQueryEntity()
Ceic\Api\Models\QueryEntities.FeedsApiQueryEntity()
Ceic\Api\Models\QueryEntities.FiltersApiQueryEntity()
Ceic\Api\Models\QueryEntities.InsightsApiQueryEntity()
Ceic\Api\Models\QueryEntities.InternalApiQueryEntity()
Ceic\Api\Models\QueryEntities.LayoutApiQueryEntity()
Ceic\Api\Models\QueryEntities.ReleasesApiQueryEntity()
Ceic\Api\Models\QueryEntities.SeriesApiQueryEntity()
Ceic\Api\Models\QueryEntities.SessionsApiQueryEntity()
Ceic\Api\Models\QueryEntities.WatchlistApiQueryEntity()