Get Pfun Orderbook

Retrieve orderbook data for a Pfun market. Each row shows the full orderbook state at a point in time.

What you get:

• Best yes/no prices and sizes
• Full yes_side and no_side arrays (price levels)
• Venue market ID
• Server timestamp

Use cases:

• Analyze liquidity
• Build depth charts
• Calculate spreads
• Track orderbook changes over time

GET /api/v1/pfun/{market_id}/orderbook

200

[
  {
    "exchange": "<string>",
    "market_id": "<string>",
    "venue_market_id": "<string>",
    "best_yes_price": 123,
    "best_yes_size": 123,
    "best_no_price": 123,
    "best_no_size": 123,
    "yes_side": [
      123
    ],
    "no_side": [
      123
    ],
    "server_time": "2023-11-07T05:31:56Z"
  }
]

Authorizations

X-API-Key · string · header · required

Your API key (get one from the test-key endpoint above)

Path Parameters

market_id · string · required

Pfun market identifier

Query Parameters

limit · integer · default: 10

Maximum number of snapshots to return (default: 10 in docs, no max limit)

Response

200

application/json

Orderbook data

exchange · string

Exchange identifier

market_id · string

Market identifier

venue_market_id · string

Venue-specific market identifier

best_yes_price · integer

Best YES price

best_yes_size · integer

Size at best YES price

best_no_price · integer

Best NO price

best_no_size · integer

Size at best NO price

yes_side · (integer | null)[]

YES side price levels

no_side · (integer | null)[]

NO side price levels

server_time · string<date-time>

Server timestamp