Ricequant Docs

# RiceQuant http 服务帮助文档

# 简介

RiceQuant http 是基于rqdata api的开放式网络接口，支持多种不同的计算机语言。为量化工程师提供了更多元的选择，以方便使用 rqdata 的 api。

# 数据获取流程

  1. 使用 post 方式以及帐号密码获取用户凭证(token)，指定传入的 data 参数为 json
  2. 使用上述流程得到返回值并获取 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']}

# 请求示例

# Python

# coding=utf-8
import requests
# Get token
# <your_username> 以及 <your_password> 换成您的认证信息
auth_url = 'https://rqdata.ricequant.com/auth'
auth_json = {'user_name': '<your_username>', 'password': '<your_password>'}
token = requests.post(auth_url, json=auth_json).text
# Get data
data_url = 'https://rqdata.ricequant.com/api'
data_json = {'method': 'get_price', 'order_book_ids': ['10001941', '10001943'], 'start_date': '20190601', 'end_date': '20191011'}
headers = {'token': token}
response = requests.post(data_url, json=data_json, headers=headers)
print('resp: ', response.text)

# R

注：R 中可以通过 reticulate 包直接调用 python 版本的 RQDATAC。

library(httr)
# Get token
# <your_username> 以及 <your_password> 换成您的认证信息
auth_url <- 'https://rqdata.ricequant.com/auth'
auth_json <- list(
        user_name = "your_username",
        password = "your_password"
    )
res <- POST(auth_url, body = auth_json, encode = "json")
tk <- content(res)
# Get data
data_url <- 'https://rqdata.ricequant.com/api'
data_json <- list(
        method = 'get_price',
        order_book_ids = list('000001.XSHE', '00005.XSHE'),
        start_date = '20190601',
        end_date = '20191011'
    )
res <- POST(data_url, body = data_json, add_headers(token=tk), encode="json")

# MATLAB

我们提供 MATLAB 客户端产品(toolbox)，提供十分简洁易用的 API，调用方式类似于 python-rqdatac，请联系我们的销售或者致电公司官方电话获取。

# PHP

<?php
function doPost($url, $post_data, $token){
    $headers =[
     'token:' . $token,
    ];
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $url);
    curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($curl, CURLOPT_POST, 1);
    $data_string = json_encode($post_data);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $data_string);
    $data = curl_exec($curl);
    curl_close($curl);
    $body = explode("\r\n\r\n", $data, 0);
    return $body;
}
// <your_username> 以及 <your_password> 换成您的认证信息
// Get token
$auth_url = "https://rqdata.ricequant.com/auth";
$auth_json = array(
    "user_name" => "your_username",
    "password" => "your_password",
);
$token = doPost($auth_url, $auth_json,  0);
// Get api data
$api_url = "https://rqdata.ricequant.com/api";
$api_json = array(
    "method" => "get_price",
    "order_book_ids" => array("000001.XSHE", "000005.XSHE"),
    "start_date" => "20190601",
    "end_date" => "20191011"
);
$data = doPost($api_url, $api_json, $token[0]);
print_r($data);
?>

# C++

使用cURL (opens new window)库执行请求

#include "iostream"
#include "string"
#include "sstream"
#include "curl/curl.h"
using namespace std;
size_t receive_data(void *ptr, size_t size, size_t nmemb, void *stream){
    string data((const char*) ptr, (size_t) size * nmemb);
    *((stringstream*) stream) << data;
    return size * nmemb;
}
const char *AUTH_URL = "https://rqdata.ricequant.com/auth";
const char *API_URL = "https://rqdata.ricequant.com/api";
string doPost(string json, string token) {
    CURL *newCurl = NULL;
    CURLcode response;
    newCurl = curl_easy_init();
    if ( newCurl != NULL ) {
        stringstream out;
        curl_slist *plist = curl_slist_append(NULL, "Content-Type:application/json");
        if(token != "") {
            plist = curl_slist_append(plist, ("token:" + token).c_str());
            curl_easy_setopt(newCurl, CURLOPT_URL, API_URL);
        } else {
            curl_easy_setopt(newCurl, CURLOPT_URL, AUTH_URL);
        }
        curl_easy_setopt(newCurl, CURLOPT_TIMEOUT, 3);
        curl_easy_setopt(newCurl, CURLOPT_HTTPHEADER, plist);
        curl_easy_setopt(newCurl, CURLOPT_POSTFIELDS, json.c_str());
        curl_easy_setopt(newCurl, CURLOPT_WRITEFUNCTION, receive_data);
        curl_easy_setopt(newCurl, CURLOPT_WRITEDATA, &out);
        response = curl_easy_perform(newCurl);
        curl_easy_cleanup(newCurl);
        newCurl = NULL;
        curl_slist_free_all(plist);
        plist = NULL;
        return out.str();
    }
}
int main() {
    // <your_username> 以及 <your_password> 换成您的认证信息
    // Get token
    const string authJson = "{\"user_name\": \"your_username\",\"password\": \"your_password\"}";
    const string token = doPost(authJson, "");
    // Get api data
    const string dataJson =
        "{"
            "\"method\": \"get_price\", "
            "\"order_book_ids\": [\"000001.XSHE\", \"000005.XSHE\"], "
            "\"start_date\": \"20220702\", "
            "\"end_date\": \"20220722\""
        "}";
    string data = doPost(dataJson, token);
    cout << data << endl;
    return 0;
}

# C#

using System;
using System.Net;
using System.IO;
using System.Text;
namespace HttpTest
{
    class HttpTest
    {
        public static string DoPost(string url, string content, string token)
        {
            string result = "";
            HttpWebRequest req = (HttpWebRequest)WebRequest.Create(url);
            req.Method = "POST";
            req.ContentType = "application/json";
            if (token != null){
                req.Headers["token"] = token;
            }
            // Add post parm
            byte[] data = Encoding.UTF8.GetBytes(content);
            req.ContentLength = data.Length;
            using (Stream reqStream = req.GetRequestStream())
            {
                reqStream.Write(data, 0, data.Length);
                reqStream.Close();
            }
            // Get response
            HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
            Stream stream = resp.GetResponseStream();
            using (StreamReader reader = new StreamReader(stream, Encoding.UTF8))
            {
                result = reader.ReadToEnd();
            }
            return result;
        }
        public static void Main(string[] args)
        {
            // <your_username> 以及 <your_password> 换成您的认证信息
            // Get token
            string authUrl = "https://rqdata.ricequant.com/auth";
            string authJson = "{\"user_name\": \"your_username\", \"password\": \"your_password\"}";
            string token = DoPost(authUrl, authJson, null);
            Console.WriteLine(token);
            // Get api data
            string apiUrl = "https://rqdata.ricequant.com/api";
            string apiJson = "{" +
                "\"method\": \"get_price\", " +
                "\"order_book_ids\": [\"000001.XSHE\", \"000005.XSHE\"], " +
                "\"start_date\": \"20220702\", " +
                "\"end_date\": \"20220722\"" +
                "}";
            string data = DoPost(apiUrl, apiJson, token);
            Console.WriteLine(data);
        }
    }
}

# Java

仅使用内置包。

import javax.net.ssl.HttpsURLConnection;
import java.io.*;
import java.net.*;
import java.nio.charset.StandardCharsets;
public class HttpTest {
    public static String doPost(URL url, String json, String token) {
        try {
            HttpsURLConnection con = (HttpsURLConnection) url.openConnection();
            con.setDoOutput(true);
            con.setRequestMethod("POST");
            con.setRequestProperty("Content-Type", "application/json");
            if (token != null) {
                con.setRequestProperty("token", token);
            }
            OutputStream os = con.getOutputStream();
            byte[] input = json.getBytes(StandardCharsets.UTF_8);
            os.write(input, 0, input.length);
            BufferedReader br = new BufferedReader(
                    new InputStreamReader(con.getInputStream(), StandardCharsets.UTF_8));
            StringBuilder response = new StringBuilder();
            String responseLine;
            while ((responseLine = br.readLine()) != null) {
                response.append(responseLine.trim());
            }
            return response.toString();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
    public static void main(String[] args) throws Exception {
        // <your_username> 以及 <your_password> 换成您的认证信息
        // Get token
        URL authUrl = new URL("https://rqdata.ricequant.com/auth");
        String authJson = "{\"user_name\": \"your_username\", \"password\": \"your_password\"}";
        String token = doPost(authUrl, authJson, null);
        // Get api data
        URL apiUrl = new URL("https://rqdata.ricequant.com/api");
        String apiJson = "{" +
                "\"method\": \"get_price\", " +
                "\"order_book_ids\": [\"000001.XSHE\", \"000005.XSHE\"], " +
                "\"start_date\": \"20220702\", " +
                "\"end_date\": \"20220722\"" +
                "}";
        String data = doPost(apiUrl, apiJson, token);
        System.out.println(data);
    }
}

# Go

package main
import (
    "fmt"
    "io/ioutil"
    "net/http"
    "strings"
)
func doPost(url, data, token string) string {
    request, _ := http.NewRequest("POST", url, strings.NewReader(data))
    if token != "" {
        request.Header.Add("token", token)
    }
    resp, err := http.DefaultClient.Do(request)
    if err != nil {
        fmt.Printf("post data error:%v\n", err)
        return "err"
    }
    respBody, _ := ioutil.ReadAll(resp.Body)
    return string(respBody)
}
func main() {
    // <your_username> 以及 <your_password> 换成您的认证信息
    // Get token
    authUrl := "https://rqdata.ricequant.com/auth"
    authJson := `{"user_name":"your_username","password":"your_password"}`
    token := doPost(authUrl, authJson, "")
    // Get api data
    apiUrl := "https://rqdata.ricequant.com/api"
    dataJson := `{"method": "get_price", "order_book_ids": ["000001.XSHE", "000005.XSHE"], "start_date": "20220702", "end_date": "20220722"}`
    postData := doPost(apiUrl, dataJson, token)
    fmt.Printf("data:%v", postData)
}

# 接口方法

# 简介

RQData HTTP 接口支持 python API 中的绝大部分，不支持的 API 列表如下：

  • get_fundamentals (可使用 get_factor 代替)
  • deprecated_fundamental_data

另外，get_financials 的调用方式与一般的 API 有所不同。

# 规则

HTTP 接口请求体为 json 格式，需要设置请求的 Content-Type 为 application/json，请求格式如下：

{
  "method": "api_name",
  "arg1_name": "arg1_value",
  "arg2_name": "arg2_value"
}

其中，method 为 API 名，如 "get_price", "futures.get_dominant"。arg1_name, arg2_name 为参数名，如 "order_book_ids",
"start_date", "end_date"等。与 python API 一样，请求中需要包含必需的参数。一个请求例子如下：

  • 数据主体
{
  "method": "get_price",
  "order_book_ids": ["000001.XSHE", "600000.XSHG"],
  "start_date": 20190601,
  "end_date": 20191001,
  "fields": ["open", "close", "high", "low"],
  "adjust_type": "none"
}
  • 头文件 header
{
  "token": "<token received from auth request>"
}

结果以 csv 格式返回：

order_book_id,date,open,close,high,low
000001.XSHE,2019-06-03,12.22,11.9,12.33,11.82
000001.XSHE,2019-06-04,11.89,11.85,11.94,11.6
000001.XSHE,2019-06-05,11.97,11.97,12.14,11.92
000001.XSHE,2019-06-06,11.97,11.92,12.07,11.89
000001.XSHE,2019-06-10,12.01,12.34,12.47,11.98
000001.XSHE,2019-06-11,12.34,12.65,12.72,12.3

在 HTTP 接口中，所有 expect_df 参数被忽略。

# API 说明

# all_instruments - 获取所有合约基础信息

获取某个国家市场的所有合约信息。使用者可以通过这一方法很快地对合约信息有一个快速了解，目前仅支持中国市场。

  • 参数
参数 说明 是否必需
type 需要查询合约类型，例如：type='CS'代表股票。默认是所有类型 否
market 默认是中国市场('cn') 否
date 指定日期，筛选指定日期可交易的合约 否
  • 返回字段示例

返回字段含义参考 (详细介绍)

,order_book_id,symbol,abbrev_symbol,type,listed_date,de_listed_date
0,RU1909P12250,天然橡胶1909沽12250,,Option,2019-01-28,2019-08-26
1,RU1910C10000,天然橡胶1910购10000,,Option,2019-02-01,2019-09-24
2,RU1909P14500,天然橡胶1909沽14500,,Option,2019-02-26,2019-08-26

# instruments - 获取合约详细信息

获取某个国家市场内一个或多个合约的详细信息。目前仅支持中国市场。

  • 参数
参数 说明 是否必需
order_book_ids 合约代码，可传入 order_book_id, order_book_id list。
中国市场的 order_book_id 通常类似'000001.XSHE'。需要注意，国内股票、ETF、指数合约代码分别应当以'.XSHG'或'.XSHE'结尾，前者代表上证，后者代表深证。
比如查询平安银行这个股票合约，则键入'000001.XSHE'，前面的数字部分为交易所内这个股票的合约代码，后半部分为对应的交易所代码。
期货则无此要求		 是
market 默认是中国市场('cn')，目前仅支持中国市场 否
  • 返回值示例

返回字段含义参考（详细介绍）

order_book_id,contract_multiplier,de_listed_date,exchange,exercise_type,listed_date,market_tplus,maturity_date,option_type,round_lot,strike_price,symbol,trading_hours,type,underlying_order_book_id,underlying_symbol
10001934,10000,2020-03-25,XSHG,E,2019-08-06,0,2020-03-25,P,1,2.65,510050P2003M02650,"09:31-11:30,13:01-15:00",Option,510050.XSHG,510050.XSHG
10001936,10000,2019-08-28,XSHG,E,2019-08-07,0,2019-08-28,P,1,2.6,510050P1908M02600,"09:31-11:30,13:01-15:00",Option,510050.XSHG,510050.XSHG

# id_convert - 交易所代码转换

将交易所和其他平台的股票代码转换成米筐的标准合约代码，目前仅支持 A 股、期货和期权代码转换。 例如, 支持转换类型包括 000001.SZ, 000001SZ, SZ000001 转换为 000001.XSHE

  • 参数
参数 说明 是否必需
order_book_ids 合约代码(来自交易所或其他平台) 是
  • 返回值示例

返回字段含义参考 （详细介绍）

order_book_id
000001.XSHG

# get_share_transformation - 获取股票转换股票代码信息

查询股票因代码变更或并购等情况更换了股票代码的信息

  • 参数
参数 说明 是否必需
predecessor 合约代码(来自交易所或其他平台), 空值返回所有变更过股票代码的股票 否
market 目前仅支持国内市场('cn')。 否
  • 返回值示例

返回字段含义参考 （详细介绍）

,predecessor,successor,effective_date,share_conversion_ratio,predecessor_delisted,discretionary_execution,predecessor_delisted_date,event
0,000022.XSHE,001872.XSHE,2018-12-26,1.0,True,False,2018-12-26,code_change
1,000024.XSHE,001979.XSHE,2015-12-30,1.6008,True,False,2015-12-30,merge

# get_price - 获取合约历史行情数据

获取指定合约或合约列表的历史数据（包含起止日期，日线或分钟线）。目前仅支持中国市场的股票、期货、ETF、常见指数和上金所现货的行情数据，如黄金、铂金和白银产品。

  • 参数
参数 说明 是否必需
order_book_ids 合约代码，可传入 order_book_id, order_book_id list。获取 tick 数据时，只支持单个 order_book_id 是
start_date 开始日期，默认为'2013-01-04'。交易使用时，用户必须指定 否
end_date 结束日期，默认为'2014-01-04'。交易使用时，默认为策略当前日期前一天 否
frequency 历史数据的频率。 现在支持日/分钟级别的历史数据，默认为'1d'。使用者可自由选取不同频率，例如'5m'代表 5 分钟线。可支持期货 tick 级别数据获取，此时频率为'tick' 否
fields 字段名称 否
adjust_type 权息修复方案。前复权 - pre，后复权 - post，不复权 - none 否
skip_suspended 是否跳过停牌数据。默认为 False，不跳过，用停牌前数据进行补齐。True 则为跳过停牌期。注意，当设置为 True 时，函数 order_book_id 只支持单个合约传入 否
market 默认是中国市场('cn') 否

  • 注意：合约列表中所有合约必需是同样类型，如全部为股票。

  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,date,strike_price,high,open_interest,open,low,contract_multiplier,prev_settlement,total_turnover,volume,close
10001941,2019-08-29,2.8,0.152,510.0,0.1499,0.12940000000000002,10000.0,0.1526,3791153.0,2780.0,0.13670000000000002

# get_ksh_auction_info - 获取科创版盘后数据

获取科创版盘后固定价格交易信息，可获取历史和实时

  • 参数
参数 说明 是否必需
order_book_ids 可输入 order_book_id, order_book_id list,获取 tick 数据时，只支持单个 是
start_date 开始日期。 是
end_date 结束日期。 是
frequency 数据的频率。 现在支持日/分钟/tick 级别的数据，默认为'1d'。只支持'1d','1m','tick',不支持'5d'等频率 否
market 默认是中国市场('cn') 否
  • 返回值示例

返回字段含义参考（详细介绍）

order_book_id,date,close,volume,total_turnover
688012.XSHG,2019-07-22,81.03,112858.0,9144883.74

# get_open_auction_info - 获取盘前集合竞价数据

获取给定合约的盘前集合竞价期间的 level1 快照行情。

  • 参数
参数 说明 是否必需
order_book_ids 可输入 order_book_id, order_book_id list 是
market 默认是中国市场('cn') 否
start_date 开始日期。如不指定日期，则默认为取当天 是
end_date 结束日期。如不指定日期，则默认为返回所填开始日期当天 是
  • 返回值示例

返回字段含义参考（详细介绍）

order_book_id,datetime,open,last,high,low,iopv,prev_iopv,limit_up,limit_down,prev_close,volume,total_turnover,a1,a2,a3,a4,a5,b1,b2,b3,b4,b5,a1_v,a2_v,a3_v,a4_v,a5_v,b1_v,b2_v,b3_v,b4_v,b5_v
000001.XSHE,2019-11-06 09:25:03,17.06,17.06,17.06,17.06,0.0,0.0,18.87,15.44,17.15,462400.0,7888544.0,17.06,17.07,17.08,17.09,17.1,17.05,17.04,17.03,17.02,17.01,939800.0,5000.0,141100.0,41900.0,133520.0,8600.0,3100.0,13900.0,38000.0,100500.0

# current_minute - 获取最近的分钟线数据

获取当日给定合约的 level1 最近合成的 1 分钟行情，无法获取历史。

  • 参数
参数 说明 是否必需
order_book_ids 可输入 order_book_id, order_book_id list 是
skip_suspended 是否跳过停牌，默认不跳过 否
fields 可挑选返回的字段。默认返回所有 否
  • 返回值示例

返回字段含义参考 （详细介绍）

order_book_id,datetime,close,high,low,open,total_turnover,volume
000012.XSHG,2019-11-01 15:00:00,175.8034,175.8034,175.7969,175.7969,2044082.0,221000
000001.XSHG,2019-11-01 15:00:00,2957.5395,2957.5395,2956.7726,2956.7726,920074336.6999817,75283600

# get_price_change_rate - 获取历史涨跌幅

获取股票或指数的历史涨跌幅（包含起止日期）。注意目前只支持股票与指数两类合约，基金、期货等目前并不支持。历史涨跌幅基于前复权价格。

  • 参数
参数 说明 是否必需
order_book_ids 可输入 order_book_id, order_book_id list 是
start_date 开始日期，默认为'2013-01-04' 否
end_date 结束日期，默认为'2014-01-04' 否
  • 返回值示例

返回字段含义参考（详细介绍）

date,000001.XSHG,000002.XSHG
2019-06-11,0.02580036493425153,0.02579592973510736
2019-06-12,-0.005583795174665118,-0.005586080442638863
2019-06-13,0.0004677973269626712,0.0004587717603601327

# current_snapshot - 获取当前行情快照

获取某一合约当前的 LEVEL1 行情快照，支持集合竞价数据获取。

  • 参数
参数 说明 是否必需
order_book_ids 合约代码，可传入 order_book_id, order_book_id list。 是
market 默认是中国市场('cn')，目前仅支持中国市场 否
  • 返回值示例

返回字段含义参考（详细介绍）

order_book_id,ask0,ask1,ask2,ask3,ask4,ask_vol0,ask_vol1,ask_vol2,ask_vol3,ask_vol4,bid0,bid1,bid2,bid3,bid4,bid_vol0,bid_vol1,bid_vol2,bid_vol3,bid_vol4,datetime,high,iopv,last,low,open,open_interest,prev_close,prev_iopv,prev_settlement,total_turnover,volume
000001.XSHG,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2019-11-01 15:00:18.140,2959.833,0,2958.1992,2917.1455,2924.3402,,2929.0561,0,,175630839104.9,15990737300
000002.XSHG,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2019-11-01 15:00:18.140,3101.0042,0,3099.2832,3056.2129,3063.7667,,3068.7172,0,,175545624347.0,15975995000

# get_trading_dates - 获取交易日列表

获取某个国家市场的交易日列表（起止日期加入判断）。目前仅支持中国市场。

  • 参数
参数 说明 是否必需
start_date 开始日期 是
end_date 结束日期 是
market 默认是中国市场('cn')，目前仅支持中国市场 否
  • 返回值示例

返回字段含义参考（详细介绍）

trading_date
2019-06-11
2019-06-12
2019-06-13

# get_previous_trading_date - 获取历史某个交易日

默认获取指定日期的上一交易日。

  • 参数
参数 说明 是否必需
date 指定日期 是
n n 代表往前第 n 个交易日。默认为 1，即前一个交易日 否
market 默认是中国市场('cn')，目前仅支持中国市场 否
  • 返回值示例

返回字段含义参考（详细介绍）

trading_date
2019-10-10

需要注意，这里的返回值只是一个代表日期的字符串，并不是 csv 格式

# get_next_trading_date - 获取未来某个交易日

默认获取指定日期的上一交易日。

  • 参数
参数 说明 是否必需
date 指定日期 是
n n 代表未来第 n 个交易日。默认为 1，即下一个交易日 否
market 目前只支持中国市场 ('cn') 否
  • 返回值示例

返回字段含义参考（详细介绍）

trading_date
2019-10-10

需要注意，这里的返回值是一个代表日期的字符串，并不是 csv 格式

# get_trading_hours - 获取合约连续竞价时间段

默认获取当前点国内市场合约字符串形式的连续竞价交易时间段。

  • 参数
参数 说明 是否必需
order_book_id 合约名称 是
date 指定日期。使用场景，部分合约的当前和历史的连续竞价交易时间段会有不同 否
expected_fmt 可选 str（返回 string）, 也支持 time（返回 datetime.time）或 datetime（返回 datetime.datetime） 否
frequency 频率,默认为 1m, 对应米筐分钟线时间段的起始, 为 tick 时返回交易所给出的交易时间 否
market 目前只支持中国市场 ('cn') 否
  1. date 可以设为 None， 返回的结果代表一般情况
  2. expent_fmt 参数无效，返回的结果固定为 csv 格式
  • 返回值示例

返回字段含义参考（详细介绍）

start_at,end_at
09:31-11:30,13:01-15:00

注意返回值一般为两个代表时间的字符串，并非 csv 格式

# get_yield_curve - 获取收益率曲线

获取某个国家市场在一段时间内收益率曲线水平（包含起止日期）。目前仅支持中国市场。
数据为 2002 年至今的中债国债收益率曲线，来源于中央国债登记结算有限责任公司。

  • 参数
参数 说明 是否必需
start_date 开始日期，默认为'2013-01-04' 否
end_date 结束日期，默认为'2014-01-04' 否
tenor 标准期限，'0S' - 隔夜，'1M' - 1 个月，'1Y' - 1 年 否
market 默认是中国市场('cn')，目前支持中国市场。 否
  • 返回值示例

返回字段含义参考（详细介绍）

trading_date,0S,1M,2M,3M,6M,9M,1Y,2Y,3Y,4Y,5Y,6Y,7Y,8Y,9Y,10Y,15Y,20Y,30Y,40Y,50Y
2019-06-11,0.017075,0.021664,0.0227,0.024162,0.024916999999999998,0.025613999999999998,0.026772,0.028125,0.029948000000000002,,0.031134,,0.033,,,0.032651,0.035704,0.03606,0.038855,0.039127999999999996,0.039283
2019-06-12,0.017075,0.021986,0.022938999999999998,0.024136,0.024746,0.025672999999999998,0.026848999999999998,0.029197999999999998,0.029765,,0.031132,,0.032925,,,0.032601,0.035654,0.03601000000000001,0.038805,0.039078,0.039233

# get_fundamentals

(详细介绍)

不支持该 api

# get_financials- 查询季度财务信息

以给定一个报告期回溯的方式获取季度基础财务数据（三大表）。financials 是在查询中会使用到的重要对象，功能与上述 fundamentals 类似。但因为 get_financials 为季度财务信息查询，所以 financials 中支持的财务表格包括利润表（income_statement），资产负债表（balance_sheet），现金流量表（cash_flow_statement），以及财务指标（financial_indicator）。除此之外，financials 中还包括了股票列表（stock_code）以及公布日期（announce_date）两个指标。

  • 参数
参数 说明 是否必需
query 需要返回的财务字段 是
order_book_id 合约名称 是
quarter 财报回溯查询的起始报告期，例如'2015q2', '2015q4'分别代表 2015 年半年报以及年报。默认只获取当前报告期财务信息 否
interval 查询财务数据的间隔。例如，填写'5y'，则代表从报告期开始回溯 5 年，每年为相同报告期数据；'3q'则代表从报告期开始向前回溯 3 个季度 否
  • 发送 data 示例
{
  "method": "get_financials",
  "query": ["net_profit", "announce_date"],
  "order_book_ids": ["000002.XSHE", "601988.XSHG"],
  "quarter": "2016q3",
  "interval": "2q"
}
  • 返回值示例

返回字段含义参考（详细介绍）

order_book_id,quarter,net_profit,announce_date
000002.XSHE,2016q3,11290253073.2,20161028
000002.XSHE,2016q2,7094630598.39,20160822
601988.XSHG,2016q3,151558000000.0,20161027

具体的 query 说明请参考财务指标

# deprecated_fundamental_data

(详细介绍)

不支持该 api

# get_pit_financials - 查询季度财务信息(point-in-time 形式)

以给定一个报告期回溯的方式获取季度基础财务数据（三大表）和滚动基础财务数据（ttm 表），即利润表（income_statement），资产负债表（balance_sheet），现金流量表（cash_flow_statement），以及财务指标（financial_indicator）

  • 参数
参数 说明 是否必需
fields 需要返回的财务字段。支持的字段仅限三大基础财报中的大部分字段，具体可以参看财务数据页介绍。 是
quarter 财报回溯查询的起始报告期，例如'2015q2', '2015q4'分别代表 2015 年半年报以及年报。默认只获取当前报告期财务信息。 是
interval 查询财务数据的间隔。例如，填写'5y'，则代表从报告期开始回溯 5 年，每年为相同报告期数据；'3q'则代表从报告期开始向前回溯 3 个季度。 否
max_info_date 限制返回的最新日期，在研究中使用默认为当前查询日期。 否
if_adjusted 考虑获取的财务数据是否进行了调整，默认不填，返回最新数据
除去默认为空以外，如果 if_adjusted=0 只给允许日期的未调整数据。1 则给调整后（比如 18 年发布财报的时对上一财年 17 年的财报进行调整）		 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,end_date,info_date,if_adjusted,accounting_standards,is_complete,enterprise_type,info_type,total_assets,operating_revenue
000001.XSHE,2018-06-30,2018-08-16,0,1,1,business_bank,定期报告,3367399000000.0000,57241000000.0000
000001.XSHE,2018-06-30,2019-08-08,1,1,1,business_bank,定期报告,,57241000000.0000

# get_factor - 获取因子

默认快速返回给定的 order_book_id 当日的因子，包括财务因子、alpha101 因子、技术指标等。

  • 参数
参数 说明 是否必需
order_book_ids order_book_id 或列表 是
factor 因子名称，可查询 get_all_factor_names() 得到所有有效因子字段 是
date 指定日期，默认为该日的前一个交易日 是
start_date 开始日期。注：如使用开始日期，则必填结束日期 是
end_date 结束日期。注：若使用结束日期，则开始日期必填 是
universe 股票池，可选定某个指数的成分股，也可输入股票 list，默认为 None，全市场 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,date,debt_to_equity_ratio
000002.XSHE,2019-11-06,8.3331
000001.XSHE,2019-11-06,11.8706

# current_performance - 查询财务快报数据

默认返回给定的 order_book_id 当前最近一期的快报数据。

  • 参数
参数 说明 是否必需
order_book_id 必填。由于快报报告日期的不规则，目前只支持单个查询，批量请考虑轮询。 是
info_date yyyymmdd 或者 yyyy-mm-dd。如果不填(info_date 和 quarter 都为空)，则返回当前日期的最新发布的快报。如果填写，则从 info_date 当天或者之前最新的报告开始抓取。 否
quarter info_date 参数优先级高于 quarter。如果 info_date 填写了日期，则不查看 quarter 这个字段。 如果 info_date 没有填写而 quarter 有填写，则财报回溯查询的起始报告期，例如'2015q2', '2015q4'分别代表 2015 年半年报以及年报。默认只获取当前报告期财务信息 否
interval 查询财务数据的间隔。例如，填写'5y'，则代表从报告期开始回溯 5 年，每年为相同报告期数据；'3q'则代表从报告期开始向前回溯 3 个季度。不填写默认抓取一期。 否
fields 抓取对应有效字段返回。默认返回所有字段。具体快报字段可参看线上财务文档。 否

此处的 order book id 只能为 str 格式

  • 返回值示例

返回字段含义参考(详细介绍)

,end_date,info_date,operating_revenue,gross_profit,operating_profit,total_profit,np_parent_owners,net_profit_cut,net_operate_cashflow,total_assets,se_without_minority,total_shares,basic_eps,eps_weighted,eps_cut_epscut,eps_cut_weighted,roe,roe_weighted,roe_cut,roe_cut_weighted,net_operate_cashflow_per_share,equity_per_share,operating_revenue_yoy,gross_profit_yoy,operating_profit_yoy,total_profit_yoy,np_parent_minority_pany_yoy,ne_t_minority_ty_yoy,net_operate_cash_flow_yoy,total_assets_to_opening,se_without_minority_to_opening,basic_eps_yoy,eps_weighted_yoy,eps_cut_yoy,eps_cut_weighted_yoy,roe_yoy,roe_weighted_yoy,roe_cut_yoy,roe_cut_weighted_yoy,net_operate_cash_flow_per_share_yoy,net_asset_psto_opening
0,2018-12-31,2019-04-15,366868804.7,,-23860747.44,-26099939.24,-20270783.78,,,351177470.17,109235775.72,83976684.0,-0.2414,,,,-18.556909,-16.99,,,,1.3008,164.68,,-371.24,-368.62,-336.62,,,30.62,-15.58,-336.67,,,,-380.278052,-23.84,,,,-15.58

# performance_forecast - 查询业绩预告数据

默认返回给定的 order_book_id 当前最近一期的业绩预告数据。 业绩预告主要用来调取公司对即将到来的财务季度的业绩预期的信息。有时同一个财务季度会有多条记录，分别是季度预期和累计预期（即本年至今）。

  • 参数
参数 说明 是否必需
order_book_id 必填。由于快报报告日期的不规则，目前只支持单个查询，批量请考虑轮询。 是
info_date yyyymmdd 或者 yyyy-mm-dd。如果不填(info_date 和 quarter 都为空)，则返回当前日期的最新发布的快报。如果填写，则从 info_date 当天或者之前最新的报告开始抓取。 否
quarter info_date 参数优先级高于 quarter。如果 info_date 填写了日期，则不查看 quarter 这个字段。 如果 info_date 没有填写而 quarter 有填写，则财报回溯查询的起始报告期，例如'2015q2', '2015q4'分别代表 2015 年半年报以及年报。默认只获取当前报告期财务信息 否
interval 查询财务数据的间隔。例如，填写'5y'，则代表从报告期开始回溯 5 年，每年为相同报告期数据；'3q'则代表从报告期开始向前回溯 3 个季度。不填写默认抓取一期。 否
fields 抓取对应有效字段返回。默认返回所有字段。具体快报字段可参看线上财务文档。 否
  • 返回值示例

返回字段含义参考(详细介绍)

,info_date,end_date,forecast_type,forecast_description,forecast_growth_rate_floor,forecast_growth_rate_ceiling,forecast_earning_floor,forecast_earning_ceiling,forecast_np_floor,forecast_np_ceiling,forecast_eps_floor,forecast_eps_ceiling,net_profit_yoy_const_forecast
0,2016-01-21,2015-12-31,预增,累计利润,5.0,15.0,,,20792060000.0,22772250000.0,1.48,1.62,16.0

# sector - 获取某板块股票列表

获得属于某一板块的所有股票列表。

  • 参数
参数 说明 是否必需
code 板块名称或板块代码。例如，能源板块可填写'Energy'、'能源'或 sector_code.Energy 是
market 默认是中国市场('cn')，目前仅支持中国市场。 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id
002207.XSHE
000059.XSHE

# industry - 获取某行业股票列表

获得属于某一行业的所有股票列表

参数 说明 是否必需
code 行业名称或行业代码。例如，农业可填写 industry_code.A01 或 'A01' 是
market 默认是中国市场('cn')，目前仅支持中国市场 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id
002041.XSHE
000998.XSHE

# concept - 获取某概念股票列表

通过 order_book_id 传入，拿到某个日期的该股票指定的行业分类

获得属于某个或某几个概念的股票列表

  • 参数
参数 说明 是否必需
concept_names 概念名称。可以从概念列表中选择一个或多个概念填写, str or str list 是
date 查询日期，默认为当前最新日期 否
  • 返回值示例
order_book_id
000032.XSHE
600100.XSHG

返回字段含义参考(详细介绍)

# get_instrument_industry - 获取股票的指定行业分类

通过 order_book_id 传入，拿到某个日期的该股票指定的行业分类

  • 参数
参数 说明 是否必需
order_book_id 股票合约代码 是
date 查询日期，默认为当前最新日期 否
source 分类依据。 citics: 中信, gildata: 聚源 否
level 行业分类级别，共三级，默认返回一级分类。参数 0,1,2,3 一一对应，其中 0 返回三级分类完整情况 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,first_industry_code,first_industry_name
000001.XSHE,801780.INDX,银行
000002.XSHE,801180.INDX,房地产

# get_capital_flow - 获取股票资金流入流出

获取某只股票的资金流入流出信息。目前仅支持中国市场

  • 参数
参数 说明 是否必需
order_book_ids 合约代码，注意快照级别仅支持单个合约传入。 是
start_date 开始日期 否
end_date 结束日期 否
frequency 默认为'1d' 即单日级别，另支持'1m'和'tick'。目前不支持 resample，即 5d,5m 等分时图无内置 否
market 默认是中国市场('cn')，目前仅支持中国市场 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,date,buy_volume,buy_value,sell_volume,sell_value
000001.XSHE,2019-08-05,41162532,553893005,48145710,647992394
000001.XSHE,2019-08-06,51609556,682347377,36640357,484624092

# get_dividend_info - 获取股票的分红信息

获取某只股票在一段时间内的分红情况（包含起止日期）。如未指定日期，则默认所有。目前仅支持中国市场。

  • 参数
参数 说明 是否必需
order_book_ids 合约代码 是
start_date 开始日期 是
end_date 结束日期 是
market 默认是中国市场('cn')，目前仅支持中国市场 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,effective_date,dividend_type,ex_dividend_date
000001.XSHE,1990-12-31,cash and bonus share,1991-04-03
000001.XSHE,1991-12-31,cash and bonus share,1992-03-23

# get_turnover_rate - 获取历史换手率

  • 参数
参数 说明 是否必需
order_book_ids 合约代码，可输入 order_book_id, order_book_id list 是
start_date 开始日期，用户必须指定 否
end_date 结束日期，用户必须指定 否
fields 默认为所有字段。当天换手率 - today，过去一周平均换手率 - week，过去一个月平均换手率 - month，过去一年平均换手率 - year，当年平均换手率 - current_year 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,tradedate,today,week,month,year,current_year
000001.XSHE,2019-08-05,0.5201,0.4405,0.4106,0.583,0.5828
000001.XSHE,2019-08-06,0.514,0.4567,0.4141,0.5827,0.5824

# get_dividend - 获取股票现金分红数据

获取某只股票在一段时间内的现金分红情况（包含起止日期）。如未指定日期，则默认所有。目前仅支持中国市场。

  • 必要参数
参数 说明 是否必需
order_book_ids 合约代码 是
start_date 开始日期 否
end_date 结束日期 否
market 默认是中国市场('cn')，目前仅支持中国市场 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,declaration_announcement_date,book_closure_date,dividend_cash_before_tax,ex_dividend_date,payable_date,round_lot
000001.XSHE,1991-04-30,1991-04-30,3.0,1991-05-02,1991-05-02,10.0
000001.XSHE,1992-03-14,1992-03-20,2.0,1992-03-23,1992-03-23,10.0

# get_split - 获取股票拆分数据

获取某只股票在一段时间内的拆分情况（包含起止日期），如未指定日期，则默认所有。目前仅支持中国市场。

  • 参数
参数 说明 是否必需
order_book_ids 合约代码 是
start_date 开始日期 否
end_date 结束日期 否
market 默认是中国市场('cn')，目前仅支持中国市场
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,ex_dividend_date,book_closure_date,payable_date,split_coefficient_from,split_coefficient_to,cum_factor
000001.XSHE,1991-05-02,1991-04-30,1991-05-02,10,14.0,1.4
000001.XSHE,1992-03-23,1992-03-20,1992-03-23,10,15.0,2.0999999999999996

# get_ex_factor - 获取复权因子

获取复权因子。如未指定日期，则默认所有。

  • 参数
参数 说明 是否必需
order_book_ids 合约代码 是
start_date 开始日期 否
end_date 结束日期 否
market 默认是中国市场('cn')，目前仅支持中国市场 否
  • 返回值示例

返回字段含义参考(详细介绍)

ex_date,announcement_date,ex_cum_factor,ex_end_date,ex_factor,order_book_id
1991-08-17,1991-08-16,1.15749,1992-03-22,1.15749,000001.XSHE
1992-03-23,1992-03-22,1.747,1993-05-23,1.509300296330854,000001.XSHE

# is_suspended - 判断股票是否全天停牌

判断某只股票在一段时间（包含起止日期）是否全天停牌。

  • 参数
参数 说明 是否必需
order_book_ids 合约代码。传入单只或多支股票的 order_book_id 是
start_date 开始日期，默认为股票上市日期 否
end_date 结束日期，默认为当前日期，如果股票已经退市，则为退市日期 否
market 默认是中国市场('cn')，目前仅支持中国市场 否
  • 返回值示例

返回字段含义参考(详细介绍)

,000001.XSHE,601998.XSHG
2019-08-05,False,False
2019-08-06,False,False

# is_st_stock - 查询股票是否为 ST 股

判断一只或多只股票在一段时间（包含起止日期）内是否为 ST 股。

ST 股包括如下:

S*ST-公司经营连续三年亏损，退市预警+还没有完成股改;
*ST-公司经营连续三年亏损，退市预警;
ST-公司经营连续二年亏损，特别处理;
SST-公司经营连续二年亏损，特别处理+还没有完成股改;

  • 参数
参数 说明 是否必需
order_book_ids 是
start_date 开始日期 否
end_date 结束日期 否
  • 返回值示例

返回字段含义参考(详细介绍)

,002336.XSHE,002335.XSHE
2016-04-11,False,False
2016-04-12,False,False

# get_securities_margin - 获取融资融券信息

获取融资融券信息。包括深证融资融券数据以及上证融资融券数据情况。既包括个股数据，也包括市场整体数据。需要注意，融资融券的开始日>期为 2010 年 3 月 31 日;根据交易所的原始数据，上交所个股跟整个市场的输出信息列表不一致，个股没有融券余量金额跟融资融券余额两项, 而>深交所个股跟整个市场的输出信息列表一致。

  • 参数
参数 说明 是否必需
order_book_ids 可输入 order_book_id, order_book_id list。 另外，输入'XSHG'或'sh'代表整个上证整体情况；'XSHE'或'sz'代表深证整体情况 是
start_date 开始日期，默认为当前最近日期前一个月 否
end_date 结束日期，默认为当前有数据的最新日期 否
fields 默认为所有字段。见下方列表 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,date,margin_balance,buy_on_margin_value,short_sell_quantity,margin_repayment,short_balance_quantity,short_repayment_quantity,short_balance,total_balance
XSHE,2016-08-01,383762696120,18719900548,6838793,,68625689,,738545404,384501241524
XSHE,2016-08-02,382892321734,13450596083,10363639,,73856666,,779187729,383671509463

# get_margin_stocks - 获取融资融券股票列表

获取某个日期深证、上证融资融券股票列表。

  • 参数
参数 说明 是否必需
date 查询日期，默认为今天上一交易日 否
exchange 交易所，默认为 None，返回所有字段。可选字段包括：'XSHE', 'sz' 代表深交所；'XSHG', 'sh' 代表上交所 否
margin_type 'stock' 代表融券卖出，'cash'，代表融资买入，默认为'stock' 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id
000001.XSHE
000002.XSHE

# get_shares - 获取流通股信息

获取某只股票在一段时间内的流通情况（包含起止日期）

  • 参数
参数 说明 是否必须
order_book_ids 可输入 order_book_id 或 symbol 是
start_date 开始日期，默认为'2013-01-04' 否
end_date 结束日期，默认为'2014-01-04' 否
fields 默认为所有字段。见下方列表 否
market 默认是中国市场('cn')，目前仅支持中国市场 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,date,circulation_a,management_circulation,non_circulation_a,total_a,total
000001.XSHE,2016-08-01,14631180387.0,17587.0,2539230979.0,17170411366.0,17170411366.0
000001.XSHE,2016-08-02,14631180387.0,17587.0,2539230979.0,17170411366.0,17170411366.0

# get_stock_connect - 获取沪深股通持股信息

获取 A 股股票在一段时间内的在香港上市交易的持股情况

  • 参数
参数 说明 是否必需
order_book_ids 可输入 order_book_id 或 symbol。另，
1、输入‘shanghai_connect'可返回沪股通的全部股票数据。
2、输入'shenzhen_connect'可返回深股通的全部股票数据。
3、输入'all_connect'可返回沪股通、深股通的全部股票数据。		 是
start_date 开始日期，默认为'2017-03-17' 否
end_date 结束日期，默认为'2018-03-16' 否
fields 默认为所有字段。见下方列表 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,trading_date,shares_holding,holding_ratio
000049.XSHE,2018-05-08,194295.0,0.09
000049.XSHE,2018-05-09,144228.0,0.07

# get_private_placement - 获取 A 股股票定向增发信息

获取 A 股股票定向增发的信息

  • 参数
参数 说明 是否必需
order_book_id 给出单个 order_book_id。 是
start_date 开始日期（公告日期） 否
end_date 结束日期（公告日期） 否
prgoress 是否已完成定增，默认为 complete。可选参数["complete", "incomplete", "all"] 否
market 市场，默认'cn'为中国大陆市场。 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,initial_info_date,csrc_approval_date,issue_price,issue_type,issued_shares,listed_date,progress
000001.XSHE,2009-06-13,2010-06-29,18.26,非公开发行,379580000.0,2010-09-17,实施完成
000001.XSHE,2010-09-02,2011-06-29,17.75,非公开发行,1638336654.0,2011-08-05,实施完成

# get_block_trade - 获取 A 股大宗交易数据

获取 A 股大宗交易数据

  • 参数
参数 说明 是否必需
order_book_ids 给出单个或多个 order_book_id 是
start_date 开始日期 是
end_date 结束日期 是
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,trade_date,price,volume,total_turnover,buyer,seller
000001.XSHE,2019-02-28,11.16,289300,3228588.0,广发证券股份有限公司汕头珠池路证券营业部,中信证券股份有限公司汕头海滨路证券营业部
000001.XSHE,2019-05-06,12.47,36000000,448920000.0,华泰证券股份有限公司河南分公司,华泰证券股份有限公司河南分公司

# convertible.instruments - 获取可转债合约基础信息

获取债券合约基础信息

  • 参数
参数 说明 是否必需
order_book_ids 可转债流通场所代码，可传入 order_book_id, order_book_id list。 是
  • 返回值示例
order_book_id,_Instrument__cache,bond_type,call_protection,compensation_rate,conversion_end_date,conversion_start_date,coupon_frequency,coupon_method,coupon_rate,de_listed_date,exchange,full_name,issue_price,maturity_date,par_value,redemption_price,stock_code,symbol,total_issue_size,trade_type,value_date
128054.XSHE,{},cb,6.0,,2025-02-14,2019-08-22,1,stepup_rate,0.4,,XSHE,烟台中宠食品股份有限公司公开发行可转换公司债券,100.0,2025-02-15,100.0,110.0,002891.XSHE,中宠转债,194240000.0,clean_price,2019-02-15

# convertible.all_instruments - 获取所有可转债合约

获取所有可转债基础信息

  • 参数

无

  • 返回值示例
,order_book_id,symbol,full_name,exchange,bond_type,trade_type,value_date,maturity_date,par_value,coupon_rate,coupon_frequency,coupon_method,compensation_rate,total_issue_size,de_listed_date,stock_code,conversion_start_date,conversion_end_date,redemption_price,issue_price,call_protection
0,100001.XSHG,南化转债,南宁化工股份有限公司可转换公司债券,XSHG,cb,clean_price,1998-08-03,2003-08-03,100.0,1.0,1,stepup_rate,,150000000.0,2001-05-28,600301.XSHG,2000-07-12,2003-08-02,,100.0,
1,100009.XSHG,机场转债,上海国际机场股份有限公司可转换公司债券,XSHG,cb,clean_price,2000-02-25,2005-02-25,100.0,0.8,1,fixed_rate,,1350000000.0,2004-05-14,600009.XSHG,2000-08-25,2005-02-24,100.8,100.0,6.0

# convertible.get_conversion_price - 获取可转债转股价信息

获取可转债合约一段时期的转股价变动。信息来源为交易所的可转债转股统计公告。

  • 参数
参数 说明 是否必须
order_book_ids 可转债流通场所代码，可传入 order_book_id, order_book_id list。 是
start_date 开始日期，默认为初始的信息发布日 否
end_date 结束日期，默认为当前日期 否
  • 返回值示例
rder_book_id,info_date,conversion_price,effective_date
128054.XSHE,2019-02-13,37.97,2019-02-14
128054.XSHE,2019-05-24,22.28,2019-05-31

# convertible.get_conversion_info - 获取可转债转股导致的规模变动情况

获取可转债合约一段时期的转股规模变动

  • 参数
参数 说明 是否必需
order_book_ids 可转债流通场所代码，可传入 order_book_id, order_book_id list。 是
start_date 开始日期，默认为初始的信息发布日 否
end_date 结束日期，默认为当前日期 否
  • 返回值示例
order_book_id,info_date,amount_converted,conversion_price,end_date,remaining_amount,shares_converted,total_amount_converted,total_shares_converted
128054.XSHE,2019-08-26,1000.0,22.28,2019-08-23,194239000.0,44.88,1000.0,44.88
128054.XSHE,2019-08-27,2000.0,22.28,2019-08-26,194237000.0,89.77,3000.0,134.65

# convertible.get_call_info - 获取可转债强赎信息

获取可转债合约一段时期的强制赎回信息

  • 参数
参数 说明 是否必须
order_book_ids 可转债流通场所代码，可传入 order_book_id, order_book_id list。 是
start_date 开始日期，默认为初始的信息发布日 否
end_date 结束日期，默认为当前日期 否
  • 返回值示例
order_book_id,info_date,call_amount,exercise_date,exercise_price,interest_amount,interest_included,record_date
110020.XSHG,2015-01-22,8111000.0,2015-03-11,104.0,1.6,1,2015-03-10

# convertible.get_put_info - 获取可转债回售信息

获取可转债合约一段时期的持有人回售信息

  • 参数
参数 说明 是否必须
order_book_ids 可转债流通场所代码，可传入 order_book_id, order_book_id list。 是
start_date 开始日期，默认为初始的信息发布日 否
end_date 结束日期，默认为当前日期 否

返回值示例

order_book_id,info_date,enrollment_end_date,enrollment_start_date,exercise_price,interest_amount,interest_included,payment_date,put_amount,put_code
132002.XSHG,2018-06-25,2018-07-06,2018-07-02,107.0,0.08,1,2018-07-11,1154681000.0,182187
132002.XSHG,2018-07-16,2018-07-20,2018-07-16,107.0,0.12,1,2018-07-25,5166000.0,182152

# convertible.get_cash_flow - 获取可转债的现金流

获取可转债合约的现金流数据

  • 参数
参数 说明 是否必需
order_book_id 可单只转债流通场所代码 是
start_date 开始日期，默认为初始的兑付日 否
end_date 结束日期，默认为当前日期 否
  • 返回值示例
order_book_id,payment_date,cash_flow,cash_flow_pretax,interest_payment,interest_payment_pretax,principal_payment,record_date
132002.XSHG,2016-06-08,0.8,1.0,0.8,1.0,0.0,2016-06-07
132002.XSHG,2017-06-08,0.8,1.0,0.8,1.0,0.0,2017-06-07

# futures.get_dominant - 获取主力合约列表

获取某一期货品种一段时间的主力合约列表。合约首次上市时，以当日收盘同品种持仓量最大者作为从第二个交易日开始的主力合约。当同品种其他合约持仓量在收盘后超过当前主力合约 1.1 倍时，从第二个交易日开始进行主力合约的切换。日内不会进行主力合约的切换

  • 参数
参数 说明 是否必需
underlying_symbol 期货合约品种，例如沪深 300 股指期货为'IF' 是
start_date 开始日期，默认为期货品种最早上市日期后一交易日 否
end_date 结束日期，默认为当前日期 否
rule 默认是 rule=0,采用最大昨仓为当日主力合约，每个合约只能做一次主力合约，不会重复出现。针对股指期货，只在当月和次月选择主力合约。
当 rule=1 时，主力合约的选取只考虑最大昨仓这个条件。		 否
  • 返回值示例
date,dominant
2010-04-16,IF1005
2010-04-19,IF1005

# futures.get_contracts - 获取期货可交易合约列表

获取某一期货品种在策略当前日期的可交易合约 order_book_id 列表。按照到期月份，下标从小到大排列，返回列表中第一个合约对应的就是该品种的近月合约

  • 参数
参数 说明 是否必需
underlying_symbol 期货合约品种，例如沪深 300 股指期货为'IF' 是
date 查询日期，默认为当日 否
  • 返回值示例
order_book_id
IF1911
IF1912

# futures.get_warehouse_stocks - 获取期货仓单数据

获取期货某品种的注册仓单数据

  • 参数
参数 说明 是否必需
underlying_symbols 期货合约品种 是
start_date 开始日期，用户必须指定 否
end_date 结束日期，默认为策略当天日期的前一天 否
market 目前只支持中国市场 ('cn') 否
  • 返回值示例
date,underlying_symbol,on_warrant,exchange
20181107,CU,54824,SHFE
20181108,CU,55026,SHFE

# futures.get_member_rank - 获取期货会员持仓等排名情况

  • 参数
参数 说明 是否必需
obj 可以是期货的具体合约或者品种 是
trading_date 查询日期，默认为当日 否
start_date 开始日期。需要传入该参数时，必须打上‘start_date='字样 否
end_date 结束日期。需要传入该参数时，必须打上‘end_date='字样 否
rank_by 排名依据，默认为 volume 即根据持仓量统计排名，另外可选'long'和'short'，分别对应持买仓量统计和持卖仓量统计。 否
  • 返回值示例
trading_date,commodity_id,member_name,rank,volume,volume_change
2018-09-10,CU,五矿经易,1,29160,302
2018-09-10,CU,中信期货,2,27136,-535

# options.get_contracts - 筛选期权合约

  • 参数
参数 说明 是否必需
underlying 期权标的。可以填写 'M' 代表期货品种的字母；也可填写'M1901' 这种具体合约代码。必须填写，只支持单一品种或合约代码输入 是
option_type 'C' 代表认购期权；'P' 代表认沽期权合约。默认返回全部类型 否，默认返回全部到期月份
strike 行权价。查询时向左靠档匹配（例如，当前最高行权价是 1000，则输入大于 1000 的行权价都会向左靠档至 1000）。默认返回全部行权价 否
trading_date 查询日期。默认返回全部数据 否
  • 返回值示例
order_book_id
CU2003C48000
CU2004P47000

# index_indicator - 获取指数每日估值指标

获取指数每日估值指标。目前仅提供上证 50、沪深 300、中证 500 和中证 800 的市盈率和市净率。 计算逻辑：

市盈率：对应成分股的市值之和 / 成分股的最新一期的滚动归属母公司净利润之和。负数目前不会剔除。
市净率：对应成分股的市值之和 / 成分股的最新一期的总权益之和。

  • 参数
参数 说明 是否必需
order_book_ids 可输入 order_book_id, order_book_id list。 是
start_date 开始日期，默认 2016-01-04 否
end_date 结束日期，默认 2016-12-31 否
fields 对应估值字段。默认为所有字段。 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,trade_date,pb,pe_ttm
000016.XSHG,2019-08-05,1.0188,9.5868
000016.XSHG,2019-08-06,1.0088,9.4923

# index_components - 获取指数成分股列表

获取某一指数的股票构成列表，也支持指数的历史构成查询。

  • 参数
参数 说明 是否必需
order_book_id 指数代码，传入 order_book_id，例如'000001.XSHG'。 是
date 查询日期，默认为最新记录日期 否
start_date 指定开始日期，不能和 date 同时指定 否
end_date 指定结束日期, 需和 start_date 同时指定并且应当不小于开始日期 否
market 默认是中国市场('cn')，目前仅支持中国市场 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id
603259.XSHG
600690.XSHG

# index_weights - 获取指数历史权重

获取某一指数的历史构成以及权重。注意，该数据为月度更新。

  • 参数
参数 说明 是否必需
order_book_id 指数代码，可传入 order_book_id，例如'000001.XSHG'或'沪深 300'。目前所支持的指数列表可以参考指数数据表 是
date 查询日期，默认为最新记录日期 否
  • 返回值示例

返回字段含义参考(详细介绍)

order_book_id,0
600000.XSHG,0.025840000000000002
600016.XSHG,0.02686

# fund.instruments - 获取基金基础信息

  • 参数
参数 注释 是否必须
order_book_ids 基金代码 是
  • 返回值示例

返回字段含义参考 详细介绍

order_book_id,accrued_daily,benchmark,de_listed_date,establishment_date,exchange,fund_manager,fund_type,issuer,latest_size,listed_date,round_lot,stop_date,symbol,transition_time,type
050116,False,100.0％×中证全债指数,0000-00-00,2010-07-27,,王申 王衍胜 ,Bond,博时基金管理有限公司,112222264.1,2010-07-27,1.0,0000-00-00,博时宏观C,0,PublicFund

# fund.all_instruments - 获取所有公募基金信息

  • 参数
参数 注释 是否必须
date 查询日期，默认为当前日期上一交易日。过滤掉在该日期尚未上市交易的基金合约 否
  • 返回值示例

返回字段含义参考 详细介绍

,order_book_id,establishment_date,listed_date,transition_time,issuer,symbol,fund_type,fund_manager,latest_size,benchmark,accrued_daily,de_listed_date,stop_date,exchange,round_lot
0,000001,2001-12-18,2001-12-18,0,华夏基金管理有限公司,华夏成长,Hybrid,董阳阳 ,4576235151.83,,False,0000-00-00,0000-00-00,,1.0
1,000003,2013-03-20,2013-03-20,0,中海基金管理有限公司,中海可转债A,Bond,彭海平 ,105377712.26,70.0％×标普中国可转债指数+10.0％×上海证券交易所上证红利指数+20.0％×中证综合债券指数,False,0000-00-00,0000-00-00,,1.0

# fund.get_nav - 获取基金净值信息

  • 参数
参数 注释 是否必须
order_book_ids 基金代码 是
start_date 查询的开始日期，默认为所有净值数据 否
end_date 查询的结束日期 否
fields 查询字段，有效值见下方 否
  • 返回值示例

返回字段含义参考 详细介绍

order_book_id,datetime,acc_net_value,adjusted_net_value,change_rate,redeem_status,subscribe_status,unit_net_value
050116,2019-10-11,1.384,1.396839,0.0015437200000000002,Open,Open,1.298
050116,2019-10-14,1.389,1.402219,0.0038515500000000005,Open,Open,1.303

# fund.get_holdings - 获取基金持仓信息

  • 参数
参数 注释 是否必需
order_book_id 基金代码 是
date 查询日期，回溯获取距离指定日期最近的持仓数据。如不指定日期，则获取所有日期的持仓数据 否
  • 返回值示例

返回字段含义参考 详细介绍

order_book_id,weight,shares,market_value,date
300410.XSHE,1.74,174200.0,9405200.0,2016-12-31
000888.XSHE,0.00,800.0,9600.0,2016-12-31

# fund.get_etf_components - 获取 ETF 成分股持有情况

  • 参数
参数 注释 是否必需
order_book_id 基金代码 是
trading_date 查询日期，如不指定日期，则获取当天数据（注意仅交易日有效）。 否
  • 返回值示例

返回字段含义参考 详细介绍

,trading_date,order_book_id,stock_code,stock_amount,cash_substitute,cash_substitute_proportion,fixed_cash_substitute
0,2019-01-17,510050.XSHG,600000.XSHG,5600.0,允许,0.1,
1,2019-01-17,510050.XSHG,600016.XSHG,11900.0,允许,0.1,

# fund.get_split - 获取基金拆分信息

  • 参数
参数 注释 是否必需
order_book_id 基金代码 是
  • 返回值示例

返回字段含义参考 详细介绍

ex_dividend_date,order_book_id,split_ratio
2013-11-01,000246,1.00499349
2013-12-02,000246,1.00453123

# fund.get_dividend - 获取基金分红信息

  • 参数
参数 注释 是否必需
order_book_id 基金代码 是
  • 返回值示例

返回字段含义参考 详细介绍

ex_dividend_date,order_book_id,book_closure_date,payable_date,dividend_before_tax
2012-01-17,050116,2012-01-17,2012-01-19,0.002
2013-01-16,050116,2013-01-16,2013-01-18,0.013000000000000001

# fund.get_manager - 获取指定基金的基金经理管理信息

  • 参数
参数 注释 是否必需
order_book_ids 基金代码或代码列表 是
  • 返回值示例

返回字段含义参考 详细介绍

order_book_id,id,name,days,start_date,end_date,return
050116,101000782,皮敏,1297,2010-07-27,2014-02-13,-9.4245
050116,101001032,张勇,463,2014-02-13,2015-05-22,51.2013

# fund.get_manager_info - 获取基金经理背景信息

  • 参数
参数 注释 是否必须
manager_id 可传入基金经理 id 或名字。名字与 id 不能同时传入 是
fields 对应返回字段，默认为所有字段 否
  • 返回值示例

返回字段含义参考 详细介绍

id,chinesename,gender,region,birthdate,education,practice_date,experience_time,background
101002094,胡剑,男,中国,,硕士,2006-01-01,12.8,    胡剑先生，经济学硕士。曾任易方达基金管理有限公司固定收益部债券研究员、基金经理助理兼债券研究员、固定收益研究部负责人、固定收益总部总经理助理、易方达中债新综合债券指数发起式证券投资基金（LOF）基金经理（自2012年11月8日至2014年3月28日）、易方达纯债债券型证券投资基金基金经理（自2013年4月22日至2015年3月13日）、易方达永旭添利定期开放债券型证券投资基金基金经理（自2013年4月22日至2015年3月13日）、易方达纯债1年定期开放债券型证券投资基金基金经理（自2013年7月30日至2015年3月13日）。现任易方达基金管理有限公司固定收益研究部总经理、易方达稳健收益债券型证券投资基金基金经理（自2012年2月29日起任职）、易方达信用债债券型证券投资基金基金经理（自2013年4月24日起任职）、易方达裕惠回报定期开放式混合型发起式证券投资基金基金经理（自2013年12月17日起任职）、易方达瑞财灵活配置混合型证券投资基金基金经理（自2016年2月4日起任职）、易方达裕景添利6个月定期开放债券型证券投资基金基金经理（自2016年4月12日起任职）、易方达高等级信用债债券型证券投资基金基金经理（自2017年3月7日起任职）。自2017年3月24日起，担任易方达丰惠混合型证券投资基金基金经理。自2017年5月12日起，担任易方达瑞富灵活配置混合型证券投资基金的基金经理。自2017年6月21日起，担任易方达瑞智灵活配置混合型证券投资基金的基金经理。自2017年6月23日起，担任易方达瑞兴灵活配置混合型证券投资基金基金经理。自2018年1月19日起，担任易方达瑞祥灵活配置混合型证券投资基金的基金经理。自2018年1月29日起，担任易方达瑞祺灵活配置混合型证券投资基金基金经理。自2018年7月5日起，担任易方达3年封闭运作战略配售灵活配置混合型证券投资基金（LOF）基金经理。

# fund.get_asset_allocation - 获取基金资产配置

  • 参数
参数 注释 是否必需
order_book_id 基金代码 是
date 查询日期，回溯获取距离指定日期最近的数据。如不指定日期，则获取所有日期的数据 否
  • 返回值示例

返回字段含义参考 详细介绍

datetime,stock,bond,fund,cash,nav

# fund.get_industry_allocation - 获取基金行业配置

  • 参数
参数 注释 是否必需
order_book_id 基金代码 是
date 查询日期，回溯获取距离指定日期最近的数据。如不指定日期，则获取所有日期的数据 否
  • 返回值示例

返回字段含义参考 详细介绍

datetime,industry,weights,market_value

# fund.get_ratings - 获取基金评级信息

  • 参数
参数 注释 是否必需
order_book_id 基金代码 是
date 查询日期，回溯获取距离指定日期最近的数据。如不指定日期，则获取所有日期的数据 否
  • 返回值示例

返回字段含义参考 详细介绍

order_book_id,datetime,zs,sh3,sh5,jajx
202101,2009-12-31,,,,3.0
202101,2010-03-31,,,,3.0

# fund.get_units_change - 获取基金份额变动信息

  • 参数
参数 注释 是否必需
order_book_id 基金代码 是
date 查询日期，回溯获取距离指定日期最近的数据。如不指定日期，则获取所有日期的数据 否
  • 返回值示例

返回字段含义参考 详细介绍

datetime,subscribe_units,redeem_units,units
2004-06-30,48622840.17,147177098.18,1671473832.33
2004-09-30,2783147.43,462927887.43,1211329092.33

# fund.get_snapshot - 获取基金最新的衍生数据

  • 参数
参数 注释 是否必需
order_book_ids 基金代码 是
fields 返回字段，默认返回所有衍生字段 否
market 指定市场，目前仅有中国市场('cn')的基金衍生数据 否
  • 返回值示例

返回字段含义参考 详细介绍

datetime,industry,weights,market_value
2007-03-31,房地产业,0.0209,13051493.6
2007-03-31,机械、设备、仪表,0.06,37541496.6

# fund.get_indicators - 获取基金的衍生数据

  • 参数
参数 注释 是否必需
order_book_id 基金代码 是
start_date 开始日期, 格式为 'YYYY-mm-dd', 默认为基金衍生数据最早有效日期 否
end_date 结束日期, 格式为 'YYYY-mm-dd', 默认为查询当日 否
fields 返回字段，默认返回所有衍生字段 否
market 指定市场，目前仅有中国市场('cn')的基金衍生数据 否
  • 返回值示例

返回字段含义参考 详细介绍

order_book_id,datetime,information_ratio,average_size
000001,2001-12-18,,
000001,2001-12-28,,

# econ.get_reserve_ratio - 获取存款准备金率

  • 参数
参数 说明 是否必需
reserve_type 目前有大型金融机构（'major'） 和 其他金融机构（'other'）两种分类。
默认为 all，即所有类别都会返回。		 是
start_date 开始日期，默认为去年的查询当日（基准为信息公布日）。 是
end_date 结束日期，默认为查询当日。 是
  • 返回值示例
info_date,effective_date,reserve_type,ratio_floor,ratio_ceiling
2018-04-17,2018-04-25,major_financial_institution,16.0,16.0
2018-06-24,2018-07-05,major_financial_institution,15.5,15.5

# econ.get_money_supply - 获取货币供应量

  • 参数
参数 说明 是否必需
start_date 开始日期，默认为去年的查询当日（基准为信息公布日）。 是
end_date 结束日期，默认为查询当日。
  • 返回值示例
info_date,effective_date,m2,m1,m0,m2_growth_yoy,m1_growth_yoy,m0_growth_yoy
2018-08-16,2018-07-31,177619611.0,53662429.0,6953059.0,0.085,0.051,0.036
2018-09-21,2018-08-31,178867043.0,53832464.0,6977539.0,0.082,0.039,0.033

# econ.get_factors- 获取宏观因子数据

  • 参数
参数 说明 是否必需
factors 宏观因子名称，点击下载 是
start_date 起始日期 是
end_date 截止日期 是
  • 返回值示例
factor,info_date,start_date,end_date,value
工业品出厂价格指数PPI_当月同比_(上年同月=100),2017-08-09 09:30:00,2017-06-30,2017-07-31,105.5
工业品出厂价格指数PPI_当月同比_(上年同月=100),2017-09-09 09:30:00,2017-07-31,2017-08-31,106.3

# user.get_quota - 获取用户配额信息

获取用户当前配额使用信息，目前可以提供的有今日已用流量、今日可用流量上限.

  • 参数

无

  • 返回值示例

返回字段含义参考(详细介绍)

name,value
bytes_used,651
bytes_limit,0
remaining_days,0
license_type,OTHER
Last Updated: 9/24/2024, 1:54:10 PM