提示:
若沒有提供篩選條件，會取出所有資料，建議使用下段介紹的篩選方式，加入適當的篩選條件。
以下文件將說明如何使用TEJ R API來存取TEJ 資料庫。
僅需要利用 R內建的 install.packages 安裝 tejapi
install.packages("Tejapi")
安裝完成後，需要在您的程式前面加上
library("Tejapi")
Tejapi.api_key("YOURAPIKEY")以上市(櫃)未調整股價(日) TWN/APRCD為例，可直接使用 Tejapi方法取得，範例如下
priceData <- Tejapi("TWN/APRCD")
若沒有提供篩選條件，會取出所有資料，建議使用下段介紹的篩選方式，加入適當的篩選條件。
如果需要針對欄位篩選，例如僅須取得台灣加權股價指數(Y9999)，請直接增加欄位篩選條件 coid=Y9999
priceData <- Tejapi('TWN/APRCD',coid='Y9999')
或是同時取得兩種指數資料Y9999及Y9998，請利用序列條件 coid=c('Y9999','Y9998')
priceData <- Tejapi('TWN/APRCD',coid=c('Y9999','Y9998'))
單次取得資料限制最多10,000筆，您可以增加 paginate=TRUE，程式將自動分次取得資料
priceData <- Tejapi('TWN/APRCD',coid='Y9999', paginate=TRUE)
系統限制單次取得最大筆數為10000筆，可使用 paginate=TRUE 參數分次取得資料，但總筆數最多為1,000,000筆。請斟酌使用篩選條件，降低筆數。
您可以針對多個欄位做篩選
priceData <- Tejapi('TWN/APRCD',coid='Y9999', mdate='2018-01-20' ,paginate=TRUE)
若僅需要取得單一欄位，請利用特殊參數 opts中的columns條件，例如僅須取得開盤價欄位(open_d)
priceData <- Tejapi('TWN/APRCD',opts.columns='open_d')
或是多個欄位(mdate,open_d)
priceData <- Tejapi('TWN/APRCD',opts.columns=c('mdate','open_d'))
您可以針對資料欄位範圍篩選，例如交易日大於2018-01-01的資料
priceData <- Tejapi('TWN/APRCD',coid='Y9999', mdate.gt='2018-01-01', paginate=TRUE)
您可以針對資料欄位範圍篩選，例如交易日大於2018-01-01且小於2018-02-01的資料
priceData <- Tejapi('TWN/APRCD',coid='Y9999', mdate.gt='2018-01-01',mdate.lt='2018-02-01', paginate=TRUE)
| 篩選運算 | 詳細說明 | 使用範例 |
|---|---|---|
| = | 指定欄位等於指定的文字或數值 | coid='Y9999' |
| gt | 指定欄位大於指定的數值 | mdate.gt='2018-01-01' |
| lt | 指定欄位小於指定的數值 | mdate.lt='2018-01-01' |
| gte | 指定欄位大於或等於指定的數值 | mdate.gte='2018-01-01' |
| lte | 指定欄位小於或等於指定的數值 | mdate.lte='2018-01-01' |
| ne | 指定欄位不等於指定的數值 | mdate.ne='2018-01-01' |
| 參數 | 是否必要 | 詳細說明 | 使用範例 |
|---|---|---|---|
| columns | 否 | 指定需要取得的欄位，欄位名稱用逗號隔開 | opts.columns=c('coid','mdate','val') |
| per_page | 否 | 指定每次取得的資料數量(上限為10000)，總筆數不得超過1,000,000筆 | opts.per_page=100 |
| sort | 否 | 指定排序的欄位及排序方式，採用 [欄位名稱].[排序方式]表示，排序方式有正向排序(asc)及反向排序(desc)，預設為正向排序。 | opts.sort='mdate.desc' |
| pivot | 否 | 轉置表格功能，可讓資料變成欄位。目前僅支援財務相關表格 | opts.pivot='true' |