python-kis

The project provides a comprehensive set of tutorials organized by functional area:

1. Authentication Management: Secret key management and access token management.
2. Stock Quotes and Charts: Price quotes, charts, order books (quotes), and market operating hours.
3. Orders and Balance Inquiry: Deposit/balance, realized profit/loss, daily execution history, buy/sell availability, pending orders, and order execution/correction/cancellation.
4. Real-time Event Reception: Real-time price, order book (quotes), and execution history.

It is recommended to manage your credentials using the KisAuth object and saving them to a file to avoid hardcoding sensitive information.

1. Create a KisAuth instance with your HTS ID, App Key, App Secret, and Account number.
2. Use auth.save("filename.json") to store the credentials securely.
3. Load them later using KisAuth.load("filename.json") or pass the filename directly to PyKis.

from pykis import KisAuth

auth = KisAuth(
    id="YOUR_HTS_ID",
    appkey="YOUR_APP_KEY",
    secretkey="YOUR_APP_SECRET",
    account="00000000-01",
    virtual=False,
)

# Save to a file
auth.save("secret.json")

# Later, load and use
from pykis import PyKis
kis = PyKis(KisAuth.load("secret.json"), keep_token=True)

Install the library using pip. The library is designed for Python 3.11+.

Required dependencies include requests, websocket-client, cryptography, and colorlog.

pip install python-kis

To receive real-time price updates for domestic or overseas stocks, use the .on("price", callback) method on a stock object. The callback function receives a KisSubscriptionEventArgs containing a KisRealtimePrice object in its response field.

To stop receiving updates, call .unsubscribe() on the ticket returned by the .on() method.

from pykis import KisRealtimePrice, KisSubscriptionEventArgs, KisWebsocketClient, PyKis

def on_price(sender: KisWebsocketClient, e: KisSubscriptionEventArgs[KisRealtimePrice]):
    print(e.response)

# Assuming 'hynix' is a stock object and 'kis' is the PyKis instance
ticket = hynix.on("price", on_price)

print(kis.websocket.subscriptions) # View currently subscribed events

input("Press Enter to exit...")

ticket.unsubscribe()

You can iterate through all pending orders in an account using the pending_orders() method and call .cancel() on each order object to cancel them all.

# 미체결 주문 전체 취소
for order in account.pending_orders():
    order.cancel()

Use account.balance() to retrieve your deposits (KRW, USD, etc.) and your current stock holdings.

from pykis import KisBalance

# Access the main account
account = kis.account()

# Retrieve balance and holdings
balance: KisBalance = account.balance()

print(repr(balance))

Use the stock.quote() method on a stock object to retrieve real-time market data (price, volume, indicators, etc.).

• stock.quote(): Standard quote.
• stock.quote(extended=True): Retrieves extended market/day-trading quotes.

from pykis import KisQuote

# Get a stock object (e.g., NVIDIA)
stock = kis.stock("NVDA")

# Get standard quote
quote: KisQuote = stock.quote()

# Get extended/day-trading quote
quote: KisQuote = stock.quote(extended=True)

print(quote)