通过HTTP调取数据

**{
"api_name": "stock_basic",
"token": "fa37ac15d7y38f",
"params": {"list_status": "L"},
"fields": "ts_code, name, industry, area"

}**

HTTP API说明

在datacube网站上，我们在平台介绍的“调取数据”部分，已经对http协议的数据获取做了说明，这里再次详细的向大家介绍一下，尽量让大家多一点的了解如何通过http的方式获取数据。

HTTP数据获取的方式，我们采用了post的机制，通过提交JSON body参数，就可以获得您想要的数据。具体参数说明如下：

输入参数

api_name：接口名称，比如stock_basic

token ：用户唯一标识，可通过登录pro网站获取

params：接口参数，如daily接口中start_date和end_date

fields：字段列表，用于接口获取指定的字段，以逗号分隔，如"open,high,low,close"

输出参数

code： 接口返回码，2002表示权限问题。

msg：错误信息，比如“系统内部错误”，“没有权限”等

data：数据，data里包含fields和items字段，分别为字段和数据内容

以下，我们从几个方面来介绍具体的使用过程。

API工具快速检测

如果想简单快速获得数据API的效果，检测一下可用性，又不想写代码的话，postman这个工具或许可以派上用场。

运行postman，选择POST方式，在API地址栏里输入：http://datacubeapi.foundersc.com ，然后在下面点击body，输入json格式的参数。

之后，点击“Send”按钮，我们可以在结果栏目里看到调取API的最终效果。

代码快速检测

有的程序员可能更喜欢用代码的方式来检查API的效果，更加直接，简单，高效。我们可以借助cURL工具来实现通过命令行方式来检测。

curl -X POST -d '{"api_name": "stock_basic", "token": "xxxxxxxx", "params": {"list_stauts":"L"}, "fields": "ts_code,name,area,industry,list_date"}' http://datacubeapi.foundersc.com

（按住屏幕滑动可浏览全部代码）

在控制台执行后，我们就可以看到如下数据效果。


{
    "code": 0,
    "msg": null,
    "data": {
        "fields": [
            "ts_code",
            "name",
            "area",
            "industry",
            "list_date"
        ],
        "items": [
            [
                "000001.SZ",
                "平安银行",
                "深圳",
                "银行",
                "19910403"
            ],
            [
                "000002.SZ",
                "万科A",
                "深圳",
                "全国地产",
                "19910129"
            ],
            [
                "000004.SZ",
                "国农科技",
                "深圳",
                "生物制药",
                "19910114"
            ],
            [
                "000005.SZ",
                "世纪星源",
                "深圳",
                "房产服务",
                "19901210"
            ],
            [
                "000006.SZ",
                "深振业A",
                "深圳",
                "区域地产",
                "19920427"
            ],
            [
                "000007.SZ",
                "全新好",
                "深圳",
                "酒店餐饮",
                "19920413"
            ],
            [
                "000008.SZ",
                "神州高铁",
                "北京",
                "运输设备",
                "19920507"
            ]
            ...
      }
}

Python调取示例

前面已经提到,http restful API的好处就是跟编程语言无关，基本上所有编程语言都可以调取。

由于编程环境太多，这里只拿Python作为示例，其他语言的实现，请各位用户自行查找网络资源完成，相信绝大多数会编程的用户都能轻松搞定。

以下就是部分相关的核心代码


def req_http_api(self, req_params):
    req = Request(
        self.__http_url,
        json.dumps(req_params).encode('utf-8'),
        method='POST'
    )

    res = urlopen(req)
    result = json.loads(res.read().decode('utf-8'))

    if result['code'] != 0:
        raise Exception(result['msg'])

    return result['data']


def query(self, api_name, fields='', **kwargs):
    req_params = {
        'api_name': api_name,
        'token': self.__token,
        'params': kwargs,
        'fields': fields
    }

    if self.__protocol == 'tcp':
        data = self.req_zmq_api(req_params)
    elif self.__protocol == 'http':
        data = self.req_http_api(req_params)
    else:
        raise Warning('{} is unsupported protocol'.format(self.__protocol))

    columns = data['fields']
    items = data['items']

    return pd.DataFrame(items, columns=columns)
置顶