Documentation
¶
Overview ¶
Package krbrokapi provides a unified gateway for Korean securities broker APIs.
korea-securities-api abstracts away the differences between Korean broker REST APIs (KIS, Kiwoom, LS, etc.) behind a single, consistent interface. It can be used as a standalone HTTP server or embedded as a Go library.
Standalone server ¶
make build && ./bin/kr-broker -config config.yaml
Library usage ¶
Import github.com/smallfish06/korea-securities-api/pkg/broker for the common interface and types, and github.com/smallfish06/korea-securities-api/pkg/server to spin up an HTTP server with your own broker implementations.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
kr-broker
command
|
|
|
examples
|
|
|
all-balances
command
|
|
|
custom-broker-server
command
|
|
|
kis-balance
command
|
|
|
kiwoom-balance
command
|
|
|
internal
|
|
|
pkg
|
|
|
broker
Package broker defines the common interface and types shared across all broker adapters.
|
Package broker defines the common interface and types shared across all broker adapters. |
|
server
Package server provides a ready-to-use HTTP API server that can be wired with any github.com/smallfish06/korea-securities-api/pkg/broker.Broker implementation.
|
Package server provides a ready-to-use HTTP API server that can be wired with any github.com/smallfish06/korea-securities-api/pkg/broker.Broker implementation. |
Click to show internal directories.
Click to hide internal directories.