Skip to main content

KR Trading (Beta)

The Korean Trading API provides access to Korean-listed cash equities. It shares the same APAC base URLs as the HK API and supports order management, position tracking, account management, end-customer accounts, and market data.

Beta

Korean market support is currently in beta. IPO subscriptions, options, multileg orders, FOP transfers, and house margin are not available for the Korean market.

Paths​

Every Korea endpoint uses the /kr prefix (for example, /kr/orders/new or /kr/balances). The path selects the market, so do not send a market query or body field. Accounts, orders, positions, transactions, and WebSocket updates are resolved only within the Korea stack; use account numbers returned by GET /kr/accounts.

Order updates stream over wss://{BASE_URL}/kr/websocket.

Orders​

  • Use the six-digit Korean issue code without a market suffix, and keep it as a string so leading zeroes are preserved (for example, 005930).
  • Equity orders use security_type: CS, whole-share quantities, execution_instruction: held, and time_in_force: day. Market and limit orders are supported; price is required only for limit orders. Notional orders are not supported.
  • Opening a short position requires sell_short or sell_short_exempt and is accepted only for easy-to-borrow symbols. Use sell with position_effect: close.

Trading Sessions​

SessionTime (KST)
KR1 Opening auction08:30 – 09:00
KR2 Regular session09:00 – 15:20
KR3 Closing auction15:20 – 15:30
KR4 After-marketNot available yet

Pass trading_session_ids to restrict an order to specific sessions, or omit it to trade in every session the order is eligible for. Any supported order is accepted from 09:00 to 15:30 KST. At other times, only limit orders from a KRW account are accepted. The same window applies to modifies.

Accounts and FX​

Korean equities currently trade from KRW cash accounts only. Submit orders from a KRW account returned by GET /kr/accounts; margin accounts are rejected.

Coming soon

USD accounts are not supported yet. This includes USD-funded equity buys (AutoFX) and standalone USD/KRW FX orders (security_type: FOR). The endpoint pages describe their planned behavior as a preview:

  • A USD funding account will be paired with a KRW settlement account, identified by settlement_account_number in GET /kr/accounts.
  • A Korean equity buy submitted from the USD account will be funded by AutoFX orders created automatically. They will appear in GET /kr/orders?security_type=FOR and on the WebSocket with purpose: equity_funding and a parent_av_order_id pointing to the equity order.
  • A standalone FX order will use security_type: FOR and symbol: USD/KRW, with quantity as the USD amount.

Error Handling​

Failed HTTP requests return a JSON body with an error_code and a human-readable error_msg:

{
"error_code": "DisallowedOrderAction_Error",
"error_msg": "market is closed"
}

Use error_code for programmatic handling; the wording of error_msg can change.

error_codeHTTP statusMeaning
BasicInput_Error400A field is missing or invalid, or account_number is missing or not linked to your API key
DisallowedOrderAction_Error400The request is valid but not allowed now, for example the market is closed or the account is frozen
AccountBalancesPositions_Error400Not enough cash or shares for the order
Instrument_Error400Unknown symbol, or a symbol that cannot be traded
DataRetrieval_Error400The requested record was not found, for example an unknown order_id
Permission_Error401 / 403401: the X-API-KEY header is missing or invalid. 403: a read-only key was used for a POST
Misc_Error400 / 500400: the request body is not valid JSON or has a field of the wrong type. 500: an unexpected server error
AVInternal_Error500Internal error, for example system too busy. Check the order's status before retrying

A 503 means the service is temporarily unavailable; retry later. Order rejections that happen after an order is accepted, for example by the exchange, are not HTTP errors: they arrive as rejected WebSocket updates.

Guides​

  • Orders Acceptance: trading sessions, order types and when orders are accepted.
  • Risk Limits: order validation, buying power and common rejections.
  • EOD Files: daily balances, positions and transactions files.
  • WebSocket: connecting to /kr/websocket and handling order updates.

See Environments & Base URLs for all available endpoints across UAT and Production.

Browse the individual endpoints in the sidebar to see request/response details, parameters, and schemas. Use the server selector on each endpoint page to switch between environments.