> ## 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. # Batch market flow > Get whale flow for 1 to 25 Polymarket markets in one request, with one result row per input, in the order you sent them. Use this when you already hold several of Polymarket's own market ids and want the flow on each of them. For a single market, or when the id you hold is a `mkt_` id, use [Market flow](/api-reference/endpoint/get-market-flow). ## Parameters | Parameter | Description | | --------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `condition_ids` | Required. 1 to 25 of Polymarket's own market ids, in the body. Duplicates are allowed, and each one gets its own result row. | | `timeframe` | The window the flow is measured over: `1h`, `4h`, `24h` (the default), or `7d`. One value covers every market in the batch. | An empty array, more than 25 ids, or a `timeframe` outside that list fails the whole request with `400` before any market is read. A body over `1048576` bytes answers `413` with `error.reason` `payload_too_large`. A body sent without `Content-Type: application/json` answers `415` with `error.reason` `unsupported_media_type`. ## Key response fields | Field | Meaning | | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `data[].index` | Where this market sat in `condition_ids`, counting from 0. | | `data[].input` | The id exactly as you sent it. | | `data[].status` | `ok`, with `data` in the Market intel shape, or `error`, with `error.code`, `error.message`, and `error.param`. | | `data[].error.code` | `bad_request` when you sent a `mkt_` id, `not_found` when 0xinsider has no such market. The response itself stays `200` either way. | | `meta.request_cost` | How many batch item units this request reserved before reading anything: 1 for every id you sent, duplicates and bad ids included. The `X-Request-Cost` header carries the same number. | | `meta.rate_limit` | Your remaining item budget: `basis` (always `batch_items_per_minute`), `limit`, `remaining`, and `reset` as a Unix timestamp. The `X-Batch-RateLimit-Limit`, `X-Batch-RateLimit-Remaining`, and `X-Batch-RateLimit-Reset` headers carry the same three numbers. | | `meta.total_items`, `meta.successful_items`, `meta.failed_items` | How many ids you sent, how many came back `ok`, and how many came back `error`. | ## Item budget This route spends from a second budget: 2,500 batch item units a minute per account, alongside the 100 requests a minute every authenticated route shares. 100 requests of 25 ids each comes to exactly 2,500, so a full batch is never the more expensive choice. Going over answers `429` with a `Retry-After`, before any market is read. ## Example ```bash theme={null} curl -X POST \ -H "Authorization: Bearer $OXINSIDER_API_KEY" \ -H "Content-Type: application/json" \ -d '{"condition_ids": ["0x123...", "0x456..."], "timeframe": "24h"}' \ "https://api.0xinsider.com/api/v1/markets/flow/batch" ``` ## What it does not return * A `mkt_` id resolved to a market. Send `market.condition_id` from [Search markets](/api-reference/endpoint/search-markets) or [Explore markets](/api-reference/endpoint/explore-markets) instead. * An `ETag`. This route has no conditional read. * Partial work after a bad request body. A `400` means no market was read at all. * A different shape per item. An `ok` item holds exactly what the single route returns. ## OpenAPI ````yaml POST /api/v1/markets/flow/batch 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. 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/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. 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/markets/flow/batch: post: tags: - Markets summary: Batch market flow description: >- Returns each market's flow and top positions for 1-25 raw provider condition_id values. Results preserve request order, duplicate inputs return duplicate rows, and each item is charged one batch item unit before execution. Do not pass prefixed mkt_ IDs; use market.condition_id from search or explore. operationId: batchGetMarketFlow 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 requestBody: description: >- Batch market-flow request. Supply 1-25 condition IDs and an optional shared timeframe. required: true content: application/json: schema: type: object required: - condition_ids properties: condition_ids: type: array minItems: 1 maxItems: 25 description: Market condition IDs to resolve in input order. items: type: string timeframe: type: string description: Lookback window used for flow and trade-count context. enum: - 1h - 4h - 24h - 7d default: 24h example: condition_ids: - '0x1234567890abcdef' timeframe: 24h responses: '200': description: Ordered batch market-flow results headers: X-Query-Ignored: $ref: '#/components/headers/X-Query-Ignored' X-Effective-Query: $ref: '#/components/headers/X-Effective-Query' X-Request-Cost: schema: type: integer description: Number of batch item units charged for this request. 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-Batch-RateLimit-Limit: schema: type: integer description: Batch item units allowed per minute. X-Batch-RateLimit-Remaining: schema: type: integer description: Batch item units remaining in the current sliding window. X-Batch-RateLimit-Reset: schema: type: integer description: Unix timestamp when the batch item window resets. 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' content: application/json: schema: type: object required: - object - data - meta properties: object: type: string const: market_flow_batch data: type: array items: $ref: '#/components/schemas/BatchMarketFlowItem' meta: $ref: '#/components/schemas/BatchResponseMeta' examples: success: summary: Successful response value: object: market_flow_batch data: - index: 0 input: >- 0xabc1230000000000000000000000000000000abc2e8ec47636c7803c1033cfab status: ok data: market: id: >- mkt_0xabc1230000000000000000000000000000000abc2e8ec47636c7803c1033cfab condition_id: >- 0xabc1230000000000000000000000000000000abc2e8ec47636c7803c1033cfab title: Will the Sacramento Kings win the 2025 NBA Finals? slug: will-the-sacramento-kings-win-the-2025-nba-finals category: NBA platform: polymarket sharp_money: net_flow_usd: 0 direction: 'YES' token_id: >- 41257670817876317355997233596113195194194608207987371129645019730826567930842 large_trade_count: 0 whale_trade_count: 0 buy_volume_usd: 0 sell_volume_usd: 0 top_positions: [] oldest_snapshot_as_of: null smart_money: net_flow_usd: 0 direction: 'YES' token_id: >- 41257670817876317355997233596113195194194608207987371129645019730826567930842 large_trade_count: 0 whale_trade_count: 0 buy_volume_usd: 0 sell_volume_usd: 0 top_positions: [] oldest_snapshot_as_of: null timeframe: 24h - index: 1 input: >- 0xdef4560000000000000000000000000000000def000000000000000000000001 status: error error: code: not_found message: >- Market 0xdef4560000000000000000000000000000000def000000000000000000000001 not found. meta: request_id: req_example cached: false total_items: 2 successful_items: 1 failed_items: 1 request_cost: 2 rate_limit: basis: batch_items_per_minute limit: 2500 remaining: 2489 reset: 1790047440 '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' '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' '413': description: >- The request body is over 1048576 bytes. error.code is bad_request, error.reason is payload_too_large and error.param is body. content: application/json: schema: $ref: '#/components/schemas/ApiError' '415': description: >- The body was not sent as Content-Type: application/json. error.code is bad_request, error.reason is unsupported_media_type and error.param is content-type. 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 250,000 authenticated requests per UTC calendar month, whatever the billing cadence. Over 250,000: with pay as you go on, requests keep answering and the excess bills at USD 0.20 per 1,000 on a monthly invoice, up to 1,000,000 requests a month; 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, and from the same day a pay-as-you-go account answers the same past 1,000,000. 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 \ -X POST \ -H "Authorization: Bearer $OXINSIDER_API_KEY" \ -H 'Content-Type: application/json' \ -d '{"condition_ids":["0x1234567890abcdef"],"timeframe":"24h"}' \ 'https://api.0xinsider.com/api/v1/markets/flow/batch' components: 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. 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 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 schemas: BatchMarketFlowItem: type: object required: - index - input - status properties: index: type: integer description: >- Zero-based request index. Duplicate inputs keep separate result rows. input: type: string status: type: string enum: - ok - error data: $ref: '#/components/schemas/MarketFlow' error: $ref: '#/components/schemas/ApiErrorBody' BatchResponseMeta: type: object required: - request_id - cached - total_items - successful_items - failed_items - request_cost - rate_limit 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 total_items: type: integer successful_items: type: integer failed_items: type: integer request_cost: type: integer description: Number of batch item units reserved before execution. rate_limit: $ref: '#/components/schemas/BatchRateLimitMeta' 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 Pro 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' MarketFlow: type: object required: - market - sharp_money - smart_money - timeframe properties: market: type: object required: - id - condition_id - title - slug - category - platform properties: id: type: string condition_id: type: string title: type: string slug: type: string nullable: true category: type: string nullable: true platform: type: string nullable: true sharp_money: type: object description: >- Outcome-aware flow from all tracked whale trades in the window, without a grade filter. BUY YES and SELL NO add net exposure; BUY NO and SELL YES subtract it. Gross buy/sell volumes count both outcomes. Top positions are separately graded. Direction uses unrounded net: negative is NO, otherwise YES; the zero tie-break is not conviction. Canonical; smart_money is a deprecated byte-identical alias. required: - net_flow_usd - direction - token_id - whale_trade_count - buy_volume_usd - sell_volume_usd - top_positions - oldest_snapshot_as_of properties: net_flow_usd: type: number direction: type: string enum: - 'YES' - 'NO' token_id: type: string nullable: true description: >- The Polymarket CLOB token id (ERC1155 asset id, decimal string) for the net-flow direction outcome; null when unavailable (e.g. unsynced markets). large_trade_count: description: >- Canonical key since #16304 (Polymarket's noun is large trade); whale_trade_count is its deprecated spelling, emitted beside it with the same value. type: integer whale_trade_count: type: integer buy_volume_usd: type: number sell_volume_usd: type: number top_positions: type: array items: type: object required: - id - address - username - grade - side - token_id - size_usd properties: id: type: string address: type: string username: type: string nullable: true grade: type: string nullable: true side: type: string enum: - 'YES' - 'NO' 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). size_usd: type: number oldest_snapshot_as_of: type: string format: date-time nullable: true description: >- Age of the oldest stored position snapshot behind top_positions: the minimum wallet sync clock over the positions this body publishes. The roster is a stored read rather than a live one, and graded wallets sit on different sync tiers, so this names how current the whole roster is; the response is no fresher than this timestamp. Null when the roster is empty or no published position carries a sync clock. It does not date net_flow_usd, the volumes or the trade counts, which come from large-trade event times. smart_money: type: object deprecated: true description: >- Deprecated alias of sharp_money; byte-identical and retained for backward compatibility. required: - net_flow_usd - direction - token_id - whale_trade_count - buy_volume_usd - sell_volume_usd - top_positions - oldest_snapshot_as_of properties: net_flow_usd: type: number direction: type: string enum: - 'YES' - 'NO' token_id: type: string nullable: true description: >- The Polymarket CLOB token id (ERC1155 asset id, decimal string) for the net-flow direction outcome; null when unavailable (e.g. unsynced markets). large_trade_count: description: >- Canonical key since #16304 (Polymarket's noun is large trade); whale_trade_count is its deprecated spelling, emitted beside it with the same value. type: integer whale_trade_count: type: integer buy_volume_usd: type: number sell_volume_usd: type: number top_positions: type: array items: type: object required: - id - address - username - grade - side - token_id - size_usd properties: id: type: string address: type: string username: type: string nullable: true grade: type: string nullable: true side: type: string enum: - 'YES' - 'NO' 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). size_usd: type: number oldest_snapshot_as_of: type: string format: date-time nullable: true description: >- Age of the oldest stored position snapshot behind top_positions: the minimum wallet sync clock over the positions this body publishes. The roster is a stored read rather than a live one, and graded wallets sit on different sync tiers, so this names how current the whole roster is; the response is no fresher than this timestamp. Null when the roster is empty or no published position carries a sync clock. It does not date net_flow_usd, the volumes or the trade counts, which come from large-trade event times. timeframe: type: string ApiErrorBody: 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 retry instant (RFC3339). Present on every retryable error (reason=pick_not_released, code=rate_limited including reason=monthly_quota_exceeded, code=rate_limit_unavailable, reason=read_model_warming) and omitted otherwise. Always in the future. For pick_not_released: before the 11:00 UTC operating-window start, before a selected pick's stored release, or after a skipped day, it names the automatic system's next boundary. While no candidate exists in the live window it normally names the persisted next automatic selector attempt. Every value is advisory and can change before release. When the automatic schedule is absent/due or a pick is overdue it degrades to ~60s. Schedule one request and do not poll. Prefer Retry-After for the duration because it is immune to client clock skew. 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 Pro 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. BatchRateLimitMeta: type: object required: - basis - limit - remaining - reset properties: basis: type: string const: batch_items_per_minute limit: type: integer remaining: type: integer reset: type: integer description: Unix timestamp when the batch item window resets. 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. 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. 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 ````