kisopenapi: Korea Investment & Securities (KIS) Open Trading API

Description

This package allows users to easily access various financial services using the trading open API provided by Korea Investment & Securities (KIS).
the KIS open API provides request/reponse information and error messages.
To use this package, you will first need to open a Korea investment & securities account, and get your app key and app secret from the website https://apiportal.koreainvestment.com/.
Once you have your app key and app secret, you can save those as environment variables for the current session using the set_trading_env functions.
Alternatively, you can set those permanently by adding the following line to your .Renviron file:

For real trading

KIS_CANO="YOUR ACCOUNT NUMBER" (your account)
KIS_ACNT_PRDT_CD="01" (your account product code, mainly 01)
KIS_APP_KEY="YOUR APP KEY"
KIS_APP_SECRET="YOUR APP SECRET"

For paper trading

KIS_PAPER_CANO="YOUR PAPER ACCOUNT NUMBER" (your paper account)
KIS_PAPER_ACNT_PRDT_CD="01" (your paper account product code mainly 01)
KIS_PAPER_APP_KEY="YOUR PAPER APP KEY"
KIS_PAPER_APP_SECRET="YOUR PAPER APP SECRET"

Any functions that require your environemt variables try to retrieve those via

Sys.getenv("KIS_CANO")
Sys.getenv("KIS_ACNT_PRDT_CD")
Sys.getenv("KIS_APP_KEY")
Sys.getenv("KIS_APP_SECRET")
Sys.getenv("KIS_PAPER_CANO")
Sys.getenv("KIS_PAPER_ACNT_PRDT_CD")
Sys.getenv("KIS_PAPER_APP_KEY")
Sys.getenv("KIS_PAPER_APP_SECRET")

unless account number, account product code, app key and app secret are explicitly specified as function arguments. and if you've already registered both trading environment variables(live and paper), you can easily change the environment and use the same functions.

Author(s)

Maintainer: Seokhoon Joo seokhoonj@gmail.com

change trading environment

Description

if you wrote live trading and paper trading evironment variables both in your .Renviron file, you can change trading environment.

Usage

change_trading_env()

Value

"live" or "paper" string value

Examples

## Not run: change_trading_environment()

get account balance

Description

Get your account balance.

Usage

get_balance(prdt_code, rt_cash_flag = FALSE)

Arguments

Value

balance data.frame

Examples

## get account balance
## Not run: 
# detail
get_balance(rt_cash_flag = FALSE)
# total deposit
get_balance(rt_cash_flag = TRUE)
## End(Not run)

get buyable cash

Description

Get buyable amount of cash of the account

Usage

get_buyable_cash(prdt_code)

Arguments

Value

A numeric specifying buyable cash

Examples

# get buyable cash
## Not run: 
get_buyable_cash()

## End(Not run)

get current price

Description

Get current stock price.

Usage

get_current_price(stock_code)

Arguments

Value

current stock price

Examples

# get current price
## Not run: 
get_current_price("005930")

## End(Not run)

get order history

Description

Get order history from start date to end date.

Usage

get_order_history(sdt, edt, prdt_code, zip_flag = TRUE)

Arguments

Value

Order history data frame

Examples

# get order history
## Not run: 
get_order_history("20")

## End(Not run)

get orders

Description

Return a list of orders that can be revised or canceled.

Usage

get_orders()

Value

data.frame of orders

Examples

# get a list of orders
## Not run: 
get_orders()

## End(Not run)

get stock history

Description

Get stock history.

Usage

get_stock_history(stock_code, unit = c("D", "W", "M"))

Arguments

Value

stock history data frame

Examples

# get stock history
## Not run: 
get_stock_history("005930")

## End(Not run)

get stock history by ohlcv

Description

Get stock history by open, high, low, close, volume.

Usage

get_stock_history_by_ohlcv(stock_code, unit = "D", add_var = FALSE)

Arguments

Value

stock history by ohlcv data frame

Examples

# get stock history
## Not run: 
get_stock_history_by_ohlcv("005930")

## End(Not run)

get stock investor

Description

Get stock investor data using KIS API.

Usage

get_stock_investor(stock_code)

Arguments

Value

stock investor data frame

Examples

# get stock investor
## Not run: 
get_stock_investor("005930")

## End(Not run)

get stock quotes

Description

Get current stock qutoes.

Usage

get_stock_quotes(stock_code)

Arguments

Value

current stock quotes data frame

Examples

# get stock quotes
## Not run: 
get_stock_quotes("005930")

## End(Not run)

KIS order

Description

Order stocks.

Usage

kis_order(
  stock_code,
  order_qty,
  order_price,
  prdt_code,
  order_type = "00",
  buy_flag = TRUE
)

kis_buy(stock_code, order_qty, order_price, prdt_code, order_type = "00")

kis_sell(stock_code, order_qty, order_price, prdt_code, order_type = "00")

Arguments

Value

A list contains rt_cd: return code, msg_cd: message code, msg1: message

An order result

Examples

## Not run: 
## buy
kis_buy(
  stock_code = "stock code",
  order_qty = "your order quantity",
  order_price = "your order price"
)
## sell
kis_sell(
  stock_code = "stock code",
  order_qty = "your order quantity",
  order_price = "your order price"
)

## End(Not run)

KIS revise and cancel orders

Description

Revise and cancel orders.

Usage

kis_revise_cancel(
  order_no,
  order_branch,
  order_qty,
  order_price,
  prdt_code,
  order_dv = "00",
  cncl_dv = c("01", "02"),
  qty_all_yn = c("Y", "N")
)

kis_revise(
  order_no,
  order_branch,
  order_qty,
  order_price,
  prdt_code,
  order_dv = "00",
  cncl_dv = "01",
  qty_all_yn = c("Y", "N")
)

kis_cancel(
  order_no,
  order_branch,
  order_qty,
  order_price,
  prdt_code,
  order_dv = "00",
  cncl_dv = "02",
  qty_all_yn = c("Y", "N")
)

kis_cancel_all()

Arguments

Value

A list contains rt_cd: return code, msg_cd: message code, msg1: message

response

Examples

## revise
## Not run: 
kis_revise(
  order_no = "your order number",
  order_branch = "your order branch", order_qty = "your order quantity",
  order_price = "your order price"
)

## End(Not run)
## cancel
## Not run: 
kis_cancel(
  order_no = "your order number",
  order_branch = "your order branch", order_qty = "your order quantity",
  order_price = "your order price"
)

## End(Not run)
## cancel all
## Not run: 
kis_cancel_all()

## End(Not run)

print account product code

Description

Print your account product code in the current trading environemnt. it changes depending on the trading environment.

Usage

print_acnt_prdt_cd()

Value

account product code

Examples

## Not run: print_acnt_prdt_cd()

print app key

Description

Print your app key in the current trading environemnt. it changes depending on the trading environment.

Usage

print_app_key()

Value

app key

Examples

## Not run: print_app_key()

print app secret

Description

Print your app secret in the current trading environemnt. it changes depending on the trading environment.

Usage

print_app_secret()

Value

app secret

Examples

## Not run: print_app_secret()

print base url

Description

Print your base url in the current trading environemnt. it changes depending on the trading environment.

Usage

print_base_url()

Value

base url of current trading environment

Examples

## Not run: print_base_url()

print account number

Description

Print your account number in the current trading environemnt. it changes depending on the trading environment.

Usage

print_cano()

Value

account number

Examples

## Not run: print_cano()

print trading environment

Description

Print the current trading environment.

Usage

print_trading_env()

Value

"live" or "paper" string value

Examples

## Not run: print_trading_env()

set access token

Description

Set access token (hash key) using kis app key and kis app secret.

Usage

set_auth()

get_auth()

print_auth()

Value

An access token (access token is stored in environment variable at the same time)

Examples

# set authentification
## Not run: 
set_auth()

## End(Not run)

Set KIS account number, account product code, app key and app secret

Description

Save environment variables for the current session. To set it permanently,
please add the following line to your .Renvrion file:

Usage

set_trading_env(cano, acnt_prdt_cd, app_key, app_secret, is_paper = FALSE)

Arguments

Value

No return value, called to set environment variables

For live trading

KIS_CANO="YOUR ACCOUNT NUMBER" (first 8 digits of your account)
KIS_ACNT_PRDT_CD="01" (last 2 digits of your account)
KIS_APP_KEY="YOUR APP KEY"
KIS_APP_SECRET="YOUR APP SECRET"

For paper trading

KIS_PAPER_CANO="YOUR PAPER ACCOUNT NUMBER" (first 8 digits of your paper account)
KIS_PAPER_ACNT_PRDT_CD="01" (last 2 digits of your paper account)
KIS_PAPER_APP_KEY="YOUR PAPER APP KEY"
KIS_PAPER_APP_SECRET="YOUR PAPER APP SECRET"

Examples

## Set app key for the current session
## Not run: 
## Set trading environment only for the current session
set_trading_env(
  cano = "your account number",
  acnt_prdt_no = "your account product code",
  app_key = "your app key",
  app_secret = "your app secret"
)
## Check environment variables
print_cano()
print_acnt_prdt_cd()
print_app_key()
print_app_secret()
## End(Not run)