Python 說明文件 - 2020-01-10 更新 -
Python使用設定
以下文件將說明如何使用TEJ Python API來存取TEJ 資料庫。
安裝方式
僅需要利用 pip 安裝 tejapi
pip install tejapi
認證方式
安裝完成後,需要在您的程式前面加上
import tejapi
tejapi.ApiConfig.api_key = "YOURAPIKEY"
取得使用資訊
利用 tejapi.ApiConfig.info() 可取得各類使用資訊
import tejapi
tejapi.ApiConfig.api_key = "YOURAPIKEY"
info = tejapi.ApiConfig.info()
回應資訊說明
查詢資料
以下將說明如何使用TEJ Python API查詢資料。
使用方式
以上市(櫃)未調整股價(日) TWN/APRCD為例,可直接使用 tejapi.get()方法取得,範例如下
data = tejapi.get('TWN/APRCD')
提示:
若沒有提供篩選條件,會取出所有資料,建議使用下段介紹的篩選方式,加入適當的篩選條件。
資料篩選
如果需要針對欄位篩選,例如僅須取得台灣加權股價指數(Y9999),請直接增加欄位篩選條件 coid='Y9999'
data = tejapi.get('TWN/APRCD',coid='Y9999')
或是同時取得兩種指數資料Y9999及Y9998,請利用序列條件 coid=['Y9999','Y9998']
data = tejapi.get('TWN/APRCD',coid=['Y9999','Y9998'])
單次取得資料限制最多10,000筆,您可以增加 paginate=True,程式將自動分次取得資料
data = tejapi.get('TWN/APRCD',coid='Y9999', paginate=True)
提示:
系統限制單次取得最大筆數為10000筆,可使用 paginate=True 參數分次取得資料,但總筆數最多為1,000,000筆。請斟酌使用篩選條件,降低筆數。
您可以針對多個欄位做篩選
data = tejapi.get('TWN/APRCD',coid='Y9999', mdate='2018-01-20' ,paginate=True)
欄位篩選
若僅需要取得單一欄位,請利用特殊參數 opts中的columns條件,例如僅須取得開盤價欄位(open_d)
data = tejapi.get('TWN/APRCD',opts={'columns':'open_d'})
或是多個欄位(mdate,open_d)
data = tejapi.get('TWN/APRCD',opts={'columns':['mdate','open_d']})
資料篩選運算
您可以針對資料欄位範圍篩選,例如交易日大於2018-01-01的資料
data = tejapi.get('TWN/APRCD',coid='Y9999', mdate={'gt':'2018-01-01'}, paginate=True)
您可以針對資料欄位範圍篩選,例如交易日大於2018-01-01且小於2018-02-01的資料
data = tejapi.get('TWN/APRCD',coid='Y9999', mdate={'gt':'2018-01-01','lt':'2018-02-01'}, paginate=True)
查詢參數
其他參數
表格資訊
以下文件將說明如何取得表格資訊。
使用方法
import tejapi
tejapi.ApiConfig.api_key = "YOURAPIKEY"
table_info = tejapi.table_info('TWN/APRCD')
回應資訊說明
搜尋表格
以下文件將說明利用關鍵字搜尋表格。
使用方法
import tejapi
tejapi.ApiConfig.api_key = "YOURAPIKEY"
search = tejapi.search_table("關鍵字")