POST /filters

  1. Documentation
  2. CEIC Macroeconomic Data API
  3. API Documentation
  4. Filters
  5. Create a filter

Create a filter

Creates a series filter. A filter may contain both, an exact list of series and search criterion. The resulted set is a union of both. Filters can be used with /series/search, /dumps and /feeds functions.

Header Parameters

Name Description Type Required Default
Accept Response data format. Default is application/json. Can be used through the query parameter format or using the header Accept.
Accepted Values: [ application/json,application/xml]
String json

Query Parameters

Name Description Type Required Default
format Response data format. Default is json. Can be used through the query parameter format or using the header Accept.
Accepted Values: [ json,xml]
String json
token Access API key. String
with_model_information If set to true returns the model names as part of the response. Boolean false
forecast_only If it is true result will only contain series with forecast Boolean false
with_release_only If it is true result will only contain series with released schedule Boolean false
with_replacements_only If it is true result will only contain series with suggestions Boolean false
with_observations_only If it is true result will not contain series without observations Boolean false
data_source 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
Accepted Values: [ CEIC,USER-IMPORTED]
Array CEIC

FormData Parameters

Name Description Type Required Default
series List of series, comma separated. Its length cannot be more than 100000. Array
name Name of the new record. Max length 100 String
description Description of the new record. Max length 1000 String
keyword 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 		String
frequency 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
Accepted Values: [ D,W,M,Q,H,Y,Z,T]
Array
source Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. Array
unit Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. Array
indicator 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! Array
region Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. Array
subscribed_only Show only results for subscribed series when set to true. By default show results for all the series found. Boolean false
key_only Show only 'key' series when set to true. Boolean false
new_only Show only series created less than 1 month ago when set to true. Boolean false
name_only 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. Boolean false
start_date_before Will return series with first observation before start_date_before String
end_date_after Will return series with last observation after end_date_after String
created_after Will return entries created after created_after date String
updated_after Will return series last time updated after updated_after date String
geo Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. Array
topic Topic filter. One or more comma separated topic code values. Array
section Section filter. One or more comma separated section code values. Array
table Table filter. One or more comma separated table code values. Array
status 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
Accepted Values: [ T,C,B,D]
Array T
order Sort order. Default is relevance.
Accepted Values: [ relevance,popular,updated,new,percentage_change,last_value,status,country,frequency,first_date,last_date,unit,source]
Array
database
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*
Accepted Values: [ WORLD,WGEM,WESG,WAEM,WFOR,WCOM,WCOC,WAGR,WASS,WIT10,GLOBAL,AA,ECA,MEA,NSA,CEICGLBKS,PMI,DAILY,ALT,FMS,HL,BRAZIL,RUSSIA,INDIA,INDONESIA,CN]
Array
direction Sort order direction. Default is asc.
Accepted values:
asc - ascending
desc - descending
Accepted Values: [ asc,desc]
Array

Responses

All API calls have response size limit of 10MB! If you are planning to request a bulky item collection, please consider using the corresponding API request parameters to limit your response.

Status Code Description Type
201 Filter created FilterResult
400 Incorrect input parameters. BadRequest
401 Authorization error. AuthorizationError
403 Incorrect user permissions. PermissionsError
404 Requested entity not found. NotFound
415 Unsupported data format. Only json, xml are supported. UnsupportedMedia
429 Too many requests were send or limit exceeded. TooManyRequests
500 Internal Server Error. InternalError
API Query Builder
Query
Query Result