R 說明文件

2019-10-14 更新

R

以下文件將說明如何使用KYC R API來存取企業商務資料平台。

安裝方式

僅需要利用 R內建的 install.packages 安裝 Tejkyc install.packages("Tejkyc")

認證方式

安裝完成後,需要在您的程式前面加上
library("Tejkyc")
Tejkyc.api_key("YOURAPIKEY")

使用方式

以公司基本資料 TWN/MOEA_COMPANY為例,可直接使用 Tejkyc方法取得,範例如下
compData <- Tejkyc("TWN/MOEA_COMPANY")
                                    
提示:

若沒有提供篩選條件,會取出所有資料,建議使用下段介紹的篩選方式,加入適當的篩選條件。

資料篩選

如果需要針對欄位篩選,例如僅須取得大西洋飲料股份有限公司(35012903),請直接增加欄位篩選條件comp_ban='35012903'
compData <- Tejkyc('TWN/MOEA_COMPANY',comp_ban='35012903')
                                    
或是同時取得兩個公司資料35012903及23740225,請利用序列條件 comp_ban=c('35012903','23740225')
compData <- Tejkyc('TWN/MOEA_COMPANY',comp_ban=c('35012903','23740225'))
                                    
單次取得資料限制最多10,000筆,您可以增加 paginate=TRUE,程式將自動分次取得資料
compData <- Tejkyc('TWN/MOEA_COMPANY',comp_ban='35012903', paginate=TRUE)
                                    
提示:

系統限制單次取得最大筆數為10000筆,可使用 paginate=TRUE 參數分次取得資料,但總筆數最多為1,000,000筆。請斟酌使用篩選條件,降低筆數。

您可以針對多個欄位做篩選
compData <- Tejkyc('TWN/MOEA_COMPANY',comp_status='核准設立',equity_status='僑外資' ,paginate=TRUE)
                                    

欄位篩選

若僅需要取得單一欄位,請利用特殊參數 opts中的columns條件,例如僅須取得公司名稱欄位(comp_name)
compData <- Tejkyc('TWN/MOEA_COMPANY',opts.columns='comp_name')
                                    
或是多個欄位(comp_ban,comp_name)
compData <- Tejkyc('TWN/MOEA_COMPANY',opts.columns=c('comp_ban','comp_name'))
                                    

資料篩選運算

您可以針對資料欄位範圍篩選,例如設立日大於2018-01-01的資料
compData <- Tejkyc('TWN/MOEA_COMPANY', set_date.gt='2018-01-01', paginate=TRUE)
                                    
您可以針對資料欄位範圍篩選,例如交易日大於2018-01-01且小於2019-01-01的資料
compData <- Tejkyc('TWN/MOEA_COMPANY', set_date.gt='2018-01-01',set_date.lt='2018-01-01', paginate=TRUE)
                                    
篩選運算
詳細說明
使用範例
=
指定欄位等於指定的文字或數值
comp_ban='35012903'
gt
指定欄位大於指定的數值
set_date.gt='2018-01-01'
lt
指定欄位小於指定的數值
set_date.lt='2018-01-01'
gte
指定欄位大於或等於指定的數值
set_date.gte='2018-01-01'
lte
指定欄位小於或等於指定的數值
set_date.lte='2018-01-01'
ne
指定欄位不等於指定的數值
set_date.ne='2018-01-01'

查詢參數

參數
是否必要
詳細說明
使用範例
columns
指定需要取得的欄位,欄位名稱用逗號隔開
opts.columns=c('comp_ban','set_date','val')
per_page
指定每次取得的資料數量(上限為10000),總筆數不得超過1,000,000筆
opts.per_page=100
sort
指定排序的欄位及排序方式,採用 [欄位名稱].[排序方式]表示,排序方式有正向排序(asc)及反向排序(desc),預設為正向排序。
opts.sort='set_date.desc'
pivot
轉置表格功能,可讓資料變成欄位。目前僅支援財務相關表格
opts.pivot='true'