Metadata-Version: 1.1
Name: lixinger_openapi
Version: 0.1.2
Summary: lixinger openapi
Home-page: https://github.com/ShekiLyu/lixinger-openapi
Author: sheki lyu
Author-email: lvxueji@gmail.com
License: Apache License v2
Description-Content-Type: text/markdown
Description: # lixinger-openapi
        
        ## 简介
        本Python包是[理杏仁开放平台](https://www.lixinger.com/open/api)WEB API的非官方Python封装，目的是方便Python量化分析者使用理杏仁开放平台数据。
        
        ## 功能
        查询理杏仁开放平台数据，返回json或dataframe
        
        ### 接口列表
        包                     | 接口名                        | 接口功能
        ---------------------- | ----------------------------- | -------------------------
        lixinger\_openapi      | load\_token                   | 加载token
        lixinger\_openapi.json | stock\_fundamental\_info      | A股公司基本面数据(json格式)
        lixinger\_openapi.json | stock\_fs\_info               | A股公司财务数据(json格式)
        lixinger\_openapi.json | indice\_fundamental\_info     | A股指数基本面数据(json格式)
        lixinger\_openapi.json | hk\_stock\_fundamental\_info  | 港股公司基本面数据(json格式)
        lixinger\_openapi.json | hk\_stock\_fs\_info           | 港股公司财务数据(json格式)
        lixinger\_openapi.json | hk\_indice\_fundamental\_info | 港股指数基本面数据(json格式)
        lixinger\_openapi.data | stock\_fundamental\_info      | A股公司基本面数据(dataframe格式)
        lixinger\_openapi.data | stock\_fs\_info               | A股公司财务数据(dataframe格式)
        lixinger\_openapi.data | indice\_fundamental\_info     | A股指数基本面数据(dataframe格式)
        lixinger\_openapi.data | hk\_stock\_fundamental\_info  | 港股公司基本面数据(dataframe格式)
        lixinger\_openapi.data | hk\_stock\_fs\_info           | 港股公司财务数据(dataframe格式)
        lixinger\_openapi.data | hk\_indice\_fundamental\_info | 港股指数基本面数据(dataframe格式)
        
        参数列表和理杏仁开放平台完全一致，详细参数介绍见理杏仁开放平台。
        
        ## 安装
        ### 从PyPI安装
        `pip install lixinger_openapi`
        
        ### 从Github安装
        `pip install git+http://github.com/ShekiLyu/lixinger-openapi.git`
        
        ## 使用示例
        ```
        import lixinger_openapi as lo
        lo.load_token("your_token")
        json_rlt = lo.json.indice_fundamental_info(date='2018-05-21', stockCodes=['000300','000905'], metrics=['pe_ttm', 'pb'])
        ```
        json格式返回结果为Python数组，结构与网站返回的json相同:
        
        ```
        [
          {
            'date': '2018-05-20T16:00:00.000Z',
            'pe_ttm': {
              'weightedAvg': 13.22568765724127,
              'median': 24.726652058696498,
              'equalAvg': 18.250245261066897,
              'avg': 28.26107455983107,
              'y_10': {
                'weightedAvg': {
                  'latestVal': 13.22568765724127,
                  'latestValPos': 0.5004111842105263,
                  'minVal': 8.011307841787573,
                  ......
        ```
        ```
        df = lo.data.indice_fundamental_info(date='2018-05-21', stockCodes=['000300','000905'], metrics=['pe_ttm', 'pb'])
        ```
        dataframe格式返回结果的表头:
        ```
        Index(['date', 'pb.avg', 'pb.equalAvg', 'pb.median', 'pb.weightedAvg',
               'pb.y_10.avg.chanceVal', 'pb.y_10.avg.latestVal',
               'pb.y_10.avg.latestValPos', 'pb.y_10.avg.maxPositiveVal',
               'pb.y_10.avg.maxVal',
               ...
               'pe_ttm.y_5.weightedAvg.chanceVal', 'pe_ttm.y_5.weightedAvg.latestVal',
               'pe_ttm.y_5.weightedAvg.latestValPos',
               'pe_ttm.y_5.weightedAvg.maxPositiveVal',
               'pe_ttm.y_5.weightedAvg.maxVal', 'pe_ttm.y_5.weightedAvg.medianVal',
               'pe_ttm.y_5.weightedAvg.minVal', 'pe_ttm.y_5.weightedAvg.riskVal',
               'stockCnName', 'stockCode'],
              dtype='object', length=139)
        ```
        结果里包含139列数据，分别对应理杏仁返回的json数据进行扁平化处理后的结果，嵌套的数据用key1.key11.key111的方式作为列名。
        
        详细使用方法请参考[用户使用指南](https://github.com/ShekiLyu/lixinger-openapi/blob/master/doc/user_guide.ipynb)。
        
Platform: UNKNOWN
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
