Appearance
数据获取
数据获取流程
- 使用 post 方式以及帐号密码获取用户凭证(token),指定传入的 data 参数为 json
- 使用上述流程得到返回值并获取 token,在请求数据中加入 token,同样使用 post 方式获取数据
接口说明
获取 token 的接口: https://rqdata.ricequant.com/auth 获取数据的接口: https://rqdata.ricequant.com/api
使用方法
1、获取用户凭证(token)
获取数据之前,必须先获取 token, 即用户凭证,以作为用户获取数据的认证。该认证当天有效。token 过期或者更改用户权限后可重新获取。重新获取 token 后,旧的 token 随即失效。获取 token 所需要的参数示例如下
{
"user_name" : "your_username"
"password" : "your_password"
}
2、请求数据
获取 token 后,请设置 http 请求的数据以及头文件,请求的数据包含 API 名称以及相关参数, 示例如下
{
"method": "instruments"
"order_book_ids": ['10001941', '10001943']
}
HTTP 请求头文件必须包含 token,示例如下:
{
"token": "7dsf9ad6sDAsd889da"
}
特殊请求注意事项
如果 API 定义的参数本身包含 method,比如某个 API 定义如下
some_api(order_book_ids, method='some_method')
那么请求需改变为
{
"m": "some_api",
"order_book_ids": ['000001.XSHE', '000002.XSHE'],
"method": "another_method"
}
即将原本的 method 修改为 m,避免关键字冲突。
返回值
csv 格式文本数据,示例
order_book_id,date,high,close,strike_price,prev_settlement,open,total_turnover,low,contract_multiplier,open_interest,volume
10001941,2019-08-29,0.152,0.13670000000000002,2.8,0.1526,0.1499,3791153.0,0.12940000000000002,10000.0,510.0,2780.0
10001941,2019-08-30,0.16920000000000002,0.1428,2.8,0.13670000000000002,0.1516,4527774.0,0.1353,10000.0,961.0,3067.0
10001941,2019-09-02,0.1673,0.1584,2.8,0.1439,0.14300000000000002,3754096.0,0.14300000000000002,10000.0,1216.0,2351.0
相关参数说明
参数 | 含义 | 示例 |
---|---|---|
url | api 地址 | https://rqdata.ricequant.com/<指令>, 其中<指令>需要替换成/auth 或者 /api |
user_name | 用户名 | ricequant 注册帐号,获取 token 需要 |
password | 密码 | 以上用户名登录密码,获取 token 需要 |
headers | 头文件 | 用于获取数据请求时存放 token,例如 {“token": "7dsf9ad6sDAsd889da"} |
data | 请求时的主要数据 | 字典格式,必须包含 {"method": "<\*api name>"} ,具体内容依据使用的 api 而定,如 {"method": "instruments", "order_book_ids": ["10001941", "10001943"]} |