neurostats-API 0.0.11__tar.gz → 0.0.13__tar.gz

{neurostats_API-0.0.11 → neurostats_API-0.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: neurostats_API
-Version: 0.0.11
+Version: 0.0.13
 Summary: The service of NeuroStats website
 Home-page: https://github.com/NeurowattStats/NeuroStats_API.git
 Author: JasonWang@Neurowatt
@@ -14,11 +14,14 @@ Description-Content-Type: text/markdown
 - [使用方法](#使用方法)
     - [下載](#下載)
     - [價值投資](#得到最新一期的評價資料與歷年評價)
+        - [歷史評價](#得到指定公司的歷來評價)
     - [財務分析-重要指標](#財務分析-重要指標)
     - [月營收表](#回傳月營收表)
     - [損益表](#損益表)
     - [資產負債表](#資產負債表)
     - [現金流量表](#現金流量表)
+    - [法人交易](#法人交易)
+    - [資券餘額](#資券餘額)
     - [版本紀錄](#版本紀錄)
 
 
@@ -80,7 +83,7 @@ pip install neurostats-API
 ```Python 
 >>> import neurostats_API
 >>> print(neurostats_API.__version__)
-0.0.10
+0.0.13
 ```
 
 ### 得到最新一期的評價資料與歷年評價
@@ -89,7 +92,8 @@ from neurostats_API.utils import ValueFetcher, DBClient
 db_client = DBClient("<連接的DB位置>").get_client()
 ticker = "2330" # 換成tw50內任意ticker
 fetcher = ValueFetcher(ticker, db_client)
-data = stats_fetcher.query_data()
+
+fetcher.query_data()
 ```
 
 #### 回傳(2330為例)
@@ -124,6 +128,69 @@ data = stats_fetcher.query_data()
 ```
 > 這裡有Nan是因為本益比與P/B等資料沒有爬到最新的時間
 
+### 得到指定公司的歷來評價
+``` Python
+from neurostats_API.utils import ValueFetcher, DBClient
+db_client = DBClient("<連接的DB位置>").get_client()
+ticker = "2330" # 換成tw50內任意ticker
+fetcher = ValueFetcher(ticker, db_client)
+
+fetcher.query_value_serie()
+```
+#### 回傳(2330為例)
+```Python
+{
+'EV_EBIT':               EV_EBIT
+        2014-01-02        NaN
+        2014-01-03        NaN
+        ...               ...
+        2024-12-12  15.021431
+        2024-12-13  15.088321
+,
+'EV_OPI':                EV_OPI
+        2014-01-03        NaN
+        ...               ...
+        2024-12-12  15.999880
+        2024-12-13  16.071128
+,
+'EV_S':                 EV_S
+        2014-01-02       NaN
+        2014-01-03       NaN
+        ...              ...
+        2024-12-12  6.945457
+        2024-12-13  6.976385
+,
+'P_B':              P_B
+        2014-01-02   NaN
+        2014-01-03   NaN
+        ...          ...
+        2024-12-12  6.79
+        2024-12-13  6.89
+,
+'P_E':               P_E
+        2014-01-02    NaN
+        2014-01-03    NaN
+        ...           ...
+        2024-12-12  26.13
+        2024-12-13  26.50
+,
+'P_FCF':                 P_FCF
+        2014-01-02        NaN
+        2014-01-03        NaN
+        ...               ...
+        2024-12-12  45.302108
+        2024-12-13  45.515797
+,
+'P_S':                  P_S
+        2014-01-02       NaN
+        2014-01-03       NaN
+        ...              ...
+        2024-12-12  6.556760
+        2024-12-13  6.587688
+}
+```
+
+
 ### 回傳月營收表
 ``` Python
 from neurostats_API.fetchers import MonthRevenueFetcher, DBClient
@@ -324,7 +391,7 @@ db_client = DBClient("<連接的DB位置>").get_client()
 ticker = "2330" # 換成tw50內任意ticker
 fetcher = BalanceSheetFetcher(ticker, db_client)
 
-stats_fetcher.query_data()
+fetcher.query_data()
 ```
 
 #### 回傳
@@ -386,7 +453,7 @@ db_client = DBClient("<連接的DB位置>").get_client()
 ticker = 2330 # 換成tw50內任意ticker
 fetcher = StatsFetcher(ticker, db_client)
 
-stats_fetcher.query()
+fetcher.query()
 ```
 #### 回傳
 ```Python
@@ -435,8 +502,186 @@ stats_fetcher.query()
 
 > 大部分資料缺失是因為尚未計算，僅先填上已經有的資料
 
+## 籌碼面
+### 法人交易
+``` Python
+from neurostats_API.fetchers import InstitutionFetcher
+db_client = DBClient("<連接的DB位置>").get_client()
+ticker = 2330 # 換成tw50內任意ticker
+fetcher = StatsFetcher(ticker, db_client)
+
+fetcher.query()
+```
+### 回傳
+```Python
+{ 'annual_trading':       
+                        close      volume  ... 自營商買賣超股數(避險)   三大法人買賣超股數
+        2024-12-02  1035.000000  31168404.0  ...    -133215.0  11176252.0
+        2024-11-29   996.000000  40094983.0  ...     401044.0  -7880519.0
+        ...                 ...         ...  ...          ...         ...
+        2023-12-05   559.731873  22229723.0  ...       33,400  -5,988,621
+        2023-12-04   563.659790  26847171.0  ...     -135,991  -5,236,743
+
+,
+  'latest_trading': 
+  { 'date': datetime.datetime(2024, 12, 2, 0, 0),
+    'table':              
+            category       variable  ...  over_buy_sell   sell
+        0   foreign  average_price  ...           0.00    0.0
+        1   foreign     percentage  ...           0.00    0.0
+        ..      ...            ...  ...            ...    ...
+        14     prop          price  ...           0.00    0.0
+        15     prop          stock  ...        -133.22  217.2
+  }
+,
+  'price': 
+  { 
+        '52weeks_range': '555.8038940429688-1100.0', # str
+        'close': 1035.0, # float
+        'last_close': 996.0, # float
+        'last_open': 995.0, # float
+        'last_range': '994.0-1010.0', # str
+        'last_volume': 40094.983, # float
+        'open': 1020.0, # float
+        'range': '1015.0-1040.0', # str
+        'volume': 32238.019 # float
+  }
+}
+```
+
+- `annual_trading`: 對應一年內每日的交易量
+- `latest_trading`: 對應當日交易
+##### 欄位項目名稱
+|英文|中文對應|
+|----|-------|
+|buy|買進|
+|sell|賣出|
+|over_buy_sell|買賣超|
+
+##### category項目名稱
+|英文|中文對應|
+|----|-------|
+|foreign|外資|
+|prop|自營商|
+|mutual|投信|
+|institutional_investor|三大法人|
+
+##### variable項目名稱
+|英文|中文對應|
+|----|-------|
+|stock|股票張數|
+|price|成交金額|
+|average_price|均價|
+|percetage|佔成交比重|
+
+**成交金額以及均價因為資料沒有爬到而無法計算**
+**仍然先將這項目加入，只是數值都會是0**
+
+- `price`: 對應法人買賣頁面的今日與昨日交易價
+請注意`range`, `last_range`, `52week_range`這三個項目型態為字串，其餘為float
+
+##### 項目名稱
+|英文|中文對應|
+|----|-------|
+|open|開盤價|
+|close|收盤價|
+|range|當日範圍|
+|volume|成交張數|
+|last_open|開盤價(昨)|
+|last_close|收盤價(昨)|
+|last_range|昨日範圍|
+|last_volume|成交張數(昨)|
+|52weeks_range|52週範圍|
+
+## 資券餘額
+對應iFa.ai -> 交易資訊 -> 資券變化
+```Python
+from neurostats_API.fetchers import MarginTradingFetcher
+db_client = DBClient("<連接的DB位置>").get_client()
+ticker = 2330 # 換成tw50內任意ticker
+fetcher = MarginTradingFetcher(ticker, db_client)
+
+fetcher.query()
+```
+
+### 回傳
+```Python
+{ 'annual_margin':                   
+                        close   volume  ...  借券_次一營業日可限額  資券互抵
+        2024-12-03  1060.000000  29637.0  ...    12222.252   0.0
+        2024-12-02  1035.000000  31168.0  ...    12156.872   1.0
+        ...                 ...      ...  ...          ...   ...
+        2023-12-05   559.731873  22230.0  ...     7838.665   1.0
+        2023-12-04   563.659790  26847.0  ...     7722.725   2.0
+
+  'latest_trading': { 
+        'date': datetime.datetime(2024, 12, 3, 0, 0),
+        'margin_trading':          
+                        financing  short_selling
+        買進           761.0           34.0
+        賣出          1979.0           44.0
+        ...            ...            ...
+        次一營業日限額  6483183.0      6483183.0
+        現償             3.0           12.0
+
+
+        'security_offset': 0.0,
+        'stock_lending':           stock_lending
+                當日賣出                 10
+                當日還券                  0
+                當日調整                  0
+                當日餘額              14688
+                次一營業日可限額          12222
+  },
+  'price': { '52weeks_range': '555.8038940429688 - 1100.0',
+             'close': 1060.0,
+             'last_close': 1035.0,
+             'last_open': 1020.0,
+             'last_range': '1015.0 - 1040.0',
+             'last_volume': 31168.404,
+             'open': 1060.0,
+             'range': '1055.0 - 1065.0',
+             'volume': 29636.523}}
+```
+- `annual_trading`: 對應一年內每日的資券變化量
+- `latest_trading`: 對應當日交易
+##### 欄位項目名稱
+|英文|中文對應|
+|----|-------|
+|financing|融資|
+|short_selling|融券|
+
+- `price`: 對應法人買賣頁面的今日與昨日交易價
+##### 項目名稱
+|英文|中文對應|
+|----|-------|
+|open|開盤價|
+|close|收盤價|
+|range|當日範圍|
+|volume|成交張數|
+|last_open|開盤價(昨)|
+|last_close|收盤價(昨)|
+|last_range|昨日範圍|
+|last_volume|成交張數(昨)|
+|52weeks_range|52週範圍|
+
+請注意`range`, `last_range`, `52week_range`這三個項目型態為字串，其餘為float
 
 ## 版本紀錄
+### 0.0.13
+- value_fetcher 新增獲得一序列評價的功能
+
+### 0.0.12
+- 新增資券變化(margin trading)
+
+- 修改法人買賣(institution_trading)的query方式
+
+### 0.0.11
+- 修復財務分析的千元計算問題
+
+- 籌碼面新增法人買賣(institution_trading)
+
+- 將財報三表與月營收的資料型態與數值做轉換(%轉字串, 千元乘以1000)
 ### 0.0.10
 - 更新指標的資料型態: 單位為千元乘以1000之後回傳整數
 

{neurostats_API-0.0.11 → neurostats_API-0.0.13}/README.md

@@ -4,11 +4,14 @@
 - [使用方法](#使用方法)
     - [下載](#下載)
     - [價值投資](#得到最新一期的評價資料與歷年評價)
+        - [歷史評價](#得到指定公司的歷來評價)
     - [財務分析-重要指標](#財務分析-重要指標)
     - [月營收表](#回傳月營收表)
     - [損益表](#損益表)
     - [資產負債表](#資產負債表)
     - [現金流量表](#現金流量表)
+    - [法人交易](#法人交易)
+    - [資券餘額](#資券餘額)
     - [版本紀錄](#版本紀錄)
 
 
@@ -70,7 +73,7 @@ pip install neurostats-API
 ```Python 
 >>> import neurostats_API
 >>> print(neurostats_API.__version__)
-0.0.10
+0.0.13
 ```
 
 ### 得到最新一期的評價資料與歷年評價
@@ -79,7 +82,8 @@ from neurostats_API.utils import ValueFetcher, DBClient
 db_client = DBClient("<連接的DB位置>").get_client()
 ticker = "2330" # 換成tw50內任意ticker
 fetcher = ValueFetcher(ticker, db_client)
-data = stats_fetcher.query_data()
+
+fetcher.query_data()
 ```
 
 #### 回傳(2330為例)
@@ -114,6 +118,69 @@ data = stats_fetcher.query_data()
 ```
 > 這裡有Nan是因為本益比與P/B等資料沒有爬到最新的時間
 
+### 得到指定公司的歷來評價
+``` Python
+from neurostats_API.utils import ValueFetcher, DBClient
+db_client = DBClient("<連接的DB位置>").get_client()
+ticker = "2330" # 換成tw50內任意ticker
+fetcher = ValueFetcher(ticker, db_client)
+
+fetcher.query_value_serie()
+```
+#### 回傳(2330為例)
+```Python
+{
+'EV_EBIT':               EV_EBIT
+        2014-01-02        NaN
+        2014-01-03        NaN
+        ...               ...
+        2024-12-12  15.021431
+        2024-12-13  15.088321
+,
+'EV_OPI':                EV_OPI
+        2014-01-03        NaN
+        ...               ...
+        2024-12-12  15.999880
+        2024-12-13  16.071128
+,
+'EV_S':                 EV_S
+        2014-01-02       NaN
+        2014-01-03       NaN
+        ...              ...
+        2024-12-12  6.945457
+        2024-12-13  6.976385
+,
+'P_B':              P_B
+        2014-01-02   NaN
+        2014-01-03   NaN
+        ...          ...
+        2024-12-12  6.79
+        2024-12-13  6.89
+,
+'P_E':               P_E
+        2014-01-02    NaN
+        2014-01-03    NaN
+        ...           ...
+        2024-12-12  26.13
+        2024-12-13  26.50
+,
+'P_FCF':                 P_FCF
+        2014-01-02        NaN
+        2014-01-03        NaN
+        ...               ...
+        2024-12-12  45.302108
+        2024-12-13  45.515797
+,
+'P_S':                  P_S
+        2014-01-02       NaN
+        2014-01-03       NaN
+        ...              ...
+        2024-12-12  6.556760
+        2024-12-13  6.587688
+}
+```
+
+
 ### 回傳月營收表
 ``` Python
 from neurostats_API.fetchers import MonthRevenueFetcher, DBClient
@@ -314,7 +381,7 @@ db_client = DBClient("<連接的DB位置>").get_client()
 ticker = "2330" # 換成tw50內任意ticker
 fetcher = BalanceSheetFetcher(ticker, db_client)
 
-stats_fetcher.query_data()
+fetcher.query_data()
 ```
 
 #### 回傳
@@ -376,7 +443,7 @@ db_client = DBClient("<連接的DB位置>").get_client()
 ticker = 2330 # 換成tw50內任意ticker
 fetcher = StatsFetcher(ticker, db_client)
 
-stats_fetcher.query()
+fetcher.query()
 ```
 #### 回傳
 ```Python
@@ -425,8 +492,186 @@ stats_fetcher.query()
 
 > 大部分資料缺失是因為尚未計算，僅先填上已經有的資料
 
+## 籌碼面
+### 法人交易
+``` Python
+from neurostats_API.fetchers import InstitutionFetcher
+db_client = DBClient("<連接的DB位置>").get_client()
+ticker = 2330 # 換成tw50內任意ticker
+fetcher = StatsFetcher(ticker, db_client)
+
+fetcher.query()
+```
+### 回傳
+```Python
+{ 'annual_trading':       
+                        close      volume  ... 自營商買賣超股數(避險)   三大法人買賣超股數
+        2024-12-02  1035.000000  31168404.0  ...    -133215.0  11176252.0
+        2024-11-29   996.000000  40094983.0  ...     401044.0  -7880519.0
+        ...                 ...         ...  ...          ...         ...
+        2023-12-05   559.731873  22229723.0  ...       33,400  -5,988,621
+        2023-12-04   563.659790  26847171.0  ...     -135,991  -5,236,743
+
+,
+  'latest_trading': 
+  { 'date': datetime.datetime(2024, 12, 2, 0, 0),
+    'table':              
+            category       variable  ...  over_buy_sell   sell
+        0   foreign  average_price  ...           0.00    0.0
+        1   foreign     percentage  ...           0.00    0.0
+        ..      ...            ...  ...            ...    ...
+        14     prop          price  ...           0.00    0.0
+        15     prop          stock  ...        -133.22  217.2
+  }
+,
+  'price': 
+  { 
+        '52weeks_range': '555.8038940429688-1100.0', # str
+        'close': 1035.0, # float
+        'last_close': 996.0, # float
+        'last_open': 995.0, # float
+        'last_range': '994.0-1010.0', # str
+        'last_volume': 40094.983, # float
+        'open': 1020.0, # float
+        'range': '1015.0-1040.0', # str
+        'volume': 32238.019 # float
+  }
+}
+```
+
+- `annual_trading`: 對應一年內每日的交易量
+- `latest_trading`: 對應當日交易
+##### 欄位項目名稱
+|英文|中文對應|
+|----|-------|
+|buy|買進|
+|sell|賣出|
+|over_buy_sell|買賣超|
+
+##### category項目名稱
+|英文|中文對應|
+|----|-------|
+|foreign|外資|
+|prop|自營商|
+|mutual|投信|
+|institutional_investor|三大法人|
+
+##### variable項目名稱
+|英文|中文對應|
+|----|-------|
+|stock|股票張數|
+|price|成交金額|
+|average_price|均價|
+|percetage|佔成交比重|
+
+**成交金額以及均價因為資料沒有爬到而無法計算**
+**仍然先將這項目加入，只是數值都會是0**
+
+- `price`: 對應法人買賣頁面的今日與昨日交易價
+請注意`range`, `last_range`, `52week_range`這三個項目型態為字串，其餘為float
+
+##### 項目名稱
+|英文|中文對應|
+|----|-------|
+|open|開盤價|
+|close|收盤價|
+|range|當日範圍|
+|volume|成交張數|
+|last_open|開盤價(昨)|
+|last_close|收盤價(昨)|
+|last_range|昨日範圍|
+|last_volume|成交張數(昨)|
+|52weeks_range|52週範圍|
+
+## 資券餘額
+對應iFa.ai -> 交易資訊 -> 資券變化
+```Python
+from neurostats_API.fetchers import MarginTradingFetcher
+db_client = DBClient("<連接的DB位置>").get_client()
+ticker = 2330 # 換成tw50內任意ticker
+fetcher = MarginTradingFetcher(ticker, db_client)
+
+fetcher.query()
+```
+
+### 回傳
+```Python
+{ 'annual_margin':                   
+                        close   volume  ...  借券_次一營業日可限額  資券互抵
+        2024-12-03  1060.000000  29637.0  ...    12222.252   0.0
+        2024-12-02  1035.000000  31168.0  ...    12156.872   1.0
+        ...                 ...      ...  ...          ...   ...
+        2023-12-05   559.731873  22230.0  ...     7838.665   1.0
+        2023-12-04   563.659790  26847.0  ...     7722.725   2.0
+
+  'latest_trading': { 
+        'date': datetime.datetime(2024, 12, 3, 0, 0),
+        'margin_trading':          
+                        financing  short_selling
+        買進           761.0           34.0
+        賣出          1979.0           44.0
+        ...            ...            ...
+        次一營業日限額  6483183.0      6483183.0
+        現償             3.0           12.0
+
+
+        'security_offset': 0.0,
+        'stock_lending':           stock_lending
+                當日賣出                 10
+                當日還券                  0
+                當日調整                  0
+                當日餘額              14688
+                次一營業日可限額          12222
+  },
+  'price': { '52weeks_range': '555.8038940429688 - 1100.0',
+             'close': 1060.0,
+             'last_close': 1035.0,
+             'last_open': 1020.0,
+             'last_range': '1015.0 - 1040.0',
+             'last_volume': 31168.404,
+             'open': 1060.0,
+             'range': '1055.0 - 1065.0',
+             'volume': 29636.523}}
+```
+- `annual_trading`: 對應一年內每日的資券變化量
+- `latest_trading`: 對應當日交易
+##### 欄位項目名稱
+|英文|中文對應|
+|----|-------|
+|financing|融資|
+|short_selling|融券|
+
+- `price`: 對應法人買賣頁面的今日與昨日交易價
+##### 項目名稱
+|英文|中文對應|
+|----|-------|
+|open|開盤價|
+|close|收盤價|
+|range|當日範圍|
+|volume|成交張數|
+|last_open|開盤價(昨)|
+|last_close|收盤價(昨)|
+|last_range|昨日範圍|
+|last_volume|成交張數(昨)|
+|52weeks_range|52週範圍|
+
+請注意`range`, `last_range`, `52week_range`這三個項目型態為字串，其餘為float
 
 ## 版本紀錄
+### 0.0.13
+- value_fetcher 新增獲得一序列評價的功能
+
+### 0.0.12
+- 新增資券變化(margin trading)
+
+- 修改法人買賣(institution_trading)的query方式
+
+### 0.0.11
+- 修復財務分析的千元計算問題
+
+- 籌碼面新增法人買賣(institution_trading)
+
+- 將財報三表與月營收的資料型態與數值做轉換(%轉字串, 千元乘以1000)
 ### 0.0.10
 - 更新指標的資料型態: 單位為千元乘以1000之後回傳整數
 

neurostats_API-0.0.13/neurostats_API/__init__.py

@@ -0,0 +1 @@
+__version__='0.0.13'

{neurostats_API-0.0.11 → neurostats_API-0.0.13}/neurostats_API/fetchers/__init__.py

@@ -3,6 +3,7 @@ from .balance_sheet import BalanceSheetFetcher
 from .cash_flow import CashFlowFetcher
 from .finance_overview import FinanceOverviewFetcher
 from .institution import InstitutionFetcher
+from .margin_trading import MarginTradingFetcher
 from .month_revenue import MonthRevenueFetcher
 from .profit_lose import ProfitLoseFetcher
 from .value_invest import ValueFetcher