# BTX 외부 API

BTX 외부 API로 공개 시세와 Feed를 조회하고, API 키를 사용해 계정·잔고·주문·체결을 연동할 수 있습니다. REST와 WebSocket은 아래의 서로 다른 운영 도메인을 사용합니다.

<div class="domain-grid">
  <div class="domain-card"><strong>REST API</strong><p><code>https://api.btxpro.co.kr</code></p><p>조회, 주문 생성, 취소, 체결 이력</p></div>
  <div class="domain-card"><strong>WebSocket API</strong><p><code>wss://api-ws.btxpro.co.kr</code></p><p>실시간 시세, 개인 이벤트, 주문 명령</p></div>
</div>

| 용도 | 운영 주소 | 인증 |
| --- | --- | --- |
| REST | `https://api.btxpro.co.kr/v1/...` | 공개 API 또는 HMAC 서명 |
| 공개 시세 WS | `wss://api-ws.btxpro.co.kr/v1/market/stream` | 불필요 |
| 개인 이벤트·주문 WS | `wss://api-ws.btxpro.co.kr/v1/user/stream` | 연결 시 read, 주문 명령은 trade 추가 |

공개·개인 WS 모두 `api-ws.btxpro.co.kr`의 위 경로를 사용합니다. 고객 웹 화면의 로그인 세션과 외부 API 키는 별개입니다.

## 시작하기

1. [빠른 시작](/api-docs/guide/quickstart.md)에서 공개 시세와 계정 정보를 조회합니다.
2. [인증](/api-docs/guide/authentication.md)에서 API 키 권한과 HMAC 서명 규칙을 확인합니다.
3. [REST 전체 목록](/api-docs/generated/rest.md) 또는 [API 레퍼런스](/api-docs/reference.md)에서 요청·응답 필드를 확인합니다.
4. [WebSocket 가이드](/api-docs/websocket/overview.md)에서 실시간 연결과 재연결 절차를 구현합니다.

## 현재 지원 범위

| 기능 | 지원 내용 |
| --- | --- |
| 공개 정보 | 통화, 마켓, 시세, 호가, 체결, 캔들, Feed |
| 계정 | API 키 권한, 지갑, 잔고 |
| 주문 | 지정가 `limit`, `GTC`, 매수·매도, 단건·일괄 취소 |
| 실시간 시세 | `ticker` 구독·해제, 전체 마켓 구독 |
| 개인 실시간 | 초기 스냅샷, 주문·체결·잔고 이벤트, 주문 생성·취소 |

시장가, IOC/FOK, post-only, quote 수량 주문과 원자적 주문 정정은 현재 지원하지 않습니다. WS `order.amend`는 `AMEND_NOT_SUPPORTED`를 반환합니다.

주문용 고객 ID와 멱등성 키는 제공하지 않습니다. 타임아웃 또는 연결 종료로 결과를 받지 못한 주문은 [복구 절차](/api-docs/websocket/recovery.md)에 따라 상태를 확인한 뒤 처리하세요.

## 명세 다운로드

- [OpenAPI 3.1 JSON](/api-docs/openapi.json)
- [요청·응답 모델](/api-docs/generated/schemas.md)
- [WebSocket 메시지 모델](/api-docs/generated/websocket.md)
- [문서 인덱스 llms.txt](/api-docs/llms.txt)
- [전체 문서 텍스트](/api-docs/llms-full.txt)

운영 도메인은 API 연동에 사용할 기준 주소입니다. 문서의 주소 표기가 DNS·TLS·로드밸런서의 배포 완료를 의미하지는 않습니다.