Korbit Other API
The Other API from Korbit — 8 operation(s) for other.
OpenAPI Specification
openapi: 3.1.0
info:
title: Korbit Open API v2 Asset Other API
version: 2.0.0
description: 'REST API for the Korbit cryptocurrency exchange (Korea''s first virtual-asset exchange). Covers market data (quotation), trading, balances, crypto deposits and withdrawals, and KRW deposit/withdrawal push notifications.
All responses use the envelope `{"success": true, "data": ...}`; errors use `{"success": false, "error": {"message": "<CODE>"}}`.
Private endpoints require the `X-KAPI-KEY` header plus `timestamp` and `signature` parameters. Signatures are HMAC-SHA256 (hex) or ED25519 (Base64, URL-encoded) over the exact encoded request string. See the timestamp-window rules: `recvWindow` defaults to 5000 ms, maximum 60000 ms, and the future bound is a fixed +1000 ms.
This document was generated by the API Evangelist enrichment pipeline from Korbit''s own published agent documentation bundle (https://docs.korbit.co.kr/llms-full.txt). Korbit does not publish an OpenAPI document; this is a faithful transcription of the published reference, not an official artifact.'
contact:
name: Korbit Developers
url: https://developers.korbit.co.kr
x-generated-by: API Evangelist enrichment pipeline
x-source: https://docs.korbit.co.kr/llms-full.txt
servers:
- url: https://api.korbit.co.kr
description: Production
- url: http://127.0.0.1:9999
description: Local sandbox (korbit-sandbox.mjs) — mock, not the production server
tags:
- name: Other
paths:
/v2/coin/recentDeposits:
get:
operationId: getCoinRecentDeposits
summary: Get Recent Deposits
description: Get recent deposit history.
tags:
- Other
parameters:
- name: accountSeq
in: query
description: Account sequence number. Deposit/withdrawal APIs only operate on the main account, so only `1` is accepted. Defaults to 1.
schema:
type: number
examples:
- 1
- name: currency
in: query
required: true
description: symbol of the asset.
schema:
type: string
examples:
- btc
- name: limit
in: query
description: 'Maximum number of queries (range: 1 to 100).'
schema:
type: number
examples:
- 100
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
examples:
- true
data:
type: array
items:
type: object
properties:
id:
type: number
description: deposit ID.
examples:
- 1234
network:
type: string
description: symbol of the blockchain network.
examples:
- ETH
address:
type: string
description: deposit address.
examples:
- 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa
secondaryAddress:
type: string
description: secondary address (destination tag, memo, etc. if none, then null.)
status:
type: string
enum:
- pending
- actionRequired
- reviewing
- done
- refunded
- failed
description: deposit status `pending` — Deposit transaction is detected on the network. / `actionRequired` — Pending deposit documentation submission. To process the deposit, please submit the required documents for approval on the Korbit website. / `reviewing` — Deposit documentation reviewing. / `done` — Deposit done. / `refunded` — Deposit amount returned after review rejection. / `failed` — Deposit failed (e.g., due to issues with the transaction).
transactionHash:
type: string
description: transaction hash.
examples:
- '0x000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f'
currency:
type: string
description: symbol of the asset.
examples:
- btc
quantity:
type: string
description: deposit quantity.
examples:
- '1.234'
createdAt:
type: number
description: deposit timestamp (ms).
examples:
- 1700000000000
required:
- id
- network
- address
- status
- transactionHash
- currency
- quantity
- createdAt
required:
- success
example:
success: true
data:
- id: 1234
network: BTC
address: 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa
secondaryAddress: null
status: done
transactionHash: '0x000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f'
currency: btc
quantity: '1.234'
createdAt: 1700000000000
'400':
description: Bad request — see the error envelope and error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Missing or invalid API key / signature.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: API key lacks the required permission or the IP is not allowlisted.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Rate limit exceeded. Honor `Retry-After` / the `Ratelimit` reset window.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- KorbitApiKey: []
x-korbit-permission: readDeposits
/v2/coin/recentWithdrawals:
get:
operationId: getCoinRecentWithdrawals
summary: Get Recent Withdrawals
description: Get recent cryptocurrency withdrawal history.
tags:
- Other
parameters:
- name: accountSeq
in: query
description: Account sequence number. Deposit/withdrawal APIs only operate on the main account, so only `1` is accepted. Defaults to 1.
schema:
type: number
examples:
- 1
- name: currency
in: query
required: true
description: symbol of the asset.
schema:
type: string
examples:
- btc
- name: limit
in: query
description: 'Maximum number of queries (Range: 1 to 100).'
schema:
type: number
examples:
- 100
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
examples:
- true
data:
type: array
items:
type: object
properties:
id:
type: number
description: withdrawal ID.
examples:
- 1234
quantity:
type: string
description: withdrawn coin quantity excluding fees.
examples:
- '1.234'
fee:
type: string
description: withdrawal fee.
examples:
- '0.0001'
currency:
type: string
description: symbol of the asset.
examples:
- btc
status:
type: string
enum:
- pending
- actionRequired
- reviewing
- processing
- done
- canceled
- failed
description: Withdrawal status `pending` — Withdrawal request received. / `actionRequired` — Pending email confirmation (withdrawal can be canceled). To proceed with the withdrawal, you must verify the confirmation email. / `reviewing` — Pending withdrawal reviewing (withdrawal can be canceled). Withdrawal may be delayed according to Korbit's policy. / `processing` — Withdrawal processing. / `done` — Withdrawal done. / `canceled` — Withdrawal canceled. / `failed` — Withdrawal failed. (Insufficient balance or other error)
network:
type: string
description: symbol of the blockchain network.
examples:
- ETH
address:
type: string
description: withdrawal address.
examples:
- 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa
secondaryAddress:
type: string
description: secondary address (destination tag, memo, etc. if none, then null.)
transactionHash:
type: string
description: transaction hash on the blockchain. If not yet sent to the blockchain, `null` is returned.
examples:
- '0x000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f'
createdAt:
type: number
description: withdrawal request timestamp (ms).
examples:
- 1700000000000
required:
- id
- quantity
- fee
- currency
- status
- network
- address
- createdAt
required:
- success
example:
success: true
data:
- id: 1234
quantity: '1.234'
fee: '0.0001'
currency: btc
status: done
network: BTC
address: 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa
secondaryAddress: null
transactionHash: '0x000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f'
createdAt: 1700000000000
'400':
description: Bad request — see the error envelope and error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Missing or invalid API key / signature.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: API key lacks the required permission or the IP is not allowlisted.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Rate limit exceeded. Honor `Retry-After` / the `Ratelimit` reset window.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- KorbitApiKey: []
x-korbit-permission: readWithdrawals
/v2/currencies:
get:
operationId: getCurrencies
summary: Get Crypto Info
description: Get cryptocurrencies information.
tags:
- Other
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
examples:
- true
data:
type: array
items:
type: object
properties:
name:
type: string
description: currency symbol.
examples:
- btc
fullName:
type: string
description: currency name.
examples:
- Bitcoin
withdrawalStatus:
type: string
description: (deprecated) withdrawal status. Please refer to `withdrawalStatus` under the `networkList` field.
depositStatus:
type: string
description: (deprecated) deposit status. Please refer to `depositStatus` under the `networkList` field.
confirmationCount:
type: string
description: (deprecated) number of confirmations required for deposits. Please refer to `confirmationCount` under the `networkList` field.
withdrawalTxFee:
type: string
description: (deprecated) withdrawal fees. Please refer to `withdrawalTxFee` under the `networkList` field.
withdrawalMinAmount:
type: string
description: minimum withdrawal amount. Please refer to `withdrawalMinAmount` under the `networkList` field.
withdrawalMaxAmountPerRequest:
type: string
description: max withdrawal amount per each request.
examples:
- '10'
defaultNetwork:
type: string
description: symbol for the default blockchain network.
examples:
- BTC
networkList:
type: array
items:
type: object
properties:
name:
type: string
description: network symbol.
examples:
- ETH
fullName:
type: string
description: network name.
examples:
- Ethereum
withdrawalStatus:
type: string
enum:
- launched
- stopped
description: 'possible to withdraw: `launched` — yes / `stopped` — no'
depositStatus:
type: string
enum:
- launched
- stopped
description: 'possible to deposit: `launched` — yes / `stopped` — no'
confirmationCount:
type: number
description: number of confirmations required for deposits.
examples:
- 3
withdrawalTxFee:
type: string
description: withdrawal fees.
examples:
- '0.0001'
withdrawalMinAmount:
type: string
description: minimum withdrawal amount.
examples:
- '0.00000001'
withdrawalPrecision:
type: number
description: decimal places for withdrawal quantity.
examples:
- 8
hasSecondaryAddr:
type: boolean
description: Whether the network has a secondary address
contractAddress:
type: string
description: contract address.
examples:
- '0x6b3595068778dd592e39a122f4f5a5cf09c90fe2'
addressExplorerUrl:
type: string
description: blockchain explorer address.
examples:
- https://etherscan.io/address/
required:
- name
- fullName
- withdrawalStatus
- depositStatus
- confirmationCount
- withdrawalTxFee
- withdrawalMinAmount
- withdrawalPrecision
- hasSecondaryAddr
description: list of supported blockchain networks (not present for fiat currencies)
required:
- name
- fullName
- withdrawalMaxAmountPerRequest
required:
- success
example:
success: true
data:
- name: krw
fullName: Won
withdrawalMaxAmountPerRequest: '5000000000'
depositStatus: launched
withdrawalStatus: launched
withdrawalTxFee: '1000'
withdrawalMinAmount: '1000'
- name: btc
fullName: Bitcoin
withdrawalMaxAmountPerRequest: '120'
defaultNetwork: BTC
networkList:
- name: BTC
fullName: Bitcoin
depositStatus: launched
withdrawalStatus: launched
confirmationCount: 3
withdrawalTxFee: '0.0008'
withdrawalMinAmount: '0.0001'
withdrawalPrecision: 8
hasSecondaryAddr: false
addressExplorerUrl: https://www.blockchain.com/ko/btc/address/
depositStatus: launched
withdrawalStatus: launched
confirmationCount: '3'
withdrawalTxFee: '0.0008'
withdrawalMinAmount: '0.0001'
- name: eth
fullName: Ethereum
withdrawalMaxAmountPerRequest: '2000'
defaultNetwork: ETH
networkList:
- name: ETH
fullName: Ethereum
depositStatus: launched
withdrawalStatus: launched
confirmationCount: 45
withdrawalTxFee: '0.005'
withdrawalMinAmount: '0.0001'
withdrawalPrecision: 8
hasSecondaryAddr: false
addressExplorerUrl: https://etherscan.io/address/
- name: BASE
fullName: BASE
depositStatus: launched
withdrawalStatus: launched
confirmationCount: 1
withdrawalTxFee: '0.001'
withdrawalMinAmount: '0.0001'
withdrawalPrecision: 8
hasSecondaryAddr: false
addressExplorerUrl: https://basescan.org/address/
depositStatus: launched
withdrawalStatus: launched
confirmationCount: '45'
withdrawalTxFee: '0.005'
withdrawalMinAmount: '0.0001'
- name: usdt
fullName: Tether
withdrawalMaxAmountPerRequest: '500000'
defaultNetwork: TRX
networkList:
- name: TRX
fullName: Tron
depositStatus: launched
withdrawalStatus: launched
confirmationCount: 1
withdrawalTxFee: '1'
withdrawalMinAmount: '1'
withdrawalPrecision: 6
hasSecondaryAddr: false
addressExplorerUrl: https://tronscan.org/#/address/
depositStatus: launched
withdrawalStatus: launched
confirmationCount: '1'
withdrawalTxFee: '1'
withdrawalMinAmount: '1'
'400':
description: Bad request — see the error envelope and error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Rate limit exceeded. Honor `Retry-After` / the `Ratelimit` reset window.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security: []
/v2/time:
get:
operationId: getTime
summary: Get Server Time
description: Get the current server time.
tags:
- Other
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
examples:
- true
data:
type: object
properties:
time:
type: number
description: timestamp.
examples:
- 1700000000000
required:
- time
required:
- success
example:
success: true
data:
time: 1700000000000
'400':
description: Bad request — see the error envelope and error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Rate limit exceeded. Honor `Retry-After` / the `Ratelimit` reset window.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security: []
/v2/tradingFeePolicy:
get:
operationId: getTradingFeePolicy
summary: Get Trading Fee Rates
description: Get the trading fee rates applied to your account.
tags:
- Other
parameters:
- name: accountSeq
in: query
description: Account sequence number. Defaults to 1 (main account).
schema:
type: number
examples:
- 1
- name: symbol
in: query
description: Enter the symbols of the trading pairs to query. To input multiple trading pairs, separate them with commas(,). If omitted, information for all available trading pairs on Korbit will be returned.
schema:
type: string
examples:
- btc_krw,eth_krw
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
examples:
- true
data:
type: array
items:
type: object
properties:
symbol:
type: string
description: Trading pair symbol.
examples:
- btc_krw
buyFeeCurrency:
type: string
description: Fee currency for buy orders.
examples:
- btc
sellFeeCurrency:
type: string
description: Fee currency for sell orders.
examples:
- krw
maxFeeRate:
type: string
description: Maximum fee rate. For buy orders of trading pairs where `buyFeeCurrency` is `krw`, an additional amount of KRW equal to `quantity*price*maxFeeRate` will be required (converted to the amount in use). Once the order is executed, it will be settled according to the fee rate at the time of execution.
examples:
- '0.0015'
takerFeeRate:
type: string
description: Taker fee rate.
examples:
- '0.0015'
makerFeeRate:
type: string
description: Maker fee rate.
examples:
- '0'
required:
- symbol
- buyFeeCurrency
- sellFeeCurrency
- maxFeeRate
- takerFeeRate
- makerFeeRate
required:
- success
example:
success: true
data:
- symbol: btc_krw
buyFeeCurrency: btc
sellFeeCurrency: krw
maxFeeRate: '0.002'
takerFeeRate: '0.0015'
makerFeeRate: '0'
- symbol: eth_krw
buyFeeCurrency: eth
sellFeeCurrency: krw
maxFeeRate: '0.002'
takerFeeRate: '0.0015'
makerFeeRate: '0'
- symbol: etc_krw
buyFeeCurrency: krw
sellFeeCurrency: krw
maxFeeRate: '0.002'
takerFeeRate: '0.0015'
makerFeeRate: '0'
- symbol: xrp_krw
buyFeeCurrency: krw
sellFeeCurrency: krw
maxFeeRate: '0.002'
takerFeeRate: '0.0015'
makerFeeRate: '0'
'400':
description: Bad request — see the error envelope and error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Missing or invalid API key / signature.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: API key lacks the required permission or the IP is not allowlisted.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Rate limit exceeded. Honor `Retry-After` / the `Ratelimit` reset window.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- KorbitApiKey: []
x-korbit-permission: readOrders
/v2/currentKeyInfo:
get:
operationId: getCurrentKeyInfo
summary: Get API Key Info
description: Get current API Key's information.
tags:
- Other
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
examples:
- true
data:
type: object
properties:
apiKey:
type: string
description: API Key ID.
examples:
- FFSoRME97Sr7WBCMZJ_NO5Bj8MZ03EyArRzqyr1NKIA
userUuid:
type: string
description: UUID of the user who owns this API key.
examples:
- f81d4fae-7dec-11d0-a765-00a0c91e6bf6
type:
type: string
enum:
- hmac-sha256
- ed25519
description: Key Type
publicKey:
type: string
description: ED25519 public key. (only for `ED25519` type.).
examples:
- '-----BEGIN PUBLIC KEY----- MCowBQYDK2VwAyEAk+Yp3C31eFwoky+zyRNB6rAv/lgULTeghxTQpqwQHzM= -----END PUBLIC KEY-----'
permissions:
type: array
items:
type: string
enum:
- readBalances
- readOrders
- writeOrders
- readDeposits
- writeDeposits
- readWithdrawals
- writeWithdrawals
whitelist:
type: string
description: List of IP addresses the API key can connect from. Multiple addresses are separated by commas (`,`).
examples:
- 1.2.3.4,5.6.7.8
expiration:
type: number
description: API key expiration timestamp (scheduled).
examples:
- 1700000000000
status:
type: string
enum:
- activated
- deactivated
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/korbit/refs/heads/main/openapi/korbit-other-api-openapi.yml