GLaDOS
233 lines
6.5 KiB
Markdown
233 lines
6.5 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 Index
|
|
|
|
> Get index price and the list of constituents for an asset.
|
|
|
|
<Badge color="gray" size="md">Request Weight: **2**</Badge>
|
|
|
|
|
|
## OpenAPI
|
|
|
|
````yaml /api-spec/perps-openapi.json get /v1/info/index
|
|
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/index:
|
|
get:
|
|
summary: Get Index
|
|
description: Get index price and the list of constituents for an asset.
|
|
operationId: getIndex
|
|
parameters:
|
|
- name: asset
|
|
in: query
|
|
required: true
|
|
schema:
|
|
$ref: '#/components/schemas/asset'
|
|
responses:
|
|
'200':
|
|
description: Index constituents response.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Index'
|
|
examples:
|
|
index:
|
|
summary: Index constituents
|
|
value:
|
|
asset: NVDA
|
|
index_price: '160.00'
|
|
constituents:
|
|
- source: chainlink
|
|
symbol: NVDA/USD
|
|
weight: '1.0'
|
|
price: '160.00'
|
|
ts: 1767225600000
|
|
'400':
|
|
$ref: '#/components/responses/Error400Response'
|
|
'429':
|
|
$ref: '#/components/responses/Error429Response'
|
|
'500':
|
|
$ref: '#/components/responses/Error500Response'
|
|
security: []
|
|
components:
|
|
schemas:
|
|
asset:
|
|
type: string
|
|
description: Asset name
|
|
example: USDC
|
|
Index:
|
|
type: object
|
|
required:
|
|
- asset
|
|
- index_price
|
|
- constituents
|
|
- ts
|
|
properties:
|
|
asset:
|
|
$ref: '#/components/schemas/asset'
|
|
index_price:
|
|
$ref: '#/components/schemas/index_price'
|
|
constituents:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/IndexConstituent'
|
|
ts:
|
|
$ref: '#/components/schemas/ts'
|
|
index_price:
|
|
type: string
|
|
description: Index price
|
|
example: '100.00'
|
|
IndexConstituent:
|
|
type: object
|
|
required:
|
|
- source
|
|
- symbol
|
|
- weight
|
|
- price
|
|
properties:
|
|
source:
|
|
$ref: '#/components/schemas/source'
|
|
symbol:
|
|
$ref: '#/components/schemas/symbol'
|
|
weight:
|
|
$ref: '#/components/schemas/weight'
|
|
price:
|
|
$ref: '#/components/schemas/price'
|
|
ts:
|
|
type: integer
|
|
description: >-
|
|
Request timestamp. Unix milliseconds for most operations; Unix seconds
|
|
for withdrawals (must match the on-chain EIP-712 struct verified against
|
|
block.timestamp).
|
|
example: 1767225600000
|
|
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'
|
|
source:
|
|
type: string
|
|
description: Source name
|
|
example: chainlink
|
|
symbol:
|
|
type: string
|
|
description: Instrument symbol
|
|
example: NVDA-USDC
|
|
weight:
|
|
type: string
|
|
description: Index constituent weight
|
|
example: '0.25'
|
|
price:
|
|
type: string
|
|
description: Price
|
|
example: '100.00'
|
|
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'
|
|
|
|
```` |