오더북

오더북 API는 특정 마켓 결과에 대한 시장 깊이와 주문 데이터를 실시간으로 제공합니다.

오더북 데이터 가져오기

특정 마켓 결과의 오더북을 조회합니다.

Get orderbook list

get

Path parameters

outcomeIdstring · min: 1RequiredExample: 546eb1a1-b87d-49d4-a579-9c80c0601c72

Query parameters

pagestringOptionalDefault: 1Example: 1Pattern: ^\d+$

pageSizestringOptionalDefault: 20Example: 20Pattern: ^\d+$

sortstring · enumOptionalDefault: descExample: descPossible values:

Responses

200

Orderstable data

application/json

400

Bad request

application/json

404

Not found

application/json

get

/api/v1/orderbook/{outcomeId}

HTTPcURLJavaScriptPython

GET /api/v1/orderbook/{outcomeId} HTTP/1.1
Accept: */*

{
  "orders": [
    {
      "id": "order-uuid",
      "userId": "user-uuid",
      "marketId": "1",
      "outcomeId": "2",
      "quantity": "10",
      "amount": "100",
      "filledQuantity": "5",
      "price": "0.5",
      "filledPrice": "0.5",
      "fee": "0.01",
      "side": "buy",
      "type": "limit",
      "status": "open",
      "cancelReason": null,
      "isSystem": false,
      "signature": "signature",
      "expiredAt": null,
      "signTime": 1680000000,
      "createdAt": "2024-06-01T00:00:00.000Z",
      "updatedAt": "2024-06-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 100,
    "totalPages": 5
  }
}

코드 예제

// 오더북 데이터 가져오기
const API_KEY = 'YOUR_API_KEY'
const BASE_URL = 'https://engine.xmarket.app/api/v1';

async function getOrderbook(outcomeId) {
  const response = await fetch(
    `${BASE_URL}/orderbook/${outcomeId}`,
    {
      headers: {
        'x-api-key': API_KEY,
        'Content-Type': 'application/json'
      }
    }
  );
  
  const orderbook = await response.json();
  return orderbook;
}

스프레드 가져오기

특정 마켓 결과의 오더북 스프레드를 조회합니다.

Get orderbook spread

get

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

outcomeIdstring · min: 1RequiredExample: 546eb1a1-b87d-49d4-a579-9c80c0601c72

Responses

200

Orderbook spread data

application/json

lastPricenumberRequiredExample: 0.5

spreadnumberRequiredExample: 0.1

400

Bad request

application/json

404

Not found

application/json

get

/api/v1/orderbook/spread/{outcomeId}

HTTPcURLJavaScriptPython

GET /api/v1/orderbook/spread/{outcomeId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "asks": [
    {
      "price": 0.5,
      "shares": 10
    }
  ],
  "bids": [
    {
      "price": 0.4,
      "shares": 8
    }
  ],
  "lastPrice": 0.5,
  "spread": 0.1
}

모범 사례

1. 폴링 빈도: 너무 자주 폴링하지 마세요; 레이트 리밋을 준수하세요

2. 데이터 캐싱: 적절한 TTL로 오더북 데이터를 캐시하세요

3. 오류 처리: 네트워크 오류와 잘못된 응답을 우아하게 처리하세요

4. 가격 검증: 가격이 유효한 범위(0-1)인지 검증하세요

5. 심도 분석: 대량 주문을 할 때 마켓 심도를 고려하세요

6. 실시간 업데이트: 고빈도 업데이트의 경우 사용 가능할 때 WebSocket 연결을 고려하세요

성능 팁

• 응답 크기를 제한하려면 페이징을 사용하세요

• 최근 본 마켓의 오더북 데이터를 캐시하세요

• 재시도 로직에는 지수적 백오프를 구현하세요

• 여러 결과의 오더북을 병렬로 집계하는 것을 고려하세요

• 스로틀링을 피하려면 레이트 리밋 헤더를 모니터링하세요

관련 문서

• 빠른 시작 - API로 시작하기

• 마켓 API - 마켓 정보 조회

• 주문 API - 주문을 생성하고 관리합니다

• 포지션 API - 거래 포지션을 추적합니다