# 코빗 Open API

> 코빗(Korbit) 가상자산 거래소의 Open API 개발자 문서. REST와 WebSocket API로 시세, 주문, 자산, 입출금 등의 기능을 제공합니다.
> 원본 문서: https://docs.korbit.co.kr/ (한글) · https://docs.korbit.co.kr/index_en.html (영문)

이 파일은 인덱스입니다. **먼저 [`common.md`](./common.md)을 읽고**, 사용 중인 API 키의 서명 모드에 해당하는 인증 파일을 읽은 뒤, 작업에 필요한 도메인 파일만 골라 읽으세요.

## 파일 목록

### 필수 prelude

- [common.md](./common.md): 기본 URL, 요청 규칙, 요청 한도, 권한, 타임스탬프 윈도우.

### 인증

이용자가 서명 방식을 명시하지 않은 경우, HMAC-SHA256이 코빗에서 더 일반적인 선택입니다. ED25519 키를 사용한다고 밝힌 경우에는 [`auth-ed25519.md`](./auth-ed25519.md)를 따르세요.

- [auth-hmac-sha256.md](./auth-hmac-sha256.md): HMAC-SHA256 서명 헬퍼. 서명은 hex.
- [auth-ed25519.md](./auth-ed25519.md): ED25519 서명 헬퍼. 서명은 Base64, URL 인코딩 필요.

### REST · Public / 기타 (인증 불필요)

- [market.md](./market.md): `/v2/tickers`, `/v2/orderbook`, `/v2/trades`, `/v2/candles`, `/v2/currencyPairs`, `/v2/tickSizePolicy`, `/v2/currencies`, `/v2/time`.

### REST · Private (인증 필요)

- [orders.md](./orders.md): `/v2/orders` (GET/POST/DELETE), `/v2/openOrders`, `/v2/allOrders`, `/v2/myTrades`. `clientOrderId`, `timeInForce`, BBO, 가격보호, 주문 상태, 오류 코드.
- [balance.md](./balance.md): `/v2/balance`.
- [deposit.md](./deposit.md): 가상자산·KRW 입금 — 주소, 내역, 상태, KRW `type` 분류.
- [withdrawal.md](./withdrawal.md): 가상자산·KRW 출금 — 주소, 수량, 상태 (취소 가능 상태 포함), 오류.
- [misc.md](./misc.md): `/v2/tradingFeePolicy`, `/v2/currentKeyInfo`. 서명은 필요하지만 별도 권한은 불필요.

### WebSocket

- [websocket.md](./websocket.md): Public (`ticker`, `orderbook`, `trade`) — 인증 불필요. Private (`myOrder`, `myTrade`, `myAsset`) — 연결 시점 인증 필수. 채널별 필드 표와 예시 메시지 포함. Private 메시지는 이중 중첩 구조 (`message.order.orders[]`, `message.trade.trades[]`, `message.asset.assets[]`).

## 관련 자료

- [코빗 Open API 개발자 문서 웹사이트](https://docs.korbit.co.kr/)
- [코빗 개발자센터](https://developers.korbit.co.kr) — API 키 발급/관리