Get API client
\Ceic\Api\ApiClient
Set the API client
DictionaryApi
Name | Type | Description |
---|---|---|
$apiClient | \Ceic\Api\ApiClient | set the API client |
List of indicators for specific classification
\Ceic\Api\Models\IndicatorsResult
Name | Type | Description |
---|---|---|
$id | string | Classification ID. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Classifications list
\Ceic\Api\Models\ClassificationsResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
DEPRECATED. Please use `/dictionary/geo`. Countries list
\Ceic\Api\Models\CountriesResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
List of sources for a specific country
\Ceic\Api\Models\SourcesResult
Name | Type | Description |
---|---|---|
$id | string | Country ISO code (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Full dictionary list
\Ceic\Api\Models\DictionaryResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Frequencies list
\Ceic\Api\Models\FrequenciesResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Geo list
\Ceic\Api\Models\GeoResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Indicators list
\Ceic\Api\Models\IndicatorsResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
DEPRECATED. Please use `/layout/databases`. Database layouts list
\Ceic\Api\Models\LayoutsResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Regions list
\Ceic\Api\Models\RegionsResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Release schedule statuses list
\Ceic\Api\Models\ReleaseStatusesResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Release schedule types list
\Ceic\Api\Models\ReleaseTypesResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Sources list
\Ceic\Api\Models\SourcesResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Statuses list
\Ceic\Api\Models\StatusesResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Units list
\Ceic\Api\Models\UnitsResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
\Ceic\Api\Models\IndicatorsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\ClassificationsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\CountriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\SourcesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\DictionaryResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\FrequenciesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\GeoResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\IndicatorsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\LayoutsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\RegionsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\ReleaseStatusesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\ReleaseTypesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\SourcesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\StatusesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\UnitsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity | Query entity object which contains the search information (required) |
Get API client
\Ceic\Api\ApiClient
Set the API client
DumpsApi
Name | Type | Description |
---|---|---|
$apiClient | \Ceic\Api\ApiClient | set the API client |
Cancel dump
\Ceic\Api\Models\DumpResult
Name | Type | Description |
---|---|---|
$id | string | Dump ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Create dump
\Ceic\Api\Models\DumpResult
Name | Type | Description |
---|---|---|
$filterId | string | Filter ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$name | string | Name of the new record. Max length 100 (optional) |
$description | string | Description of the new record. Max length 1000 (optional) |
$consolidation | string | Consolidation Method (optional, default to zip) |
$delivery | string | Delivery Method (optional, default to web) |
$userFtpUrl | string | Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (optional) |
$userFtpPath | string | Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. (optional, default to /ceic_data_dumps/) |
$userFtpUsername | string | Username for the local FTP server. Only valid when the localftp delivery method is selected. (optional) |
$userFtpPassword | string | Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (optional) |
$notificationEmail | string | When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (optional) |
$notificationUrl | string | URL for push notification upon dump completion. (optional) |
$notificationHttpMethod | string | HTTP Method for push notifications. (optional, default to GET) |
Get dump
\Ceic\Api\Models\DumpResult
Name | Type | Description |
---|---|---|
$id | string | Dump ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
List dumps
\Ceic\Api\Models\DumpListResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$offset | float | The 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) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$createdBefore | \DateTime | Will return entries created after `created_before` date (optional) |
$filterId | string | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
$createdOrder | string | Choose whether to order the entries ascending or descending. Default is Ascending (optional, default to ASC) |
$status | string[] | Dump status (optional) |
$feedId | string | Feed ID (optional) |
\Ceic\Api\Models\DumpResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\DumpResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\DumpResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\DumpListResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity | Query entity object which contains the search information (required) |
Get API client
\Ceic\Api\ApiClient
Set the API client
FeedsApi
Name | Type | Description |
---|---|---|
$apiClient | \Ceic\Api\ApiClient | set the API client |
Subscribe for a feed
\Ceic\Api\Models\FeedResult
Name | Type | Description |
---|---|---|
$filterId | string | Filter ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$name | string | Name of the new record. Max length 100 (optional) |
$description | string | Description of the new record. Max length 1000 (optional) |
$consolidation | string | Consolidation Method (optional, default to zip) |
$delivery | string | Delivery Method (optional, default to web) |
$userFtpUrl | string | Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (optional) |
$userFtpPath | string | Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. (optional, default to /ceic_data_dumps/) |
$userFtpUsername | string | Username for the local FTP server. Only valid when the localftp delivery method is selected. (optional) |
$userFtpPassword | string | Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (optional) |
$notificationEmail | string | When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (optional) |
$notificationUrl | string | URL for push notification upon dump completion. (optional) |
$notificationHttpMethod | string | HTTP Method for push notifications. (optional, default to GET) |
$frequency | int | Feed generation frequency (optional, default to 1440) |
$fullDump | bool | When set to true, the feed will always generate full list of time points. This option is only available for lists that are equal or less than 3,000 series. (optional, default to false) |
Delete feed
\Ceic\Api\Models\FeedInformation
Name | Type | Description |
---|---|---|
$id | string | Feed ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Get feed
\Ceic\Api\Models\FeedInformation
Name | Type | Description |
---|---|---|
$id | string | Feed ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
List all feed subscriptions
\Ceic\Api\Models\FeedsResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$offset | float | The 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) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$createdBefore | \DateTime | Will return entries created after `created_before` date (optional) |
$filterId | string | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
$createdOrder | string | Choose whether to order the entries ascending or descending. Default is Ascending (optional, default to ASC) |
$status | string[] | Feed status (optional) |
Update feed
\Ceic\Api\Models\FeedInformation
Name | Type | Description |
---|---|---|
$id | string | Feed ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$name | string | Name of the new record. Max length 100 (optional) |
$description | string | Description of the new record. Max length 1000 (optional) |
$consolidation | string | Consolidation Method (optional, default to zip) |
$delivery | string | Delivery Method (optional, default to web) |
$userFtpUrl | string | Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. Can also include port: ftp|sftp://myftphost.com:2222. If no port is specified 21|22 is used for FTP|SFTP respectfully. (optional) |
$userFtpPath | string | Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. (optional, default to /ceic_data_dumps/) |
$userFtpUsername | string | Username for the local FTP server. Only valid when the localftp delivery method is selected. (optional) |
$userFtpPassword | string | Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (optional) |
$notificationEmail | string | When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (optional) |
$notificationUrl | string | URL for push notification upon dump completion. (optional) |
$notificationHttpMethod | string | HTTP Method for push notifications. (optional, default to GET) |
$frequency | int | Feed generation frequency (optional, default to 1440) |
$fullDump | bool | When set to true, the feed will always generate full list of time points. This option is only available for lists that are equal or less than 3,000 series. (optional, default to false) |
$status | string | Feed status (optional) |
$filterId | string | Filter ID (optional) |
\Ceic\Api\Models\FeedResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\FeedInformation
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\FeedInformation
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\FeedsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\FeedInformation
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity | Query entity object which contains the search information (required) |
Get API client
\Ceic\Api\ApiClient
Set the API client
FiltersApi
Name | Type | Description |
---|---|---|
$apiClient | \Ceic\Api\ApiClient | set the API client |
Create a filter
\Ceic\Api\Models\FilterResult
Name | Type | Description |
---|---|---|
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$series | string[] | List of series, comma separated. Its length cannot be more than 100000. (optional) |
$name | string | Name of the new record. Max length 100 (optional) |
$description | string | Description of the new record. Max length 1000 (optional) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$topic | string[] | Topic filter. One or more comma separated topic code values. (optional) |
$section | string[] | Section filter. One or more comma separated section code values. (optional) |
$table | string[] | Table filter. One or more comma separated table code values. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T]) |
$dataSource | string[] | Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional, default to CEIC) |
$order | string[] | Sort order. Default is `relevance`. (optional) |
$database | string[] | Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional) |
$direction | string[] | Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional) |
Delete filters
\Ceic\Api\Models\EmptyObject
Name | Type | Description |
---|---|---|
$id | string | Filter ID. Accepts one or more comma separated values. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Get filter details
\Ceic\Api\Models\FiltersResult
Name | Type | Description |
---|---|---|
$id | string | Filter ID. Accepts one or more comma separated values. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Get user filters
\Ceic\Api\Models\FiltersResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Update filter details
\Ceic\Api\Models\FilterResult
Name | Type | Description |
---|---|---|
$id | string | A single Filter ID value (required) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$series | string[] | List of series, comma separated. Its length cannot be more than 100000. (optional) |
$name | string | Name of the new record. Max length 100 (optional) |
$description | string | Description of the new record. Max length 1000 (optional) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$topic | string[] | Topic filter. One or more comma separated topic code values. (optional) |
$section | string[] | Section filter. One or more comma separated section code values. (optional) |
$table | string[] | Table filter. One or more comma separated table code values. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T]) |
$dataSource | string[] | Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional, default to CEIC) |
$order | string[] | Sort order. Default is `relevance`. (optional) |
$database | string[] | Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional) |
$direction | string[] | Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional) |
\Ceic\Api\Models\FilterResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\EmptyObject
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\FiltersResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\FiltersResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\FilterResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity | Query entity object which contains the search information (required) |
Get API client
\Ceic\Api\ApiClient
Set the API client
InsightsApi
Name | Type | Description |
---|---|---|
$apiClient | \Ceic\Api\ApiClient | set the API client |
Request a downloadable insight report
\Ceic\Api\Models\InsightDownloadResult
Name | Type | Description |
---|---|---|
$id | string | Insight ID (required) |
$fileFormat | string | Insight report file format. Available formats: `xlsx`, `pdf` (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$ignoreCache | bool | New file will be generated (optional, default to false) |
$adjustColumns | string | No adjust or wrap text in XLSX cell (optional, default to no) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$blankObservations | string | If set to true, will return empty time-points which oterwise are omitted. (optional, default to filter) |
$orientation | string | Columns/rows orientation (optional, default to cols) |
$order | string | Sort order - Asc/Desc (optional, default to asc) |
$decimalPlaces | float | Decimal places for the time-points values (optional, default to 3) |
$dateFormat | string | Time-points date format (optional) |
Insight gallery categories
\Ceic\Api\Models\InsightsCategoriesResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Insights details
\Ceic\Api\Models\InsightsResult
Name | Type | Description |
---|---|---|
$id | string | Insight ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
List of all series for a particular insight
\Ceic\Api\Models\InsightSeriesPaginatedResult
Name | Type | Description |
---|---|---|
$id | string | Insight ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$updatedAfter | \DateTime | Returns only the updated time-points after the date specified. (optional) |
$blankObservations | bool | If it's set to true, empty time-points will be returned (optional, default to false) |
$timePointsStatus | string | Time 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) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0) |
List of all series time-points for a particular insight
\Ceic\Api\Models\InsightSeriesPaginatedResult
Name | Type | Description |
---|---|---|
$id | string | Insight ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$updatedAfter | \DateTime | Returns only the updated time-points after the date specified. (optional) |
$blankObservations | bool | If it's set to true, empty time-points will be returned (optional, default to false) |
$timePointsStatus | string | Time 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) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0) |
List of series based on their insight series ID
\Ceic\Api\Models\InsightSeriesResult
Name | Type | Description |
---|---|---|
$seriesId | string | Insight Series ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$updatedAfter | \DateTime | Returns only the updated time-points after the date specified. (optional) |
$blankObservations | bool | If it's set to true, empty time-points will be returned (optional, default to false) |
$timePointsStatus | string | Time 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) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
List of series time-points based on their insight series ID
\Ceic\Api\Models\InsightSeriesResult
Name | Type | Description |
---|---|---|
$seriesId | string | Insight Series ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$updatedAfter | \DateTime | Returns only the updated time-points after the date specified. (optional) |
$blankObservations | bool | If it's set to true, empty time-points will be returned (optional, default to false) |
$timePointsStatus | string | Time 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) |
List of series metadata based on their insight series ID
\Ceic\Api\Models\InsightSeriesResult
Name | Type | Description |
---|---|---|
$seriesId | string | Insight Series ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
List of all series metadata for a particular insight
\Ceic\Api\Models\InsightSeriesPaginatedResult
Name | Type | Description |
---|---|---|
$id | string | Insight ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0) |
List of User Created Insights
\Ceic\Api\Models\InsightsResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Insight categories
\Ceic\Api\Models\InsightsCategoriesResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Insights search
\Ceic\Api\Models\InsightsSearchResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$group | string | Insights group. Default is `my`. (optional, default to my) |
$limit | float | Number of records to return (optional, default to 30) |
$offset | float | The 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) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$order | string | Sort order (optional, default to edit_date) |
$direction | string | Sort order direction (optional, default to asc) |
$tags | string[] | List of insight tags to search by tag (optional) |
$categories | string[] | List of insights categories to search by category (optional) |
\Ceic\Api\Models\InsightDownloadResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\InsightsCategoriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\InsightsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\InsightSeriesPaginatedResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\InsightSeriesPaginatedResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\InsightSeriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\InsightSeriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\InsightSeriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\InsightSeriesPaginatedResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\InsightsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\InsightsCategoriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\InsightsSearchResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity | Query entity object which contains the search information (required) |
Get API client
\Ceic\Api\ApiClient
Set the API client
InternalApi
Name | Type | Description |
---|---|---|
$apiClient | \Ceic\Api\ApiClient | set the API client |
Returns list of internal remarks
\Ceic\Api\Models\SeriesInternalRemarksResult
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
\Ceic\Api\Models\SeriesInternalRemarksResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\InternalApiQueryEntity | Query entity object which contains the search information (required) |
Get API client
\Ceic\Api\ApiClient
Set the API client
LayoutApi
Name | Type | Description |
---|---|---|
$apiClient | \Ceic\Api\ApiClient | set the API client |
List of databases
\Ceic\Api\Models\LayoutItemsResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T, C, B, D]) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
Returns footnote of a node
string
Name | Type | Description |
---|---|---|
$nodeCode | string | Node Code - Database ID, Topic ID, Section ID or Table ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
Returns footnote metadata for a node
\Ceic\Api\Models\LayoutFootnoteMetadataResult
Name | Type | Description |
---|---|---|
$nodeCode | string | Node Code - Database ID, Topic ID, Section ID or Table ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Returns footnote resource file
string
Name | Type | Description |
---|---|---|
$nodeCode | string | Node Code - Database ID, Topic ID, Section ID or Table ID (required) |
$fileName | string | Resource file name (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
Metadata including list of ancestors for node of particular type (section) and code.
\Ceic\Api\Models\LayoutFullMetadataResult
Name | Type | Description |
---|---|---|
$id | string | Node ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
List of Sections
\Ceic\Api\Models\LayoutItemsResult
Name | Type | Description |
---|---|---|
$id | string | Topic ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T, C, B, D]) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
List of Series
\Ceic\Api\Models\SeriesResult
Name | Type | Description |
---|---|---|
$id | string | Table ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T, C, B, D]) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
List of Tables
\Ceic\Api\Models\LayoutItemsResult
Name | Type | Description |
---|---|---|
$id | string | Section ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T, C, B, D]) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
List of Topics
\Ceic\Api\Models\LayoutItemsResult
Name | Type | Description |
---|---|---|
$id | string | Database ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T, C, B, D]) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
\Ceic\Api\Models\LayoutItemsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity | Query entity object which contains the search information (required) |
string
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\LayoutFootnoteMetadataResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity | Query entity object which contains the search information (required) |
string
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\LayoutFullMetadataResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\LayoutFullMetadataResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\SeriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\LayoutItemsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\LayoutItemsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity | Query entity object which contains the search information (required) |
Get API client
\Ceic\Api\ApiClient
Set the API client
ReleasesApi
Name | Type | Description |
---|---|---|
$apiClient | \Ceic\Api\ApiClient | set the API client |
List release code series.
\Ceic\Api\Models\ReleaseSeriesResult
Name | Type | Description |
---|---|---|
$code | string | Release identifier code for a group of series with the same release schedule. Accepts only one release identifier code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0) |
List of releases for a single series id
\Ceic\Api\Models\SeriesReleaseScheduleSearchResult
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$releaseDateFrom | \DateTime | Will return releases with first observation before `release_date_from` (optional) |
$releaseDateTo | \DateTime | Will return releases with last observation after `release_date_to` (optional) |
$releaseStatus | string[] | List of release statuses to return (optional, default to Released) |
$offset | float | The 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) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float |
Released schedule search
\Ceic\Api\Models\SeriesReleaseScheduleSearchResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0) |
$layout | string[] | **DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional) |
$database | string[] | Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T]) |
$dataSource | string[] | Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional, default to CEIC) |
$series | string[] | List of series (optional) |
$topic | string[] | Topic filter. One or more comma separated topic code values. (optional) |
$section | string[] | Section filter. One or more comma separated section code values. (optional) |
$table | string[] | Table filter. One or more comma separated table code values. (optional) |
$order | string[] | Sort order. Default is `relevance`. (optional) |
$direction | string[] | Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
$facet | string[] | List of facets to return (optional) |
$releaseDateFrom | \DateTime | Will return releases with first observation before `release_date_from` (optional) |
$releaseDateTo | \DateTime | Will return releases with last observation after `release_date_to` (optional) |
$releaseStatus | string[] | List of release statuses to return (optional, default to Released) |
$offset | float |
\Ceic\Api\Models\ReleaseSeriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\SeriesReleaseScheduleSearchResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\SeriesReleaseScheduleSearchResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity | Query entity object which contains the search information (required) |
Get API client
\Ceic\Api\ApiClient
Set the API client
SeriesApi
Name | Type | Description |
---|---|---|
$apiClient | \Ceic\Api\ApiClient | set the API client |
Returns continuous series information
\Ceic\Api\Models\ContinuousSeriesResult
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Returns continuous series timepoints information
\Ceic\Api\Models\ContinuousSeriesWithAppliedFunctionsResult
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$chainId | string | The ID of the chain. Accepts only one ID. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Returns full series data
\Ceic\Api\Models\SeriesResult
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$updatedAfter | \DateTime | Returns only the updated time-points after the date specified. (optional) |
$blankObservations | bool | If it's set to true, empty time-points will be returned (optional, default to false) |
$timePointsStatus | string | Time 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) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
$withHistoricalExtension | bool | When set to true, series will include extended historical timepoints (optional, default to false) |
Returns list of metadata items
\Ceic\Api\Models\SeriesResult
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
Returns list of items' statistics
\Ceic\Api\Models\SeriesStatisticsResult
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Returns series time-points
\Ceic\Api\Models\SeriesResult
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$updatedAfter | \DateTime | Returns only the updated time-points after the date specified. (optional) |
$blankObservations | bool | If it's set to true, empty time-points will be returned (optional, default to false) |
$timePointsStatus | string | Time 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) |
$withHistoricalExtension | bool | When set to true, series will include extended historical timepoints (optional, default to false) |
Returns visual image
string
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$accept | string | Response data format. Default is `image/png`. (optional, default to image/png) |
$format | string | Response data format. Default is `png` (optional, default to png) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$token | string | Access API key. (optional) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
$width | float | Image width (optional) |
$height | float | Image height (optional) |
$period | float | Series time-pints mask. Example: 10y, 20m, 12d, 4w (optional) |
$type | string | Visual type (optional, default to chart) |
Series search
\Ceic\Api\Models\SearchSeriesResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0) |
$layout | string[] | **DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional) |
$database | string[] | Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T]) |
$dataSource | string[] | Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional, default to CEIC) |
$series | string[] | List of series (optional) |
$topic | string[] | Topic filter. One or more comma separated topic code values. (optional) |
$section | string[] | Section filter. One or more comma separated section code values. (optional) |
$table | string[] | Table filter. One or more comma separated table code values. (optional) |
$order | string[] | Sort order. Default is `relevance`. (optional) |
$direction | string[] | Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
$facet | string[] | List of facets to return (optional) |
\Ceic\Api\Models\ContinuousSeriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\ContinuousSeriesWithAppliedFunctionsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\SeriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\SeriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\SeriesStatisticsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\SeriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity | Query entity object which contains the search information (required) |
string
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\SearchSeriesResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity | Query entity object which contains the search information (required) |
Get API client
\Ceic\Api\ApiClient
Set the API client
SessionsApi
Name | Type | Description |
---|---|---|
$apiClient | \Ceic\Api\ApiClient | set the API client |
Generate impersonate token
\Ceic\Api\Models\ImpersonateAPIKeyResult
Name | Type | Description |
---|---|---|
$employeeToken | string | Impersonate API token generated on CAS service (required) |
$userId | string | User Id (required) |
$application | string | Application ID (required) |
$expireAfter | float | Token will be expired after `expire_after` in seconds (optional, default to 86400) |
Get user subscriptions
\Ceic\Api\Models\UserSubscriptionsResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Authenticates the user, creating a new session.
\Ceic\Api\Models\UserSessionResult
Name | Type | Description |
---|---|---|
$login | string | Username (required) |
$password | string | Password (required) |
$application | string | Application ID (required) |
$applicationVersion | string | Application Version (optional) |
Close existing API session.
\Ceic\Api\Models\SessionStatusResult
Name | Type | Description |
---|---|---|
$session | string | User session (required) |
Check if user's login/password are valid
\Ceic\Api\Models\UserCredentialsValidationResult
Name | Type | Description |
---|---|---|
$login | string | Username (required) |
$password | string | Password (required) |
\Ceic\Api\Models\ImpersonateAPIKeyResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\UserSubscriptionsResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\UserSessionResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity | Query entity object which contains the search information (required) |
Get API client
\Ceic\Api\ApiClient
Set the API client
DefaultApi
Name | Type | Description |
---|---|---|
$apiClient | \Ceic\Api\ApiClient | set the API client |
void
Name | Type | Description |
---|---|---|
$id | string | Classification ID. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
void
void
Name | Type | Description |
---|---|---|
$id | string | Country ISO code (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
void
void
void
void
void
void
void
void
void
void
Name | Type | Description |
---|---|---|
$id | string | Dump ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
void
void
Name | Type | Description |
---|---|---|
$id | string | Feed ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
void
void
Name | Type | Description |
---|---|---|
$id | string | Filter ID. Accepts one or more comma separated values. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
void
void
Name | Type | Description |
---|---|---|
$employeeToken | string | Impersonate API token generated on CAS service (required) |
$userId | string | User Id (required) |
$application | string | Application ID (required) |
$expireAfter | float | Token will be expired after `expire_after` in seconds (optional, default to 86400) |
void
void
void
void
void
Name | Type | Description |
---|---|---|
$id | string | Insight ID (required) |
$fileFormat | string | Insight report file format. Available formats: `xlsx`, `pdf` (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$ignoreCache | bool | New file will be generated (optional, default to false) |
$adjustColumns | string | No adjust or wrap text in XLSX cell (optional, default to no) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$blankObservations | string | If set to true, will return empty time-points which oterwise are omitted. (optional, default to filter) |
$orientation | string | Columns/rows orientation (optional, default to cols) |
$order | string | Sort order - Asc/Desc (optional, default to asc) |
$decimalPlaces | float | Decimal places for the time-points values (optional, default to 3) |
$dateFormat | string | Time-points date format (optional) |
void
Name | Type | Description |
---|---|---|
$id | string | Insight ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
void
Name | Type | Description |
---|---|---|
$id | string | Insight ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$updatedAfter | \DateTime | Returns only the updated time-points after the date specified. (optional) |
$blankObservations | bool | If it's set to true, empty time-points will be returned (optional, default to false) |
$timePointsStatus | string | Time 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) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0) |
void
Name | Type | Description |
---|---|---|
$id | string | Insight ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0) |
void
Name | Type | Description |
---|---|---|
$id | string | Insight ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$updatedAfter | \DateTime | Returns only the updated time-points after the date specified. (optional) |
$blankObservations | bool | If it's set to true, empty time-points will be returned (optional, default to false) |
$timePointsStatus | string | Time 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) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0) |
void
void
void
Name | Type | Description |
---|---|---|
$seriesId | string | Insight Series ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$updatedAfter | \DateTime | Returns only the updated time-points after the date specified. (optional) |
$blankObservations | bool | If it's set to true, empty time-points will be returned (optional, default to false) |
$timePointsStatus | string | Time 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) |
void
Name | Type | Description |
---|---|---|
$seriesId | string | Insight Series ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
void
Name | Type | Description |
---|---|---|
$seriesId | string | Insight Series ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$updatedAfter | \DateTime | Returns only the updated time-points after the date specified. (optional) |
$blankObservations | bool | If it's set to true, empty time-points will be returned (optional, default to false) |
$timePointsStatus | string | Time 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) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
void
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
void
Name | Type | Description |
---|---|---|
$id | string | Database ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T, C, B, D]) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
void
void
Name | Type | Description |
---|---|---|
$nodeCode | string | Node Code - Database ID, Topic ID, Section ID or Table ID (required) |
$fileName | string | Resource file name (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
void
Name | Type | Description |
---|---|---|
$nodeCode | string | Node Code - Database ID, Topic ID, Section ID or Table ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
void
Name | Type | Description |
---|---|---|
$nodeCode | string | Node Code - Database ID, Topic ID, Section ID or Table ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
void
Name | Type | Description |
---|---|---|
$id | string | Node ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T, C, B, D]) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
void
Name | Type | Description |
---|---|---|
$id | string | Section ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T, C, B, D]) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
void
Name | Type | Description |
---|---|---|
$id | string | Node ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T, C, B, D]) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
void
Name | Type | Description |
---|---|---|
$id | string | Table ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T, C, B, D]) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
void
Name | Type | Description |
---|---|---|
$id | string | Node ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T, C, B, D]) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
void
Name | Type | Description |
---|---|---|
$id | string | Topic ID (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T, C, B, D]) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
void
void
Name | Type | Description |
---|---|---|
$session | string | User session (required) |
void
Name | Type | Description |
---|---|---|
$code | string | Release identifier code for a group of series with the same release schedule. Accepts only one release identifier code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0) |
void
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float | The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0) |
$layout | string[] | **DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional) |
$database | string[] | Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WESG - *Environmental, Social and Governance* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *S&P Global Purchasing Managers' Index* DAILY - *High Frequency Database* ALT - *Alternative Data* FMS - *Financial and Monetary Statistics* HL - *Health* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* (optional) |
$keyword | string | Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional) |
$frequency | string[] | Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional) |
$country | string[] | **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional) |
$source | string[] | Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional) |
$unit | string[] | Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional) |
$indicator | string[] | Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. The use the new indicators ids is recommended because the old ones are deprecated and going to be removed in the near future! (optional) |
$region | string[] | Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional) |
$subscribedOnly | bool | Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false) |
$keyOnly | bool | Show only 'key' series when set to `true`. (optional, default to false) |
$newOnly | bool | Show only series created less than 1 month ago when set to `true`. (optional, default to false) |
$nameOnly | bool | This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false) |
$startDateBefore | \DateTime | Will return series with first observation before `start_date_before` (optional) |
$endDateAfter | \DateTime | Will return series with last observation after `end_date_after` (optional) |
$createdAfter | \DateTime | Will return entries created after `created_after` date (optional) |
$updatedAfter | \DateTime | Will return series last time updated after `updated_after` date (optional) |
$geo | string[] | Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional) |
$status | string[] | Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased D - On-Demand (optional, default to [T]) |
$dataSource | string[] | Data source for series search operation. When CEIC is selected, we search for CEIC series only. When USER-IMPORTED is selected, we search only for user imported series (optional, default to CEIC) |
$series | string[] | List of series (optional) |
$topic | string[] | Topic filter. One or more comma separated topic code values. (optional) |
$section | string[] | Section filter. One or more comma separated section code values. (optional) |
$table | string[] | Table filter. One or more comma separated table code values. (optional) |
$order | string[] | Sort order. Default is `relevance`. (optional) |
$direction | string[] | Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional) |
$filterId | string[] | Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
$facet | string[] | List of facets to return (optional) |
$releaseDateFrom | \DateTime | Will return releases with first observation before `release_date_from` (optional) |
$releaseDateTo | \DateTime | Will return releases with last observation after `release_date_to` (optional) |
$releaseStatus | string[] | List of release statuses to return (optional, default to Released) |
$offset | float |
void
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$releaseDateFrom | \DateTime | Will return releases with first observation before `release_date_from` (optional) |
$releaseDateTo | \DateTime | Will return releases with last observation after `release_date_to` (optional) |
$releaseStatus | string[] | List of release statuses to return (optional, default to Released) |
$offset | float | The 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) |
$limit | float | Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100) |
$offset | float |
void
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$updatedAfter | \DateTime | Returns only the updated time-points after the date specified. (optional) |
$blankObservations | bool | If it's set to true, empty time-points will be returned (optional, default to false) |
$timePointsStatus | string | Time 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) |
void
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
void
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$count | int | Limit the amount of latest time-points returned, by the number specified. (optional, default to 3650) |
$startDate | \DateTime | Limits the start date after which the time-points will be returned. (optional) |
$endDate | \DateTime | Limits the end date before which the time-points will be returned. (optional) |
$updatedAfter | \DateTime | Returns only the updated time-points after the date specified. (optional) |
$blankObservations | bool | If it's set to true, empty time-points will be returned (optional, default to false) |
$timePointsStatus | string | Time 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) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
void
Name | Type | Description |
---|---|---|
$id | string | Series ID or Series Code to return. Accepts only one series ID or series Code. (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$withReplacementsMetadata | bool | If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false) |
$forecastOnly | bool | If it is `true` result will only contain series with forecast (optional, default to false) |
$withReleaseOnly | bool | If it is `true` result will only contain series with released schedule (optional, default to false) |
$withReplacementsOnly | bool | If it is `true` result will only contain series with suggestions (optional, default to false) |
$withObservationsOnly | bool | If it is `true` result will not contain series without observations (optional, default to false) |
$withContinuousOnly | bool | If set to `true` results will contain only series with available historical extensions (optional, default to false) |
void
void
void
void
void
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
void
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\DefaultApiQueryEntity | Query entity object which contains the search information (required) |
Get API client
\Ceic\Api\ApiClient
Set the API client
WatchlistApi
Name | Type | Description |
---|---|---|
$apiClient | \Ceic\Api\ApiClient | set the API client |
Create Watchlist
\Ceic\Api\Models\WatchlistProcessedResult
Name | Type | Description |
---|---|---|
$seriesId | string | Watchlist Series IDs, comma separated (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$popupNotifications | bool | If set to true enables popup notifications for watchlist subscription (optional) |
$emailNotifications | string | If set, specifies the email notification frequency (optional) |
Delete watchlist
\Ceic\Api\Models\WatchlistProcessedResult
Name | Type | Description |
---|---|---|
$id | string | Watchlist Series IDs, comma separated (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Lists all watchlist subscriptions
\Ceic\Api\Models\WatchlistGetResult
Name | Type | Description |
---|---|---|
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
Update watchlist
\Ceic\Api\Models\WatchlistProcessedResult
Name | Type | Description |
---|---|---|
$id | string | Watchlist Series IDs, comma separated (required) |
$acceptLanguage | string | Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$accept | string | Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$lang | string | Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en) |
$format | string | Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json) |
$token | string | Access API key. (optional) |
$withModelInformation | bool | If set to `true` returns the model names as part of the response. (optional, default to false) |
$popupNotifications | bool | If set to true enables popup notifications for watchlist subscription (optional) |
$emailNotifications | string | If set, specifies the email notification frequency (optional) |
\Ceic\Api\Models\WatchlistProcessedResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\WatchlistProcessedResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\WatchlistGetResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntity | Query entity object which contains the search information (required) |
\Ceic\Api\Models\WatchlistProcessedResult
Name | Type | Description |
---|---|---|
$queryEntity | \Ceic\Api\Models\QueryEntities\WatchlistApiQueryEntity | Query entity object which contains the search information (required) |