Skip to main content

Python SDK for Korean securities market data and trading

Project description

kxt — Korean Securities Market Access SDK for Python

PyPI Python License: MIT

kxt is an async, library-first Python SDK for Korean securities market access. It provides broker-neutral request and response models with current KIS and Toss Invest provider clients. Documentation is written in Korean and published at https://pumpkinredbean.github.io/kxt/.


kxt는 한국 증권시장 접근을 비동기 파이썬으로 다루기 위한 라이브러리 우선 SDK입니다. 브로커 중립 요청·응답 DTO를 중심에 두고, 현재 구현 상태로 KIS와 Toss Invest 프로바이더 클라이언트를 제공합니다.

Audience

  • 파이썬으로 KRX 데이터를 수집하거나 자동매매 코드를 작성하는 개발자
  • ccxt 계열의 브로커 중립 인터페이스를 한국 시장에서 찾는 사용자
  • 라이브러리 우선(runtime-free) SDK를 선호하는 사용자

Key features

  • 비동기 전용async/await 기반, 이벤트 루프 친화적
  • 브로커 중립 DTOTrade, Bar, OrderBookSnapshot 등 정규화된 응답 타입 (입력은 종목 코드 문자열)
  • 시세·주문·스트림get_bars, get_quote, submit_order, stream_trades 등 flat 메서드. Toss Invest는 최대 200개 batch quote를 지원하고, 스트리밍은 현재 KIS만 지원합니다.
  • 얇은 CLI — 동일한 코드 경로를 kxt bars, kxt quote 같은 명령으로 호출

Import policy

  • from kxt import ...KISClient, TossInvestClient, 응답·이벤트 DTO, enum, 에러 등 사용자가 읽는 타입.
  • from kxt.requests import ...BarsRequest, SubmitOrderRequest, *Cursor, *Subscription, OrderInstruction, OrderAmendment, ProviderRef 같은 power-user 입력 DTO. 일반 호출은 primitive(symbol 문자열, kwargs)만으로 충분합니다.
  • from kxt.models import ... — 모든 DTO를 통째로 introspection할 때.

Install

pip install kxt

최신 공개 릴리스가 설치됩니다.

Quick start

import asyncio
from datetime import date, timedelta

from kxt import KISClient


async def main() -> None:
    async with KISClient(
        app_key="<APP_KEY>",
        app_secret="<APP_SECRET>",
    ) as client:
        today = date.today()
        response = await client.get_bars(
            "005930",  # 삼성전자
            timeframe="day",
            start=today - timedelta(days=14),
            end=today,
        )
        for bar in response.bars[-5:]:
            print(bar.opened_at.date(), bar.close)


asyncio.run(main())

<APP_KEY> / <APP_SECRET>은 본인의 KIS OpenAPI 자격증명으로 대체하세요. SDK는 환경변수에 관여하지 않습니다. 환경변수 기반 흐름은 CLI에서만 사용합니다.

Toss Invest를 사용할 때는 TossInvestClient(client_id="...", client_secret="...")를 사용합니다. 계좌·주문 메서드는 account_seq가 필요합니다.

Documentation

전체 한국어 문서: https://pumpkinredbean.github.io/kxt/

로컬에서 빌드하려면:

uv sync --all-extras
uv run pytest
uv run mkdocs serve
uv build

Status

현재 0.x 릴리스 단계입니다. 공개 API는 1.0 이전까지 변경될 수 있습니다. 실거래 전에 반드시 소량으로 검증하세요.

License

MIT. LICENSE 참조.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kxt-0.2.0.tar.gz (101.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kxt-0.2.0-py3-none-any.whl (100.7 kB view details)

Uploaded Python 3

File details

Details for the file kxt-0.2.0.tar.gz.

File metadata

  • Download URL: kxt-0.2.0.tar.gz
  • Upload date:
  • Size: 101.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kxt-0.2.0.tar.gz
Algorithm Hash digest
SHA256 259f49cd302d3ce3823c2e7b0173bcf0911712c098a96ce8bf1fb2a3162c7251
MD5 d99d8944e2703c072438857fc3ab33dc
BLAKE2b-256 cd27128e46fbfcc1f6a5928e7a82f1f3c1e7077616153e244d9eba057876dce7

See more details on using hashes here.

Provenance

The following attestation bundles were made for kxt-0.2.0.tar.gz:

Publisher: publish.yml on pumpkinredbean/kxt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kxt-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: kxt-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 100.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kxt-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b3b1c45e08e702169472ed904ee09f84b104092ff04a0a85f50701f20d1a8e0
MD5 854134336817fac904034db42dc238e7
BLAKE2b-256 d00c5d340c5c8240c10b20aad9f447aa54c9e0c03beab99c59b259c7b2499d35

See more details on using hashes here.

Provenance

The following attestation bundles were made for kxt-0.2.0-py3-none-any.whl:

Publisher: publish.yml on pumpkinredbean/kxt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page