BOTapi is R package to help R users to batch Thai economics and financial data from Bank of Thailand via API.
BOTapi does not appear on CRAN reposity yet so you need to install by the remotes package. First, install remotes package,
install.packages("remotes")
library(remotes)Then you can install BOTapi by the following line,
remotes::install_github('QuantFILab/BOTapi')First of all, you need to regist an account on the offical BOT API webpage here. Then you can submit a request to access the APIs which can be accessed for free here. You need to send requests for all APIs catagories (seven) to use all functions in BOTapi. You will obatain the Client ID on your account dashboard at App menu. Bank of Thailand allows as to access more than 500 data sereis that will benafit from our research and bussiness analystic.
To be easy to use the functions inside the package, you should set variable of Client ID, such as
id <- 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx'You can see the instruction of using in the function information by inputing to console ? function_name, such as
? get.observeIf the package requires some missing functions, please install dependent packages
library(httr)
library(jsonlite)List of data catagories and series for statistics can be found here
List of Functions are shown below.
| Function | Detail | Link to Official Document |
|---|---|---|
| get.product | get list of financial product for comparison | here |
| get.observe | get statistics by input data series | here |
| search.stat | search data series by keyword | here |
| get.category.list | get list of allc ategories and codes | here |
| get.series.list | get list of all series and codes by given catagory | here |
| get.exg.rate | get list of weighted-average international bank exchange rate | here |
| get.avg.exg.rate | get list of average exchange rate - THB / Foreign Currency | here |
| get.ext.rates | get list of series of external interest rates | here |
| get.tbimplied.rates | get list of series of Thai Baht implied interest rates | here |
| get.spot.rates | get list of series of spot rate in USD/THB | here |
| get.swap.rates | get list of series of swap point - onshore in Satangs | here |
| get.inter.tran.rates | get list of series of International bank transaction rates | here |
| get.policy.rate | get current policy rate | here |
| get.bibor.rates | get list of series of Bangkok international bank offered rate | here |
| get.deposit.rates | get list of series of deposit interest rates for individuals of commercial banks | here |
| get.loan.rates | get list of series of loan interest rates of commercial banks (percent per annum) | here |
| get.debt.sec | get list of series of debt securities auction result | here |
| get.holiday | get list of series of financial institutions' holidays in given year | here |
library(BOTapi)
#Setting your ID Client
id <- 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx'
#Setting start date of batching data
start_period <- "2020-01-01"
#sSetting sereis code of the data set "Land monthly price index : Bangkok and vicinities"
series_code <- "EIRPPIM00080"
#Getting list of Data and its information
land <- get.observe(id,series_code ,start_period)
#Checking data unit
land$unit_eng
#Checking last updating
land$last_update_date
#Accessing data
land$observations
#Accessing individual data (in case of multiple results)
land$observations[[1]]
land$observations[[2]]