233 lines
6.1 KiB
Markdown
233 lines
6.1 KiB
Markdown
|
|
> ## Documentation Index
|
||
|
|
> Fetch the complete documentation index at: https://docs.polymarket.com/llms.txt
|
||
|
|
> Use this file to discover all available pages before exploring further.
|
||
|
|
|
||
|
|
# Get Book
|
||
|
|
|
||
|
|
> Get book for an instrument.
|
||
|
|
|
||
|
|
<Badge color="gray" size="md">Request Weight:</Badge>
|
||
|
|
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<Badge color="gray" size="md">Depth 10: **2**</Badge>
|
||
|
|
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<Badge color="gray" size="md">Depth 100: **5**</Badge>
|
||
|
|
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<Badge color="gray" size="md">Depth 500: **10**</Badge>
|
||
|
|
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<Badge color="gray" size="md">Depth 1000: **20**</Badge>
|
||
|
|
|
||
|
|
|
||
|
|
## OpenAPI
|
||
|
|
|
||
|
|
````yaml /api-spec/perps-openapi.json get /v1/info/book
|
||
|
|
openapi: 3.0.3
|
||
|
|
info:
|
||
|
|
title: Polymarket Perps HTTP API
|
||
|
|
version: 1.0.0
|
||
|
|
description: HTTP API for Polymarket perpetual trading system.
|
||
|
|
license:
|
||
|
|
name: Apache 2.0
|
||
|
|
url: https://www.apache.org/licenses/LICENSE-2.0.html
|
||
|
|
servers:
|
||
|
|
- url: https://api.perpetuals.polymarket.com
|
||
|
|
description: Production Perps HTTP API
|
||
|
|
security: []
|
||
|
|
paths:
|
||
|
|
/v1/info/book:
|
||
|
|
get:
|
||
|
|
summary: Get Book
|
||
|
|
description: Get book for an instrument.
|
||
|
|
operationId: getBook
|
||
|
|
parameters:
|
||
|
|
- name: instrument_id
|
||
|
|
in: query
|
||
|
|
required: true
|
||
|
|
schema:
|
||
|
|
$ref: '#/components/schemas/instrument_id'
|
||
|
|
- name: depth
|
||
|
|
in: query
|
||
|
|
required: false
|
||
|
|
schema:
|
||
|
|
$ref: '#/components/schemas/depth'
|
||
|
|
responses:
|
||
|
|
'200':
|
||
|
|
description: Book response.
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: '#/components/schemas/Book'
|
||
|
|
'400':
|
||
|
|
$ref: '#/components/responses/Error400Response'
|
||
|
|
'429':
|
||
|
|
$ref: '#/components/responses/Error429Response'
|
||
|
|
'500':
|
||
|
|
$ref: '#/components/responses/Error500Response'
|
||
|
|
security: []
|
||
|
|
components:
|
||
|
|
schemas:
|
||
|
|
instrument_id:
|
||
|
|
type: integer
|
||
|
|
description: Instrument ID
|
||
|
|
depth:
|
||
|
|
type: integer
|
||
|
|
description: Number of book levels to return
|
||
|
|
enum:
|
||
|
|
- 10
|
||
|
|
- 100
|
||
|
|
- 500
|
||
|
|
- 1000
|
||
|
|
default: 100
|
||
|
|
Book:
|
||
|
|
type: object
|
||
|
|
required:
|
||
|
|
- instrument_id
|
||
|
|
- bids
|
||
|
|
- asks
|
||
|
|
- timestamp
|
||
|
|
- sequence
|
||
|
|
properties:
|
||
|
|
instrument_id:
|
||
|
|
$ref: '#/components/schemas/instrument_id'
|
||
|
|
bids:
|
||
|
|
type: array
|
||
|
|
items:
|
||
|
|
$ref: '#/components/schemas/level'
|
||
|
|
description: Bid levels
|
||
|
|
asks:
|
||
|
|
type: array
|
||
|
|
items:
|
||
|
|
$ref: '#/components/schemas/level'
|
||
|
|
description: Ask levels
|
||
|
|
timestamp:
|
||
|
|
$ref: '#/components/schemas/timestamp'
|
||
|
|
sequence:
|
||
|
|
$ref: '#/components/schemas/sequence'
|
||
|
|
level:
|
||
|
|
type: array
|
||
|
|
items:
|
||
|
|
type: string
|
||
|
|
maxItems: 2
|
||
|
|
description: |
|
||
|
|
- `"100.00"` - Price
|
||
|
|
- `"10.00"` - Quantity
|
||
|
|
example:
|
||
|
|
- '100.00'
|
||
|
|
- '10.00'
|
||
|
|
timestamp:
|
||
|
|
type: integer
|
||
|
|
description: Timestamp in milliseconds
|
||
|
|
example: 1767225600000
|
||
|
|
sequence:
|
||
|
|
type: integer
|
||
|
|
description: Sequence number
|
||
|
|
example: 1234567890
|
||
|
|
Error400:
|
||
|
|
title: Error400
|
||
|
|
type: object
|
||
|
|
required:
|
||
|
|
- status
|
||
|
|
- error
|
||
|
|
properties:
|
||
|
|
status:
|
||
|
|
type: string
|
||
|
|
enum:
|
||
|
|
- err
|
||
|
|
error:
|
||
|
|
$ref: '#/components/schemas/error'
|
||
|
|
Error429:
|
||
|
|
title: Error429
|
||
|
|
type: object
|
||
|
|
required:
|
||
|
|
- status
|
||
|
|
- error
|
||
|
|
properties:
|
||
|
|
status:
|
||
|
|
type: string
|
||
|
|
enum:
|
||
|
|
- err
|
||
|
|
error:
|
||
|
|
$ref: '#/components/schemas/error'
|
||
|
|
Error500:
|
||
|
|
title: Error500
|
||
|
|
type: object
|
||
|
|
required:
|
||
|
|
- status
|
||
|
|
- error
|
||
|
|
properties:
|
||
|
|
status:
|
||
|
|
type: string
|
||
|
|
enum:
|
||
|
|
- err
|
||
|
|
error:
|
||
|
|
$ref: '#/components/schemas/error'
|
||
|
|
error:
|
||
|
|
type: string
|
||
|
|
description: >-
|
||
|
|
Error identifier. For domain rejections and transport errors
|
||
|
|
(`401`/`404`/`429`/`500`) this is a stable, machine-readable snake_case
|
||
|
|
identifier that is part of the API contract and safe to branch on, e.g.
|
||
|
|
`insufficient_margin`, `insufficient_balance`, `order_not_found`,
|
||
|
|
`reduce_only_invalid`, `unauthorized`, `not_found`. For `400` it is a
|
||
|
|
human-readable validation detail whose wording may change. See the Error
|
||
|
|
handling guide for the domain identifiers. (Post-only / Fill-or-Kill
|
||
|
|
outcomes are order statuses such as `post_only_rejected`, not
|
||
|
|
rejections.)
|
||
|
|
example: insufficient_margin
|
||
|
|
responses:
|
||
|
|
Error400Response:
|
||
|
|
description: |
|
||
|
|
Bad request — the request was malformed or failed validation (bad query
|
||
|
|
parameters, unparseable body, invalid signature, or a domain pre-check).
|
||
|
|
The `error` field is a human-readable validation detail.
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: '#/components/schemas/Error400'
|
||
|
|
Error429Response:
|
||
|
|
description: >
|
||
|
|
Too Many Requests. `error` distinguishes the limit that was hit:
|
||
|
|
|
||
|
|
`ip_rate_limited` (per-IP token bucket), `action_rate_limited`
|
||
|
|
(per-account
|
||
|
|
|
||
|
|
action rate), or `open_orders_limit` (resting open-order cap).
|
||
|
|
headers:
|
||
|
|
Retry-After:
|
||
|
|
description: >
|
||
|
|
Whole seconds to wait before retrying. Present only on token-bucket
|
||
|
|
|
||
|
|
rate-limit rejections (`ip_rate_limited` and `action_rate_limited`);
|
||
|
|
a
|
||
|
|
|
||
|
|
conservative estimate of when enough capacity will have refilled to
|
||
|
|
|
||
|
|
admit the request. Absent on `open_orders_limit`, which is a
|
||
|
|
capacity
|
||
|
|
|
||
|
|
limit, not a rate limit — waiting does not free order slots; cancel
|
||
|
|
|
||
|
|
resting orders or wait for fills instead.
|
||
|
|
schema:
|
||
|
|
type: integer
|
||
|
|
example: 2
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: '#/components/schemas/Error429'
|
||
|
|
Error500Response:
|
||
|
|
description: |
|
||
|
|
Internal server error. `error` is `internal_error`.
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: '#/components/schemas/Error500'
|
||
|
|
|
||
|
|
````
|