GET /series/search

数列搜索。

允许按关键字和其他筛选条件搜索数列。每个筛选条件接受一个或多个用逗号分隔的代码值。有关如何检索特定筛选器代码的详细信息,请参阅“字典”函数。多维筛选器包括经济分类和指标(由CEIC数据库结构定义)、地区/国家、频率、单位、来源、状态和观测日期。

Header参数

名称 描述 类型 需要 默认
Accept-Language 返回数据中使用的首选语言代码。如果指定语言的翻译本不可用,则默认为英语可通过查询参数query或使用Accept-Language头来应用。
en —— 英语
zh —— 中文
ru —— 俄语
id —— 印尼语
jp —— 日语
Accepted Values: [ en,zh,ru,id,jp]
String en
Accept 响应数据格式。默认设置为application/json。可通过查询参数格式或使用Accept头来应用。
Accepted Values: [ application/json,application/xml,text/csv]
String json

查询参数

名称 描述 类型 需要 默认
lang 返回数据中将使用的首选语言代码。如果指定语言的翻译本不可用,则默认为英语可通过查询参数query或使用Accept-Language头来应用。
en—— 英语
zh—— 中文
ru—— 俄语
id—— 印尼语
jp—— 日语
Accepted Values: [ en,zh,ru,id,jp]
String en
format 响应数据格式。默认为json。可通过查询参数format 或使用Accept头来使用。
Accepted Values: [ json,xml,csv]
String json
token 访问API密钥。可通过查询参数token或使用Authorization头来使用 String
with_model_information 如果设置为True,则返回作为响应部分的模型名称 Boolean false
limit 要返回的记录数,范围为1-100。默认为100。 Number 100
offset 从中返回记录的偏移量。用于在达到极限时获取下一个记录集。 Number 0
database 数据库筛选器。一个或多个用逗号分隔的数据库代码值。使用/dictionary/databases获取可用数据库的最新列表。
Accepted Values: [ WORLD,WGEM,WAEM,WFOR,WCOM,WCOC,WAGR,WASS,WIT10,GLOBAL,AA,ECA,MEA,NSA,CEICGLBKS,PMI,DAILY,BRAZIL,RUSSIA,INDIA,INDONESIA,CN,OXFORD,OECD-MEI,OECD-EO,OECD-PROD,OECD-NA]
Array
keyword 搜索词。一个或多个关键字。可能包含进一步控制搜索结果的特殊词。
关键字搜索提示:
零售销售额——显示数列与两个关键字,而关键字的顺序是不相关的。 相当于搜索销售零售额
零售AND销售——显示结果:数列与零售和销售词,不考虑顺序。例如,零售销售额,汽车销售零售额
零售;销售额——显示包含任何关键字的数列和包含两个关键字的数列,而关键字的序列是无关的,相当于搜索:销售额;零售
零售OR销售额——显示结果:数列,包含零售或销售额词,不考虑顺序。例如,零售销售额、零售贸易、销售价格、机动车销量
零售NOT销售额——通过排除特定词来缩小搜索范围,而关键字的顺序是相关的。 显示结果:包含零售词但不包含销售词的数列。例如,零售贸易、零售价格、零售银行
零售销售NOT(香港)——通过排除括号内的一组词来缩小搜索范围,而括号内关键字的顺序是不相关的,相当于搜索: 零售销售(排除香港)。显示结果:包含零售销售额但不包括香港地区的数列,如零售额同比增长率:中国,零售销售额同比增长率: 美国
String
frequency 频率筛选器。一个或多个用逗号分隔的频率代码值。
D——每日
W——每周
M——每月
Q——每季度
S——半年
Y——年度
Accepted Values: [ D,W,M,Q,H,Y,Z,T]
Array
source 来源筛选器。一个或多个用逗号分隔的来源代码值。如需获取已接受来源的完整列表,请参阅相关的字典函数。 Array
unit 单位筛选器。一个或多个用逗号分隔的单位代码值。如需获取已接受单位的完整列表,请参阅相关的字典函数。 Array
indicator 指标筛选器。一个或多个用逗号分隔的指标代码值。如需获取已接受指标的完整列表,请参阅相关的字典函数。 Array
region 地区筛选器。一个或多个用逗号分隔的地区代码值。如需获取已接受地区的完整列表,请参阅相关的字典函数。 Array
subscribed_only 设置为真时,仅显示已订阅数列的结果。默认情况下,显示找到的所有数列的结果。 Boolean false
key_only 设置为真时,仅显示‘关键’数列。 Boolean false
new_only 设置为真时,仅显示不到一个月前创建的数列。 Boolean false
name_only 此筛选器与关键字筛选器相关。如果为真,将仅在数列名称中搜索关键字,而不是在所有数列属性中搜索。 Boolean false
start_date_before 将在start_date_before之前返回包含第一个观测值的数列 String
end_date_after 将在end_date_after之后返回包含上一个观测值的数列 String
created_after 将返回created_after日期之后创建的数列 String
updated_after 将返回updated_after日期之后最后一次更新的数列 String
geo 地理位置筛选器。一个或多个逗号分隔的地理ID值。请参阅相关的字典函数以获取可用地理ID的完整列表。 Array
status 状态筛选器。一个或多个用逗号分隔的状态代码值。未显式设置时,默认为T。
T——激活
C——中止
B——变基
Accepted Values: [ T,C,B]
Array T
series 数列列表 Array
topic 主题筛选器。一个或多个用逗号分隔的主题代码值。 Array
section 板块筛选器。一个或多个用逗号分隔的板块代码值。 Array
table 表格筛选器。一个或多个用逗号分隔的表格代码值。 Array
order 排序顺序。默认为相关性。
Accepted Values: [ relevance,popular,updated,new,percentage_change,last_value,status,country,frequency,first_date,last_date,unit,source]
Array
direction 排序方向。默认为升序。
接受值:
asc——升序
desc——降序
Accepted Values: [ asc,desc]
Array
filter_id 用于定义将对其执行搜索的数据子集所使用的筛选器ID。当与其他搜索条件结合时,结果将是二者的交集。 Array
with_replacements_metadata 如果为真,结果将包含替换元数据,而不仅仅是ID列表 Boolean false
forecast_only 如果为真,结果将仅包含带有预测的数列 Boolean false
with_release_only 如果为真,结果将仅包含带有发布进度的数列 Boolean false
with_replacements_only 如果为真,结果将仅包含带有建议的数列 Boolean false
with_observations_only If it is true result will not contain series without observations Boolean false
facet 要返回分面的列表
Accepted Values: [ database,topic,section,table,region,country,geo,frequency,source,unit,status,indicator,additional]
Array

响应

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.

状态码 类型 类型
200 数列元数据已找到。 SearchSeriesResult
400 输入参数不正确 BadRequest
401 授权错误。 AuthorizationError
403 用户权限不正确。 PermissionsError
404 找不到请求的实体。 NotFound
415 不支持的数据格式。仅支持Only json、xml、csv。 UnsupportedMedia
429 Too many requests were send or limit exceeded. TooManyRequests
500 内部服务器错误。 InternalError
API查询生成器
查询
查询结果