> ## Documentation Index > Fetch the complete documentation index at: https://docs.0xinsider.com/llms.txt > Use this file to discover all available pages before exploring further. # Positions > List current open positions across markets, or filter them to up to 25 wallets. Use this endpoint to build a positions list or inspect a wallet's open holdings. Rows are ordered by `current_value_usd`, highest first. For recorded buys and sells in one position, use [Position timeline](/api-reference/endpoint/get-position-timeline). For recently changed positions worth at least \$50,000, use [Large positions](/api-reference/endpoint/list-large-positions). ## Parameters | Parameter | Description | | - | - | | `wallet` | Scopes the read to one wallet, or up to 25. Repeat `wallet=`, use `wallet[]=`, or comma-separate the values in one `wallet=`. Each value is a wallet address, a Polymarket username, or a `trd_` id, resolved the same way [Trader](/api-reference/endpoint/get-trader) resolves it. `min_size` then defaults to `0`. An address 0xinsider has never tracked returns whatever rows it has, or an empty list. A username or `trd_` id that resolves to nothing returns `404` with `error.param` set to `wallet`. More than 25 values returns `400`. | | `min_size` | The lowest `current_value_usd` to include, in USD. The default is 100, or 0 when you send `wallet`. Send `0` for every position 0xinsider has valued. | | `min_grade` | The lowest grade to include. `A` returns S and A wallets. | | `side` | `yes` or `no`. These map to outcome index 0 and 1. | | `category` | Exact match on the market's category. | | `condition_id` | Limits the feed to one market. Send the raw Polymarket `condition_id` or the `mkt_` id. An unknown id returns an empty list, not a `404`. | | `limit` | Rows per page, 1 to 100. The default is 20. | | `cursor` | The `next_cursor` from the previous response. Keep sending it while `has_more` is `true`. | | `consistency` | `live` is the default and reads current positions on every page. `snapshot` requires `wallet` and keeps up to 500 matching positions and 2 MB in one result for up to five minutes. Repeat `consistency=snapshot` and the same filters with each cursor. A new first page replaces the API key's previous snapshot. | Every filter is applied before the page is built, so paging deep into the feed costs the same as page 1. With `wallet`, a page holds that wallet's own positions, and rows from several wallets are interleaved by `current_value_usd`. ## Key response fields | Field | Meaning | | | - | - | - | | `side` | `YES` or `NO`. `market.outcome_label` is Polymarket's own label for the same outcome, such as a team name, so the two can read differently. | | | `current_value_usd` | What the position is worth now, marked to market. It is never `null`, because a position 0xinsider has not valued yet is omitted of the response. | | | `exact` | Lossless source atoms for the valued position: `shares`, `cost_basis_usd`, `avg_price`, `current_value_usd`, `initial_value_usd`, `cash_pnl`, and `realized_pnl` when each source is verified. Every atom has `value`, `unit`, `scale`, and `basis`; use decimal-safe arithmetic and keep the numeric twins for display. The object is omitted when the current value is unavailable. | | | `cash_pnl`, `realized_pnl` | Polymarket's `cashPnl` and `realizedPnl` for the position. Either is absent until 0xinsider has reconciled the position against Polymarket. | | | `freshness` | How old the valuation is, from `last_reconciled_at`: `fresh` up to 5 minutes, `refreshing` up to 30 minutes, `stale` after that, and `unknown` when the position has never been valued. | | | `data_quality` | Page-level age and coverage beside `data`. The `positions`, `trader`, and `market` groups use \`wallet\_positions.last\_reconciled\_at | updated\_at`, `traders.last\_synced`, and `market\_canonical.last\_refreshed\_at`. The stored clocks are part of the `ETag`; `meta.cached`and`meta.cache\_age\_s\` describe the transport cache. | | `snapshot` | Present only with `consistency=snapshot`. `as_of` dates the frozen result, `expires_at` is the last time to continue, and `row_count` is the number of rows in that result. `data_quality` covers the frozen result in this mode. | | | `trader.is_new_wallet` | `true` when 0xinsider first saw the wallet within the last 30 days. `wallet_age_days` counts from that first sighting, not from when the wallet was created on chain. | | | `trader.win_rate` | The wallet's win rate as a ratio from 0 to 1, the same scale as the [Trader](/api-reference/endpoint/get-trader) profile. | | ## Example ```bash theme={null} curl -H "Authorization: Bearer $OXINSIDER_API_KEY" \ "https://api.0xinsider.com/api/v1/positions?min_grade=A&min_size=25000&side=yes&limit=50" ``` One wallet's complete open positions, then three wallets in one request: ```bash theme={null} curl -H "Authorization: Bearer $OXINSIDER_API_KEY" \ "https://api.0xinsider.com/api/v1/positions?wallet=0x204f0a3daba2136fa857863d5d008c6a02b6ba2c&limit=100" curl -H "Authorization: Bearer $OXINSIDER_API_KEY" \ "https://api.0xinsider.com/api/v1/positions?wallet=0x204f0a3daba2136fa857863d5d008c6a02b6ba2c&wallet=0x5a218c7ad04135830a45c41aaed7294df7809318&wallet=0x00110b8ef00db2a1a6bbe1198e52fc4eb5a84333&limit=100" ``` For a repeatable multi-page read, add `consistency=snapshot` to a wallet request. Follow `next_cursor` with the same filters until `has_more` is `false`. If the cursor expires or another first page replaces it, request page 1 again. If the result exceeds 500 positions or 2 MB, narrow the filters or use `live`. ## What it does not return * A position on a market with more than two outcomes. This route covers two-outcome markets only. * A position 0xinsider has not valued yet. Its `current_value_usd` would be `null`, so the row is omitted. * A position worth under \$100, unless you send `min_size=0` or `wallet`, which sets the floor to 0. * A closed position. A holding that reaches 0 shares is dropped, so a `wallet` read covers open positions only. * The fills that built the position. Those are on [Position timeline](/api-reference/endpoint/get-position-timeline). ## Caching Save the response's `ETag` and send it in `If-None-Match` on your next request. If the page has not changed, the server returns `304 Not Modified` with no body. `data_quality` is part of the representation, so its stored clocks change the `ETag`; `meta.cached` and `meta.cache_age_s` describe the transport cache. ## OpenAPI ````yaml GET /api/v1/positions openapi: 3.1.0 info: x-generated-rate-limit-policy-from: web/src/lib/rate-limit-facts.ts via web/scripts/generate-api-policy.ts title: 0xinsider API description: >- Follow provider-exposed large-trade activity from Polymarket. Polymarket wallet-attributed trades can add grades, P&L, strategy, and diagnostic-score context when sufficient source data exists. Fields can be null or unavailable. Normal API requests use a 30-second server timeout that returns HTTP 408 Request Timeout with the standard error envelope (error.code request_timeout) when exceeded. Every /api/v1 failure answers that envelope, including a body that is not JSON or does not fit the request schema (400 invalid_body), a query or path value that does not parse (400 invalid_query, invalid_path), a missing Content-Type: application/json (415 unsupported_media_type), a body over 1048576 bytes (413 payload_too_large) and a method the path does not serve (405 method_not_allowed), each with error.param naming the field where one is known and meta.request_id equal to X-Request-Id. Unknown query names are ignored by default and reported in X-Query-Ignored, while X-Effective-Query lists the normalized names and values applied using form-urlencoded decoding, where + is a space; strict mode returns 400 bad_request with error.reason unknown_query_parameter before the handler runs, including for an unknown name with an incomplete percent escape. Every list operation clamps an out-of-range limit into its published minimum..maximum instead of refusing it (limit=0 reads one row, limit=500 reads the maximum), and X-Effective-Query reports the clamped value; only a limit that is not an integer is refused, with 400 invalid_query. Public REST /api/v1/* endpoints, excluding /api/v1/mcp, use Bearer-token based non-credentialed browser CORS: any Origin may call with Authorization, Content-Type, If-None-Match, Idempotency-Key, Mcp-Session-Id, Mcp-Protocol-Version, Last-Event-Id, and X-Query-Validation request headers. X-Query-Validation: strict opts into rejecting unknown query names; the default remains compatible. Remote MCP at /api/v1/mcp is non-credentialed, but still validates Origin against the 0xinsider/localhost allowlist per MCP Streamable HTTP DNS-rebinding guidance. Successful browser CORS preflight responses advertise Access-Control-Max-Age: 86400. Browser JavaScript may read RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, the legacy X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After, ETag, X-Request-Id, X-Request-Cost, X-Usage-Accounting, X-Batch-RateLimit-Limit, X-Batch-RateLimit-Remaining, X-Batch-RateLimit-Reset, Mcp-Session-Id, X-Mcp-Error-Code, X-Query-Ignored, and X-Effective-Query response headers. Rate-limit headers describe the budget a request was counted against: the API key's per-minute window on an authenticated call, and the per-IP budget on a public route or on a refused credential (401, 402, 403, 423), so a client looping on a bad or lapsed key still sees how much room it has. Conditional GET: these operations return a weak ETag and answer If-None-Match with 304 Not Modified and an empty body: GET /api/v1/health, GET /api/v1/insider-radar, GET /api/v1/insider-radar/{id}, GET /api/v1/large-positions, GET /api/v1/leaderboard, GET /api/v1/leaderboard/trending, GET /api/v1/market/{condition_id}/candles, GET /api/v1/market/{condition_id}/flow, GET /api/v1/market/{condition_id}/intel, GET /api/v1/market/{condition_id}/snapshot, GET /api/v1/markets/explore, GET /api/v1/markets/sharp-money-flows, GET /api/v1/markets/smart-money-flows, GET /api/v1/pick-of-the-day, GET /api/v1/pick-of-the-day/archive, GET /api/v1/positions, GET /api/v1/sports-edge-observations, GET /api/v1/sports-edge-signals, GET /api/v1/trader/{address}, GET /api/v1/trader/{address}/context, GET /api/v1/trader/{address}/pnl, GET /api/v1/trader/{address}/position-timeline, GET /api/v1/traders/{trader}/position-timeline, GET /api/v1/large-trades, GET /api/v1/large-trades/history, GET /api/v1/large-trades/{id}, GET /api/v1/whale-trades, GET /api/v1/whale-trades/history, GET /api/v1/whale-trades/{id}, GET /api/v1/whale-trades/{id}/counterparties/executions, GET /api/v1/whale-trades/{id}/counterparties/executions/{execution_id}/makers. Credentialed first-party routes such as /api/keys, /api/billing, and auth endpoints remain restricted to configured 0xinsider origins. Protected V1 responses, except the zero-cost /api/v1/usage route, after handler execution carry X-Usage-Accounting: persisted, failed, or unknown. This reports the usage-record write; it does not change the handler result. Do not replay a successful mutation to repair an unknown usage record. Before execution, unavailable accounting capacity returns HTTP 503 with error.reason=request_accounting_unavailable; honor Retry-After. Public API responses add the browser-readable Server-Timing header: Processing time in milliseconds, for example api;dur=12.345. Includes API authentication, quota admission, handler work and response construction. Excludes network transit and streamed body or export-file transfer. The engineering budget is strictly below 250 ms; this header reports observations, not a latency guarantee or a new timeout. Requests through https://0xinsider.com/api/* append Server-Timing: web_api;dur= and X-Web-Request-Id for that web origin handler. The web clock includes upstream waiting and existing body construction, so do not add it to api;dur. It excludes platform routing, cold module initialization, CDN hits and later stream/file transfer. On a cache hit these headers describe the earlier origin fill, not the current request; static Markdown API routes have no fresh web clock. version: 1.0.0 contact: name: 0xinsider email: support@0xinsider.com url: https://0xinsider.com servers: - url: https://api.0xinsider.com description: >- Production (live data). Authenticate with a live key (oxi_sk_live_...); requires an active Pro subscription. A sandbox key (oxi_sk_test_...) is answered with 401 invalid_api_key and error.reason sandbox_api_key. - url: https://0xinsider.com/sandbox description: >- Sandbox. No credential required and no production data: every documented operation answers with its documented example or a deterministic sample of its response schema. GET /api/v1/stream is the one exclusion and answers 400 there, because a Server-Sent Events stream is a live connection rather than a body. Add ?sandbox_status= to receive one of the error responses the operation documents (for example 429 with Retry-After). Documented query parameters and JSON request bodies are checked against this document, the two context.md routes answer 200 text/markdown, GET /api/v1/trader/{address}/export/download answers its 302 with a Location the sandbox serves itself rather than an object store, and nothing is stored between requests. A sandbox key (oxi_sk_test_..., issued with no account by POST https://api.0xinsider.com/api/v1/agents/register) is optional: on an operation that requires a credential, a well-formed key is answered with X-Oxi-Sandbox-Key: valid and a malformed one with 401 invalid_api_key. security: - bearerAuth: [] - oauth2: - read tags: - name: Traders description: Traders, batch lookups, timelines, and export readiness. - name: Positions description: Current prediction-market position snapshots from backend-owned mirrors. - name: Large Positions description: Largest current open positions from graded traders (Polymarket-only). - name: Large trades description: Recent and historical large trades. - name: Leaderboard description: Ranked trader discovery and category/strategy leaderboards. - name: Pick of the Day description: >- One sourced sharp-money call a day: the side profitable wallets are backing, with pre-game odds, the holders, and the track record. - name: Games description: >- Sports and esports games: both sides, schedules, provider status and the Polymarket markets linked to each game. - name: Markets description: Market search, discovery, snapshots, and sharp-money flow. - name: Content description: Search across 0xinsider editorial content. - name: Suspicious trades description: Trades whose recorded suspicion score meets the live flag threshold. - name: Insider Radar description: >- Deprecated spelling of Suspicious trades; both operations stay live as aliases. - name: Events description: Durable public event replay streams. - name: Streaming description: Resumable real-time Server-Sent Events stream of live feed envelopes. - name: Webhooks description: Signed builder webhook destinations and delivery controls. - name: Usage description: Developer API budget and usage introspection. - name: Onboarding description: >- Self-serve agent registration: a sandbox key with no account, and the path to live access. - name: System description: Health and operational status checks. - name: MCP description: Remote Model Context Protocol transport. - name: Reports description: Daily, weekly, monthly, and trader export report snapshots. - name: Account description: Identify the account and credential authenticated for a paid API request. externalDocs: description: 0xinsider API docs url: https://docs.0xinsider.com paths: /api/v1/positions: get: tags: - Positions summary: List current positions (positions-board feed) description: >- Returns the current positions-board feed backed by the wallet_positions mirror. Ordered by current_value_usd DESC with deterministic (wallet, condition_id, outcome_index) tiebreakers. Pre-reconcile rows (current_value_usd IS NULL) are excluded. Cursor-paginated. Every filter pushes into SQL. Deep cursor pages cost the same as the first page: the value bounds and the cursor are index conditions, so a page never rescans the feed from the top. With wallet, the same feed is read for one wallet or a book of up to 25 wallets from each wallet's own ordered index range, so the pages are that wallet's complete reconciled binary open positions and the cost is the page, never the board. min_size defaults to 100 on the board read, so a request with no wallet and no min_size drops positions valued under 100 USD; with wallet it defaults to 0 instead. Send min_size=0 to include every reconciled position. What a wallet read does not return: positions with shares at 0 (closed), rows the reconciler has not valued yet (current_value_usd IS NULL), and non-binary outcomes; per-row last_reconciled_at and freshness say how old each valuation is. Each row also carries additive `exact` source atoms as decimal strings with unit, scale and basis metadata; parse those values with decimal-safe arithmetic and do not reconstruct them from the display-safe numeric fields. The response adds a top-level `data_quality` object beside `data`, with positions, trader, and market groups owned by `wallet_positions.last_reconciled_at|updated_at`, `traders.last_synced`, and `market_canonical.last_refreshed_at`. Its stored clocks are part of the ETag; `meta` continues to hold transport cache facts. operationId: listPositions parameters: - name: X-Query-Validation in: header required: false description: >- Opt into strict query-name validation. The default is compatible: unknown names are ignored and reported in X-Query-Ignored. With strict, an unknown name returns 400 bad_request with error.reason unknown_query_parameter before the handler runs, including when its percent escape is incomplete. schema: type: string enum: - strict - name: limit in: query description: >- Maximum number of current positions to return. Out-of-range values are clamped to 1..100. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: cursor in: query description: Pagination cursor from previous response's next_cursor. schema: type: string - name: consistency in: query description: >- live (default) reads the current value-ordered board. snapshot requires wallet and freezes up to 500 matching rows and 2 MB for up to five minutes. Keep consistency=snapshot and the same effective filters on every page; changing filters returns 400. A new first page from the same API key replaces its prior snapshot; replacement or expiry returns cursor_expired. schema: type: string enum: - live - snapshot default: live - name: min_size in: query description: >- Minimum current position value in USD. Defaults to 100 when omitted, or to 0 when wallet is present; send 0 to include every reconciled position. schema: type: number default: 100 - name: category in: query description: Exact match against provider-backed market_canonical.category. schema: type: string - name: condition_id in: query description: >- Scope to one market. Accepts the raw provider condition_id or the mkt_-prefixed market id emitted by V1 responses. Combine with min_size=0 for every reconciled position in that market; an unknown id returns []. schema: type: string - name: wallet in: query required: false description: >- Scope to one wallet or a book of wallets (repeatable, up to 25 per request; comma-separated values inside one occurrence also work). Each value is a wallet address, a known username, or a trd_-prefixed trader id, resolved like /api/v1/trader/{address}. The response keeps the board's order and cursor, so pages of a book interleave wallets by current_value_usd. An address this API has never tracked returns its mirror rows or an empty list; a username or trader id that resolves to nothing is a 404 naming wallet; more than 25 values is a 400. min_size defaults to 0 when wallet is present. schema: type: array items: type: string maxItems: 25 style: form explode: true - name: wallet[] in: query required: false description: >- Backward-compatible bracket alias for wallet. Repeatable; same values and limits. schema: type: array items: type: string maxItems: 25 style: form explode: true - name: min_grade in: query description: >- Minimum trader grade allowlist. `A` matches S and A; `B` matches S, A, B; etc. schema: type: string enum: - S - A - B - C - D - F - name: side in: query description: >- Filter by the binary outcome side. `yes` maps to outcome_index=0, `no` to outcome_index=1. schema: type: string enum: - 'yes' - 'no' - name: If-None-Match in: header required: false description: >- Conditional GET validator from a previous ETag. Matching values return 304 Not Modified with an empty body. schema: type: string responses: '200': description: Page of positions content: application/json: schema: type: object required: - object - data - data_quality - has_more - meta properties: object: type: string const: list data: type: array items: $ref: '#/components/schemas/Position' data_quality: $ref: '#/components/schemas/DataQuality' description: >- Writer-backed age and coverage for this page; it is part of the representation and the ETag, while transport cache facts remain in meta. has_more: type: boolean next_cursor: type: string total: type: integer description: >- Total matching rows when the read model exposes a count; the key is absent when it does not. snapshot: type: object description: >- Present only with consistency=snapshot. Dates the frozen response rows, not the provider's underlying observations. required: - as_of - expires_at - row_count properties: as_of: type: string format: date-time expires_at: type: string format: date-time row_count: type: integer meta: $ref: '#/components/schemas/ResponseMeta' examples: success: summary: Successful response value: object: list data: [] data_quality: status: partial field_groups: - group: positions owner: wallet_positions.last_reconciled_at|updated_at status: unknown reason: >- the page returned no served position rows from which to read this writer clock - group: trader owner: traders.last_synced status: unknown reason: >- the page returned no served position rows from which to read this writer clock - group: market owner: market_canonical.last_refreshed_at status: unknown reason: >- the page returned no served position rows from which to read this writer clock has_more: false total: 0 meta: request_id: req_example cached: false cost: 1 headers: X-Query-Ignored: $ref: '#/components/headers/X-Query-Ignored' X-Effective-Query: $ref: '#/components/headers/X-Effective-Query' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' ETag: $ref: '#/components/headers/ETag' X-Usage-Accounting: $ref: '#/components/headers/X-Usage-Accounting' Server-Timing: $ref: '#/components/headers/Server-Timing' '304': description: >- Not Modified. Returned when If-None-Match matches the current payload. headers: X-Query-Ignored: $ref: '#/components/headers/X-Query-Ignored' X-Effective-Query: $ref: '#/components/headers/X-Effective-Query' ETag: $ref: '#/components/headers/ETag' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' X-Usage-Accounting: $ref: '#/components/headers/X-Usage-Accounting' Server-Timing: $ref: '#/components/headers/Server-Timing' x-empty-body: true '400': description: Invalid request parameter content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/ApiError' '402': description: >- Active Pro subscription required. The key is valid but the account has no active Pro subscription; error.reason is subscription_inactive and error.message names the reactivation URL (https://0xinsider.com/billing). Permanent until a person reactivates: no Retry-After, never retry on a schedule. content: application/json: schema: $ref: '#/components/schemas/ApiError' '403': description: Account access denied content: application/json: schema: $ref: '#/components/schemas/ApiError' '404': description: >- A wallet value that resolves to no trader: a username or trd_-prefixed trader ID with no match. error.param is wallet. An address 0xinsider does not track is not an error; it returns the rows stored for it, or an empty list. content: application/json: schema: $ref: '#/components/schemas/ApiError' '408': description: >- The handler did not answer inside the server's 30-second timeout. error.code is request_timeout. On GET and HEAD the response carries Retry-After and error.retry_at; on a mutation it carries neither, because the request may have completed on the server: check its state before repeating it, and reuse its Idempotency-Key. content: application/json: schema: $ref: '#/components/schemas/ApiError' '423': description: Account is locked content: application/json: schema: $ref: '#/components/schemas/ApiError' '429': description: >- Rate limit exceeded. Three independent budgets. (1) 100 requests/minute per user (sliding window), on every authenticated route. (2) On the BATCH routes only: 2500 batch item units/minute per user, reserved before any item is executed. A batch with N requested items costs N item units, including duplicate and invalid items. 2500 = 100 requests x 25 items per batch, which is the most item work a key can buy through the request limiter at all: a caller may spend their entire 100-request minute on full 25-item batches without the item budget being what stops them. The REQUEST budget is the effective ceiling, and batching is never the more expensive choice. The item budget can still deny at a sliding-window boundary (both counters carry the previous window forward with a floor, and the item counter runs 25x the request counter), so honor a 429 from either. Over-quota batches return 429 with Retry-After plus RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset before any item work is done. (3) The monthly quota: Pro includes 500,000 and Max includes 2,000,000 authenticated requests per UTC calendar month. Over the plan's included requests: with pay as you go on, the excess bills at USD 0.20 per 1,000 on a monthly invoice, up to four times the included allowance (2,000,000 requests for Pro); without it, from October 1, 2026, the next request answers 429 rate_limited with error.reason monthly_quota_exceeded and a Retry-After to the month's reset. Pay-as-you-go accounts receive the same refusal at their ceiling. A refused request is not counted. Every authenticated response carries X-Monthly-Quota-Limit, X-Monthly-Quota-Remaining, and X-Monthly-Quota-Reset (unix seconds, the first of next month). (4) The per-address budget: 1200 requests/minute per IP, shared by every caller behind one address and counted before authentication, on every route. A 429 from it carries error.reason ip_rate_limited and describes that bucket in RateLimit-*; a throttled address (sustained over-limit traffic) carries error.reason ip_throttled with a Retry-After of minutes to days, and a request before it does not shorten the cooldown. Every 429 is the standard error envelope with meta.request_id equal to X-Request-Id. headers: Retry-After: description: Seconds until rate limit resets. schema: type: integer RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' X-RateLimit-Limit: schema: type: integer X-RateLimit-Remaining: schema: type: integer X-RateLimit-Reset: schema: type: integer X-Request-Id: schema: type: string content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Unexpected server error content: application/json: schema: $ref: '#/components/schemas/ApiError' '503': description: >- Redis-backed authenticated rate limiter unavailable; retry after the per-process outage cooldown headers: Retry-After: description: >- Seconds until the middleware will probe the Redis-backed rate limiter again. schema: type: integer X-Request-Id: schema: type: string content: application/json: schema: $ref: '#/components/schemas/ApiError' x-codeSamples: - lang: curl label: cURL source: |- curl -sS \ -H "Authorization: Bearer $OXINSIDER_API_KEY" \ 'https://api.0xinsider.com/api/v1/positions' - lang: curl label: cURL (one market, every size) source: |- curl -sS \ -H "Authorization: Bearer $OXINSIDER_API_KEY" \ 'https://api.0xinsider.com/api/v1/positions?condition_id=0x...&min_size=0&limit=100' components: schemas: Position: type: object required: - id - platform - wallet - side - token_id - shares - current_value_usd - freshness - trader - market properties: id: type: string description: Composite prefixed ID `pos_::`. platform: type: string enum: - polymarket description: Provider discriminator. Polymarket only. wallet: type: string description: Lowercased proxy wallet address. side: type: string enum: - 'YES' - 'NO' description: Binary outcome side. Non-binary positions are not surfaced on V1. token_id: type: string nullable: true description: >- The Polymarket CLOB token id (ERC1155 asset id, decimal string) for this outcome; null when unavailable (e.g. unsynced markets). shares: type: number description: Live share count from the wallet_positions mirror. avg_price: type: number description: Volume-weighted entry price for this leg. current_value_usd: type: number description: >- Current mark-to-market value in USD (always non-null on V1 — pre-reconcile rows are excluded). initial_value_usd: type: number cash_pnl: type: number description: Unrealized P&L for the open position (Polymarket `cashPnl`). realized_pnl: type: number description: Closed-leg P&L rolled up (Polymarket `realizedPnl`). exact: $ref: '#/components/schemas/PositionExact' description: >- Additive lossless source atoms for the display-safe position fields. Parse every `value` with decimal-safe arithmetic; never recover exact values from the numeric twins. last_reconciled_at: type: string format: date-time description: Max updated_at across mirror legs for this pair. freshness: type: string enum: - fresh - refreshing - stale - unknown description: Backend-computed staleness bucket derived from last_reconciled_at. trader: type: object required: - id - address - is_new_wallet properties: id: type: string description: Prefixed ID (`trd_...`). address: type: string username: type: string grade: type: string enum: - S - A - B - C - D - F win_rate: type: number description: Percentage 0-100. pnl: type: number markets: type: integer wallet_age_days: type: number is_new_wallet: type: boolean description: >- True when 0xinsider first recorded the wallet within the new-wallet threshold (30 days). This public V1 field is first-seen recency, not the wallet's on-chain age. market: type: object required: - id - condition_id - title properties: id: type: string description: Prefixed ID (`mkt_...`). condition_id: type: string title: type: string slug: type: string event_slug: type: string category: type: string description: Provider-backed market_canonical category. outcome_label: type: string description: >- Provider-reported outcome label (e.g. team name for sports). Separate from `side` because provider labels can diverge from the binary Yes/No axis. end_date: type: string format: date-time DataQuality: type: object description: >- Compact data age and coverage for a response body, always present on the operations that publish it. Read status and as_of to decide whether to use the body at all, and field_groups to see which part is weak. Everything here comes from stored observation clocks, so a cached body reports the same ages a freshly computed one does: meta.cached and meta.cache_age_s stay the only transport-time facts and neither makes this block newer. The per-field audit object is still available through expand=trust; this is the default summary of the same question. required: - status - field_groups properties: status: type: string enum: - fresh - partial - unknown - untracked - unavailable description: >- fresh when every group is fresh, unavailable when every group is unavailable, and partial in every other case. as_of: type: string format: date-time description: >- The oldest as_of among the groups that carry one: the age of the weakest clock this body rests on. Omitted when no group carries a clock. field_groups: type: array items: $ref: '#/components/schemas/DataQualityGroup' description: >- One entry per field group. Entries may be added in later releases, so match on group rather than on position or length. ResponseMeta: type: object required: - request_id - cached - cost properties: request_id: type: string description: >- Unique request ID (req_ prefix). The same value as the X-Request-Id response header, the request's usage accounting row and its log lines. cached: type: boolean cache_age_s: type: integer description: >- Cache age in seconds. Omitted when the response was not cached, and also when it was cached but its age cannot be established (an entry stored before its cache carried a computed instant). Never a placeholder: an unknown age is reported as no value rather than as the cache TTL. cost: type: integer description: >- Advisory request weight (relative compute cost). 1 for simple reads; higher for heavier endpoints. Not a credit/price. ranking_generation: type: integer description: >- Committed PostgreSQL-owned leaderboard generation for the returned rows and cursor. Present on GET /api/v1/leaderboard; omitted on endpoints that do not read this ranking. ranking_as_of: type: string format: date-time description: >- Authoritative RFC3339 timestamp from cache_generations.updated_at for ranking_generation. It is read in the same repeatable-read snapshot as the leaderboard rows and is not request time, cache write time, or row insertion order. directional_source: type: string enum: - live - degraded description: >- Which path produced the team-directional read on this response. Only present on endpoints that compute one (today: GET /api/v1/sports-edge-signals). "live" means the read RAN. "degraded" means it FAILED, so nothing was measured and the ranking fell back to raw conviction. The flag describes the READ, not its consequence: a read that ran and found nothing groupable also leaves the directional fields null, and that is honestly "live" -- the per-signal nulls already say "nothing to enrich here", so this snapshot-level flag carries only what they cannot, namely whether the read ran at all. A degraded response is cached on the shorter degraded TTL so it self-heals. Reported SEPARATELY from ranking_source because the two degradations are independent -- a sharp-money DB miss weakens the ranking DATA, a directional failure removes a ranking WEIGHT -- and a consumer down-weighting a degraded response needs to know which input it lost. Omitted on endpoints that compute no directional read. ranking_source: type: string enum: - live - db_only description: >- Which ranking-data path produced this response. Only present on endpoints that can degrade a ranking (today: GET /api/v1/sports-edge-signals). "live" is the normal path (the current holder pile from the provider batch); "db_only" is the degraded fallback (a truthful but weaker trader_markets ranking) served when the live sharp-money ranking batch is unavailable (a sharp-money DB read failure, not a Polymarket outage) and cached on a shorter TTL, so a consumer can down-weight or skip it. Omitted on endpoints that never degrade. category_skill_source: type: string enum: - live - partial - degraded - unavailable description: >- Whole filtered snapshot category-evidence status before pagination. Operational live always remains partial source coverage. category_skill_model_version: type: string category_skill_taxonomy_version: type: string category_skill_platform: type: string const: polymarket category_skill_scope: type: string const: observed_goldsky_primary_taker_fill category_skill_source_coverage: type: string enum: - partial_whale_threshold_fills - graded_wallet_fills category_skill_observation_started_at: type: string format: date-time category_skill_model_operationally_degraded: type: boolean description: >- Whole-model operational readiness captured with the category model snapshot. Present on category-enriched responses even when the filtered signal list is empty. When true, category_skill_source is degraded and sports-edge-signals uses the shorter degraded cache TTL. category_skill_status_counts: type: object required: - live - insufficient - stale - unknown - degraded properties: live: type: integer minimum: 0 insufficient: type: integer minimum: 0 stale: type: integer minimum: 0 unknown: type: integer minimum: 0 degraded: type: integer minimum: 0 category_skill_base_payload_hash: type: string pattern: ^[0-9a-f]{64}$ description: >- SHA-256 of the funded signal membership/order/rank/cursor vector immediately before category-skill enrichment. Sports-edge-signals only. category_skill_enriched_base_payload_hash: type: string pattern: ^[0-9a-f]{64}$ description: >- Independent SHA-256 recomputation over the same base fields immediately after category-skill enrichment. Equality with category_skill_base_payload_hash proves shadow enrichment did not change funded inputs. Sports-edge-signals only. ApiError: type: object required: - object - error - meta properties: object: type: string const: error error: type: object required: - code - message properties: code: type: string description: >- FROZEN: an existing value never changes meaning. request_timeout (408, #16146) was added the way insufficient_scope was: the handler did not answer inside the server's 30-second timeout. Retry-After and retry_at ride on it only for a safe method (GET, HEAD); a timed-out mutation may have completed, so check its state and reuse its Idempotency-Key. enum: - bad_request - invalid_api_key - subscription_required - forbidden - insufficient_scope - not_found - account_locked - rate_limited - rate_limit_unavailable - internal_error - request_timeout message: type: string doc_url: type: string param: type: string retry_at: type: string format: date-time description: >- The recommended next request instant (RFC3339), always in the future. Present on every retryable error: `pick_not_released`, `rate_limited`, `rate_limit_unavailable`, and `read_model_warming`. Omitted otherwise. The absolute twin of `Retry-After`; prefer the header for the sleep duration. For `pick_not_released`, the earliest of the next scheduled release, the next automatic selector attempt, the operating-window start, or about 60 seconds. See that response. freshness: $ref: '#/components/schemas/FreshnessFailure' reason: type: string enum: - cursor_expired - unknown_endpoint - pick_not_released - trader_not_tracked - read_model_warming - database_unavailable - request_accounting_unavailable - idempotency_in_progress - webhook_delivery_in_progress - webhook_secret_rotation_not_prepared - webhook_secret_rotation_overlap_active - sandbox_api_key - api_key_in_query - subscription_inactive - monthly_quota_exceeded - invalid_query - unknown_query_parameter - invalid_path - invalid_body - unsupported_media_type - payload_too_large - method_not_allowed - ip_rate_limited - ip_throttled - export_expired - freshness_ceiling_unsatisfied description: >- ADDITIVE (#7209). The specific, actionable cause behind `code`, when there is one more specific than the code itself. `code` keeps its published values, so existing clients are unaffected; new clients branch on `reason`. Omitted when the code already says everything we know. pick_not_released: no Pick of the Day is published for the current product day; schedule one request against retry_at instead of polling. unknown_endpoint: the PATH is not a route on this API -- read GET /api/v1, do not retry. trader_not_tracked: the wallet is real and the URL is right, but the trader is outside the HOT/WARM sync tiers -- stop asking for this wallet. cursor_expired: pagination went stale mid-walk -- re-request the first page and continue. read_model_warming: the requested endpoint cannot serve its read model yet; exact causes are endpoint-specific and can include a cold or contended refresh or a dependency that prevented refresh. database_unavailable: the API's database or its connection pool is temporarily unreachable (a connection-class failure, not a query fault); code stays rate_limit_unavailable, nothing is rate-limited, retry after Retry-After / retry_at. idempotency_in_progress: retain the exact Idempotency-Key and request body, then retry shortly. webhook_delivery_in_progress: retry the URL or signing-secret configuration change after the destination's active request completes. request_accounting_unavailable: accounting capacity is unavailable before the handler executes; retry after Retry-After / retry_at. sandbox_api_key: the credential is a sandbox key (oxi_sk_test_) from POST /api/v1/agents/register, which only the sandbox server accepts -- call the sandbox base URL with it, or get a live key or OAuth access token; do not retry it here. api_key_in_query: the key was sent as a ?token= query parameter, which no route reads because URLs land in logs and history; the key itself was not checked -- resend it as Authorization: Bearer. subscription_inactive: the key is valid but the account's Pro subscription has lapsed (402 subscription_required); permanent until a person reactivates at https://0xinsider.com/billing, which the message names -- stop retrying on a schedule and surface the link. The key owner is emailed once per lapse. monthly_quota_exceeded: the account has used the requests its plan includes for the UTC calendar month (429 rate_limited); retry_at and Retry-After name the first of next month, the only retry that can succeed, and the message names https://0xinsider.com/developers, where pay as you go for requests over the quota is turned on. The X-Monthly-Quota-Limit, X-Monthly-Quota-Remaining and X-Monthly-Quota-Reset headers on every authenticated response say how close the account is. invalid_query, invalid_path, invalid_body (400 bad_request, #16146): a query parameter, a path segment or the JSON body did not parse or does not fit the route's schema, so no handler ran; param names the field when the parser named one (a query key, a path segment, a JSON path such as traders[0], or body); fix the request, never retry it as sent. unsupported_media_type (415 bad_request, param content-type): send the body with Content-Type: application/json. payload_too_large (413 bad_request, param body): the body is over 1048576 bytes. method_not_allowed (405 bad_request): the path is a route but not with this method; the Allow header names the methods it serves. ip_rate_limited (429 rate_limited, #16380): the per-address budget every caller behind one IP shares, counted before authentication, is spent; not the key's own window, and the RateLimit-* headers describe that bucket. ip_throttled (429 rate_limited): the address is in a cooldown after sustained over-limit traffic; Retry-After is minutes to days, and a request before it does not shorten the cooldown. meta: $ref: '#/components/schemas/ResponseMeta' PositionExact: type: object required: - shares - current_value_usd description: >- Lossless position atoms from `wallet_positions`. `shares` and `current_value_usd` are required when this object is present; other source values are omitted when the mirror has no verified value. properties: shares: $ref: '#/components/schemas/ExactDecimal' cost_basis_usd: $ref: '#/components/schemas/ExactDecimal' avg_price: $ref: '#/components/schemas/ExactDecimal' description: >- Exact derived price: `wallet_positions.cost_basis_usd / wallet_positions.shares`. current_value_usd: $ref: '#/components/schemas/ExactDecimal' initial_value_usd: $ref: '#/components/schemas/ExactDecimal' cash_pnl: $ref: '#/components/schemas/ExactDecimal' realized_pnl: $ref: '#/components/schemas/ExactDecimal' DataQualityGroup: type: object description: >- One group of response fields that share a writer and therefore share a clock. required: - group - owner - status properties: group: type: string description: >- Stable snake_case group name. Names are additive across releases, so match on the ones you know and ignore the rest. owner: type: string description: >- The table and column that write this group, named so the verdict can be audited (for example trader_rankings.computed_at). status: type: string enum: - fresh - partial - unknown - untracked - unavailable description: >- fresh: served, and as_of carries this group's real observation or computation clock. partial: some of the group's fields are served and some are missing. unknown: served, and this read has no clock for it, so no age may be inferred. untracked: 0xinsider does not track this group for this subject, by design. unavailable: the group could not be served. New values may be added; treat one you do not recognize as unknown. fresh means the group is tracked and clocked, not that it is inside any particular tolerance: compare as_of against your own. as_of: type: string format: date-time description: >- When this group's values were observed or computed. Omitted whenever the read cannot measure it, and never filled with the serialization time, the cache time, or another group's clock. reason: type: string description: Why the status is not fresh. Omitted when it is. FreshnessFailure: type: object required: - max_age_s - data_quality_status properties: max_age_s: type: integer format: int64 minimum: 0 description: The caller's requested whole-response freshness ceiling in seconds. actual_age_s: type: integer format: int64 minimum: 0 description: >- Age in seconds of the oldest stored data_quality.as_of clock, when one is available. as_of: type: string format: date-time description: >- The oldest stored data-quality clock used to calculate actual_age_s, when one is available. data_quality_status: type: string enum: - fresh - partial - unknown - untracked - unavailable description: >- The trader body's whole-response data-quality status. Only fresh can satisfy max_age_s. ExactDecimal: type: object required: - value - unit - scale - basis description: >- A lossless decimal atom rendered from the canonical NUMERIC or provider value. The value is a decimal string and must be parsed with a decimal library; it is never a display string and must not be converted through a binary float. `scale` is the source decimal scale. The field is omitted when its source is unavailable. properties: value: type: string description: >- Plain decimal text at full source precision, including a minus sign for negative values and trailing zeros when the source scale carries them. Parse as an arbitrary-precision decimal. pattern: ^-?(0|[1-9][0-9]*)(\.[0-9]+)?$ unit: type: string description: Unit of the value, such as `USD`, `USD/share`, or `shares`. scale: type: integer minimum: 0 description: Number of digits after the decimal point in `value`'s source atom. basis: type: string description: >- Backend-owned source or derivation basis. Treat it as provenance, not as a display label. headers: X-Query-Ignored: description: >- Comma-separated, percent-encoded query names the operation did not publish and therefore ignored in compatible mode. Names are sorted and de-duplicated. schema: type: string X-Effective-Query: description: >- Normalized, percent-encoded query string containing only the recognized names and values applied by the operation. Query names and values use form-urlencoded decoding, where + is a space. Repeated names are retained and sorted by name. A limit outside the operation's published minimum..maximum is reported as the clamped value the page used, so the header states the page size served rather than the one requested. schema: type: string RateLimit-Limit: description: >- Request limit of the budget this request was counted against, for its current window: the API key's per-minute sliding window on an authenticated call; the per-IP budget on a public route and on a refused credential (401, 402, 403, 423), which never reaches the per-key limiter. Standard RateLimit header spelling. schema: type: integer example: 100 RateLimit-Remaining: description: >- Requests remaining in that budget's current window after this response. Standard RateLimit header spelling. schema: type: integer example: 84 RateLimit-Reset: description: >- Seconds until that budget's current window resets. Standard RateLimit header spelling. schema: type: integer example: 42 X-RateLimit-Limit: description: >- Request limit of the budget this request was counted against, for its current window: the API key's per-minute sliding window on an authenticated call; the per-IP budget on a public route and on a refused credential (401, 402, 403, 423). schema: type: integer example: 100 X-RateLimit-Remaining: description: Requests remaining in that budget's current window after this response. schema: type: integer example: 84 X-RateLimit-Reset: description: Unix timestamp when that budget's current window resets. schema: type: integer example: 1710772860 X-Request-Id: description: >- Server-generated request identifier for support and tracing. On every /api/v1 response, including 304, 408, CORS preflights and every error, and always equal to meta.request_id in the body. It is the key of the request's usage accounting row and of every log line the request emitted, so quote either form to support. A client-supplied X-Request-Id request header is ignored: the value is never adopted or echoed. schema: type: string example: req_550e8400 ETag: description: >- Weak semantic validator for conditional GET. Request-specific response metadata is excluded; send as If-None-Match to receive 304 when the stable payload is unchanged. schema: type: string example: W/"8f14e45fceea167a5a36dedd4bea2543" X-Usage-Accounting: description: >- Usage-record persistence for a protected V1 handler response. persisted: confirmed row; failed: write failed; unknown: completion could not be confirmed. Independent of handler success; do not replay successful mutations to repair accounting. Absent before accounting admission and on public routes. The zero-cost /api/v1/usage route also omits it. schema: type: string enum: - persisted - failed - unknown Server-Timing: description: >- Processing time in milliseconds, for example api;dur=12.345. Includes API authentication, quota admission, handler work and response construction. Excludes network transit and streamed body or export-file transfer. The engineering budget is strictly below 250 ms; this header reports observations, not a latency guarantee or a new timeout. schema: type: string example: api;dur=12.345 securitySchemes: bearerAuth: type: http scheme: bearer description: >- Legacy default or named integration API key, or OAuth 2.1 access token, in the Authorization header as `Bearer oxi_sk_live_...` or `Bearer oxi_at_...`. Default keys retain full access; integration keys are limited to their approved read, webhooks, export and usage scopes and expire within 90 days. All credentials share the owner's account limits. Data calls require an active Pro subscription and return live data. A 401 carries WWW-Authenticate: Bearer resource_metadata="https://api.0xinsider.com/.well-known/oauth-protected-resource" (RFC 6750 section 3, RFC 9728). oauth2: type: oauth2 description: >- OAuth 2.1 authorization code flow with PKCE S256 for apps and MCP clients acting for a user. Public clients only (no client secret): register with RFC 7591 at https://api.0xinsider.com/oauth/register or present an https client ID metadata document URL as client_id. Authorization server metadata: https://api.0xinsider.com/.well-known/oauth-authorization-server. The access token (oxi_at_..., one hour) is sent as `Authorization: Bearer`; refresh tokens rotate on every use. A route outside the token's scopes answers 403 insufficient_scope. Walkthrough: https://0xinsider.com/auth.md. flows: authorizationCode: authorizationUrl: https://0xinsider.com/oauth/authorize tokenUrl: https://api.0xinsider.com/oauth/token refreshUrl: https://api.0xinsider.com/oauth/token scopes: read: >- Read markets, traders, large trades, positions, reports, search, the event stream and every MCP tool webhooks: Create, list, verify, rotate and delete webhook endpoints export: Start, poll and download trader exports usage: Read the caller's API usage counters ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.