Skip to main content
Version: 0.7

Atomic Vaults Trading API (APAC)

This APAC API includes Hong Kong and Korean cash-equity support. Select the HK or KR example tab on the shared order endpoints for market-specific payloads.

Market availability​

The cash-equity order, balance, position, transaction, end-customer-account, security-list, and WebSocket endpoints support both HK and KR unless an operation is explicitly marked HK only. The following integrations are currently Hong Kong only:

  • IPO listing, subscription, cancellation, and venue detail: GET /ipos, POST /orders/new/ipo, POST /orders/cancel/ipo, and GET /orders/ipo/status
  • House margin: GET /house-margin-details

Korean options, multileg orders, and IPO subscriptions are not supported. Automatic USD/KRW orders are a Korea-only system workflow; clients cannot submit, cancel, or modify them directly.

Hong Kong (HK)​

Korea (KR) — Beta​

Use the six-digit KRX issue code without a market suffix and keep it as a string so leading zeroes are preserved (for example, 005930). Korean equity orders use security_type: CS, whole shares, execution_instruction: held, and Day time in force. Market and limit orders are supported; price is required only for limit orders.

Korean accounts and settlement​

Korean equities can be traded directly from a KRW cash account. When USD funding is enabled, two linked accounts are provided:

AccountPurpose
USD funding accountSupplies USD for Korean equity buys and is used for automatic funding orders.
KRW settlement accountHolds KRW cash, Korean equity positions, and sale proceeds.

GET /accounts returns each account's market and currency. For a linked USD account, settlement_account_number identifies its KRW account. Balances remain separate by account and currency; they are not combined in API responses.

Korean order flow​

  • A buy submitted on the KRW account follows the normal equity lifecycle and uses the available KRW balance.
  • A buy submitted on the linked USD account automatically creates the required USD-to-KRW funding order. The equity order proceeds when the required KRW is available.
  • The equity and funding order have separate updates. Funding orders use security_type: FOR, purpose: equity_funding, and parent_av_order_id to identify the related equity order. Clients observe these updates but do not submit, cancel, or modify automatic funding orders.
  • A Korean sell uses the position in the KRW settlement account and credits the proceeds there. There is no automatic KRW-to-USD conversion.

Use the account originally supplied with an equity order when querying, canceling, or modifying that order. Query the linked KRW account for the resulting Korean position and KRW balance activity.

Error handling​

Failed HTTP requests return error_code and a human-readable error_msg. Use error_code for programmatic handling; the wording of error_msg can change.

Authentication​

Security Scheme Type:

apiKey

Header parameter name:

X-API-KEY