finlab.data
finlab.data.get
下載歷史資料
請至歷史資料目錄 來獲得所有歷史資料的名稱,即可使用此函式來獲取歷史資料。
假設 save_to_storage
為 True
則,程式會自動在本地複製一份,以避免重複下載大量數據。
PARAMETER | DESCRIPTION |
---|---|
dataset |
The name of dataset.
TYPE:
|
save_to_storage |
Whether to save the dataset to storage for later use. Default is True. The argument will be removed in the future. Please use data.set_storage(FileStorage(use_cache=True)) instead.
TYPE:
|
force_download |
Whether to force download the dataset from cloud. Default is False.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
DataFrame
|
financial data |
Examples:
欲下載所有上市上櫃之收盤價歷史資料,只需要使用此函式即可:
date | 0015 | 0050 | 0051 | 0052 | 0053 |
---|---|---|---|---|---|
2007-04-23 | 9.54 | 57.85 | 32.83 | 38.4 | nan |
2007-04-24 | 9.54 | 58.1 | 32.99 | 38.65 | nan |
2007-04-25 | 9.52 | 57.6 | 32.8 | 38.59 | nan |
2007-04-26 | 9.59 | 57.7 | 32.8 | 38.6 | nan |
2007-04-27 | 9.55 | 57.5 | 32.72 | 38.4 | nan |
Note
使用 data.get
時,會預設優先下載近期資料,並與本地資料合併,以避免重複下載大量數據。
假如想要強制下載所有資料,可以在下載資料前,使用
假如想要強制使用本地資料,不額外下載,可以在下載資料前,使用Source code in finlab/data.py
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 |
|
finlab.data.indicator
支援 Talib 和 pandas_ta 上百種技術指標,計算 2000 檔股票、10年的所有資訊。
在使用這個函式前,需要安裝計算技術指標的 Packages
PARAMETER | DESCRIPTION |
---|---|
indname |
指標名稱, 以 TA-Lib 舉例,例如 SMA, STOCH, RSI 等,可以參考 talib 文件。 以 Pandas-ta 舉例,例如 supertrend, ssf 等,可以參考 Pandas-ta 文件。
TYPE:
|
adjust_price |
是否使用還原股價計算。
TYPE:
|
resample |
技術指標價格週期,ex:
TYPE:
|
market |
市場選擇,ex:
TYPE:
|
**kwargs |
技術指標的參數設定,TA-Lib 中的 RSI 為例,調整項為計算週期
TYPE:
|
建議使用者可以先參考以下範例,並且搭配 talib官方文件,就可以掌握製作技術指標的方法了。
Source code in finlab/data.py
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 |
|
finlab.data.universe
當呼叫 data.get
或是 data.indicator
時,返回產業相關類股。
PARAMETER | DESCRIPTION |
---|---|
market |
Universe market type. ex:
TYPE:
|
category |
Stock categories. ex:
TYPE:
|
Examples:
想要當鋼鐵人、航海王,可以用以下方法將這些類股一次選出來
date | 2002 | 2006 | .. | 2008 | 2009 |
---|---|---|---|---|---|
2007-04-23 | 39.65 | 38.3 | .. | 7.8 | 17.55 |
2007-04-24 | 39.85 | 38.85 | .. | 8.34 | 17.5 |
2007-04-25 | 39.25 | 38.1 | .. | 8.25 | 17.3 |
2007-04-26 | 39 | 37.85 | .. | 8.2 | 17.3 |
2007-04-27 | 38.2 | 37.2 | .. | 7.88 | 16.6 |
Source code in finlab/data.py
finlab.data.us_universe
當呼叫 data.get
或是 data.indicator
時,返回美股產業相關類股。
PARAMETER | DESCRIPTION |
---|---|
market |
Universe market type.
ex:
TYPE:
|
sector |
The sector the stock belongs to.
ex:
TYPE:
|
industry |
The industry the stock belongs to.See industry list from
TYPE:
|
exchange |
The exchange the stock belongs to.
ex:
TYPE:
|
Examples:
想選出美股普通股中的科技類股
with us_universe('Common Stock', ['Technology']):
close_subset = data.get('us_price:close')
print(close_subset)
date | AAOI | AAPL | .. | ABCO | NVDA |
---|---|---|---|---|---|
2017-01-03 | 39.65 | 38.3 | .. | 7.8 | 17.55 |
2017-01-04 | 39.85 | 38.85 | .. | 8.34 | 17.5 |
2017-01-05 | 39.25 | 38.1 | .. | 8.25 | 17.3 |
2017-01-06 | 39 | 37.85 | .. | 8.2 | 17.3 |
2017-01-09 | 38.2 | 37.2 | .. | 7.88 | 16.6 |
想選出美股特別股中的基礎原物料和能源類股
with data.us_universe('Preferred Stock', ['Basic Materials','Energy']):
close_subset = data.get('us_price:close')
print(close_subset)
date | AEUA | ALIN-PA | .. | ALIN-PB | ALIN-PE |
---|---|---|---|---|---|
2017-01-03 | 39.65 | 38.3 | .. | 7.8 | 17.55 |
2017-01-04 | 39.85 | 38.85 | .. | 8.34 | 17.5 |
2017-01-05 | 39.25 | 38.1 | .. | 8.25 | 17.3 |
2017-01-06 | 39 | 37.85 | .. | 8.2 | 17.3 |
2017-01-09 | 38.2 | 37.2 | .. | 7.88 | 16.6 |
想從美股 NASDAQ 交易所的普通股中篩選出軟體類股
with data.us_universe('Common Stock', industry='Software', exchange='NASDAQ'):
close_subset = data.get('us_price:close')
print(close_subset)
date | ACIW | ACVA | .. | ZI | ZS |
---|---|---|---|---|---|
2017-01-03 | 39.65 | 38.3 | .. | 7.8 | 17.55 |
2017-01-04 | 39.85 | 38.85 | .. | 8.34 | 17.5 |
2017-01-05 | 39.25 | 38.1 | .. | 8.25 | 17.3 |
2017-01-06 | 39 | 37.85 | .. | 8.2 | 17.3 |
2017-01-09 | 38.2 | 37.2 | .. | 7.88 | 16.6 |
檢視有哪些產業可選擇
{'Advertising Agencies',
'Aerospace & Defense',
'Agricultural Inputs',
'Airlines',
'Airports & Air Services',
'Aluminum',
...}
Source code in finlab/data.py
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 |
|
finlab.data.set_storage
設定本地端儲存歷史資料的方式
假設使用 data.get
獲取歷史資料則,在預設情況下,程式會自動在本地複製一份,以避免重複下載大量數據。
storage 就是用來儲存歷史資料的接口。我們提供兩種 storage
接口,分別是 finlab.data.CacheStorage
(預設) 以及
finlab.data.FileStorage
。前者是直接存在記憶體中,後者是存在檔案中。詳情請參考 CacheStorage
和 FileStorage
來獲得更詳細的資訊。
在預設情況下,程式會自動使用 finlab.data.FileStorage
並將重複索取之歷史資料存在作業系統預設「暫時資料夾」。
PARAMETER | DESCRIPTION |
---|---|
storage |
The interface of storage
TYPE:
|
Examples:
欲切換成以檔案方式儲存,可以用以下之方式:
可以在本地端的 ./finlab_db/price#收盤價.pickle
中,看到下載的資料,
可以使用 pickle
調閱歷史資料:
Source code in finlab/data.py
finlab.data.CacheStorage
將歷史資料儲存於快取中
Examples:
欲切換成以檔案方式儲存,可以用以下之方式:
可以直接調閱快取資料:
Source code in finlab/data.py
finlab.data.FileStorage
將歷史資料儲存於檔案中
PARAMETER | DESCRIPTION |
---|---|
path |
資料儲存的路徑
TYPE:
|
use_cache |
是否額外使用快取,將資料複製一份到記憶體中。
TYPE:
|
Examples:
欲切換成以檔案方式儲存,可以用以下之方式:
可以在本地端的 ./finlab_db/price#收盤價.pickle
中,看到下載的資料,
可以使用 pickle
調閱歷史資料:
Source code in finlab/data.py
finlab.data.get_strategies
取得已上傳量化平台的策略回傳資料。
可取得自己策略儀表板上的數據,例如每個策略的報酬率曲線、報酬率統計、夏普率、近期部位、近期換股日..., 這些數據可以用來進行多策略彙整的應用喔!
PARAMETER | DESCRIPTION |
---|---|
api_token |
若未帶入finlab模組的api_token,會自動跳出GUI頁面, 複製網頁內的api_token貼至輸入欄位即可。
TYPE:
|
Returns: (dict): strategies data Response detail:
``` py
{
strategy1:{
'asset_type': '',
'drawdown_details': {
'2015-06-04': {
'End': '2015-11-03',
'Length': 152,
'drawdown': -0.19879090089478024
},
...
},
'fee_ratio': 0.000475,
'last_trading_date': '2022-06-10',
'last_updated': 'Sun, 03 Jul 2022 12:02:27 GMT',
'ndays_return': {
'1': -0.01132480035770611,
'10': -0.0014737286933147464,
'20': -0.06658015749110646,
'5': -0.002292995729485159,
'60': -0.010108700314771735
},
'next_trading_date': '2022-06-10',
'positions': {
'1413 宏洲': {
'entry_date': '2022-05-10',
'entry_price': 10.05,
'exit_date': '',
'next_weight': 0.1,
'return': -0.010945273631840613,
'status': '買進',
'weight': 0.1479332345384493
},
'last_updated': 'Sun, 03 Jul 2022 12:02:27 GMT',
'next_trading_date': '2022-06-10',
'trade_at': 'open',
'update_date': '2022-06-10'
},
'return_table': {
'2014': {
'Apr': 0.0,
'Aug': 0.06315180932606546,
'Dec': 0.0537589857541485,
'Feb': 0.0,
'Jan': 0.0,
'Jul': 0.02937490104459939,
'Jun': 0.01367930162104769,
'Mar': 0.0,
'May': 0.0,
'Nov': -0.0014734320286596825,
'Oct': -0.045082529665408266,
'Sep': 0.04630906972509852,
'YTD': 0.16626214846456966
},
...
},
'returns': {
'time': [
'2014-06-10',
'2014-06-11',
'2014-06-12',
...
],
'value': [
100,
99.9,
100.2,
...
]
},
'stats': {
'avg_down_month': -0.03304015302646822,
'avg_drawdown': -0.0238021414698247,
'avg_drawdown_days': 19.77952755905512,
'avg_up_month': 0.05293384465715908,
'cagr': 0.33236021285588846,
'calmar': 1.65261094975066,
'daily_kurt': 4.008888367138843,
'daily_mean': 0.3090784769257415,
'daily_sharpe': 1.747909002374217,
'daily_skew': -0.6966018726321078,
'daily_sortino': 2.8300677082214034,
...
},
'tax_ratio': 0.003,
'trade_at': 'open',
'update_date': '2022-06-10'
},
strategy2:{...},
...}
```
Source code in finlab/data.py
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 |
|
finlab.data.search
查詢與取得資料庫目錄資訊。
查詢FinLab資料庫目錄中的資料表名稱或項目欄位名稱是否包含關鍵字,方便搜尋資料庫是否存在目標資料。
PARAMETER | DESCRIPTION |
---|---|
keyword |
欲查詢關鍵字。
TYPE:
|
display_info |
指定顯示的資訊項目,預設只顯示「資料表英文代稱、資料表的中文描述、資料表欄位名稱」,若設定為None,則顯示全部資訊。
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
list
|
database information |
Response detail
[{'name': 'financial_statement',
'description': '財報',
'items': {'存貨': {'type': 'float', 'description': '資產負債表(仟元)'},
'存貨_增加_減少': {'type': 'float', 'description': '單季現金流量表(仟元)'}}},
{'name': 'fundamental_features',
'description': '財務指標',
'items': {'存貨週轉率': {'type': 'float', 'description': '(%)'}}},...]
Examples:
# 查詢各資料表的欄位名稱含有'存貨'關鍵字資料表的基本資訊
ex1 = data.search(keyword='存貨')
# 取得含有'存貨'關鍵字相關資料表的所有資訊
ex2 = data.search(keyword='存貨', display_info=None)
Source code in finlab/data.py
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 |
|