자산#

← REST API 가이드

자산 현황#

내가 가지고 있는 자산 목록을 조회합니다.

필요 권한: readBalances

스키마#

// URL 쿼리 파라미터
type RequestQuery = {
  /** 어카운트 시퀀스 번호. 기본값은 1 (메인 어카운트). Example: 1 */
  accountSeq?: number;
  /** 조회할 자산 목록. 콤마(,)로 구분하여 입력합니다. 입력하지 않으면 보유 중인 모든 자산을 조회합니다. Example: "btc,eth" */
  currencies?: string;
};

// JSON 응답 (`{ success: true, data }` 형태로 래핑되며, 아래는 `data` 필드의 구조)
type Response = Array<{
  /** 자산 이름. Example: "krw" */
  currency: string;
  /** 보유 수량. `사용 가능 수량 + 거래 중 수량 + 출금 중 수량`으로 계산합니다. Example: "100" */
  balance: string;
  /** 사용 가능 수량. Example: "70" */
  available: string;
  /** 거래 중 수량. Example: "20" */
  tradeInUse: string;
  /** 출금 중 수량. Example: "10" */
  withdrawalInUse: string;
  /** 매수평균가. Example: "5000" */
  avgPrice: string;
}>;

예시#

요청#

curl -H X-KAPI-KEY=API키 'https://api.korbit.co.kr/v2/balance?currencies=btc%2Ceth&timestamp=시각&signature=서명'

응답#

{
  "success": true,
  "data": [
    {
      "currency": "btc",
      "balance": "100",
      "available": "70",
      "tradeInUse": "20",
      "withdrawalInUse": "10",
      "avgPrice": "5000"
    },
    {
      "currency": "eth",
      "balance": "100",
      "available": "70",
      "tradeInUse": "20",
      "withdrawalInUse": "10",
      "avgPrice": "5000"
    }
  ]
}