> ## Documentation Index > Fetch the complete documentation index at: https://docs.xo.market/llms.txt > Use this file to discover all available pages before exploring further. # Market programme config > **Requires `Authorization: Bearer `.** Multi-rail market config: every enrolled programme (CP and/or USDC) in one response. Same payload as the public config route. ## OpenAPI ````yaml /data-api-reference/openapi.yaml get /liquidity-rewards/markets/{marketId}/config openapi: 3.0.3 info: title: XO Data API description: > Public HTTP routes for **market discovery, portfolio reads, and related metadata**, served by the NestJS [`xo-backend`](https://github.com/xo-market/xo) service on the app host (`https://api-mainnet.xo.market`). These endpoints are intentionally separate from the CLOB orderbook REST surface (`openapi.yaml`). Use them to: * list markets and apply filters (status, category, scope, search), * resolve a market by numeric id, by `conditionId`/wrapper address, or by slug, * list short-horizon **Pulse** markets (e.g. BTC 5-minute windows) and fetch a single pulse market by on-chain address, * read a user's public portfolio via `GET /users/portfolio`, and * read **liquidity rewards** (public discovery plus Privy-authenticated `/me` routes). Real-time portfolio snapshots are delivered over the unauthenticated Socket.IO namespace `/portfolio-public`. See the [Portfolio WebSocket](/data-api-reference/portfolio-websocket) guide. All paths use the service `/api` global prefix. In non-production deployments, the full generated Swagger document is available at `/swagger` on the same host. ### Rate limits Data API REST routes share a budget of **100 requests per 10 seconds** per client IP. `/public/liquidity-rewards/*` is throttled separately at **30 requests per 10 seconds**. ### Wire conventions * Pagination is page-based: `page` (1-indexed) and `take` (or `limit` for the Pulse routes). Liquidity-rewards proxied pages use 0-indexed `page` and `page_size`. * Numeric ids are integers; `conditionId` values are `0x`-prefixed 32-byte hex strings. Use `conditionId` as `marketId` on liquidity-rewards routes. * Volume strings are decimal (USD) or WEI-encoded (token), depending on the field name (`totalVolumeInUSD` vs `totalVolume`). * Liquidity-rewards amounts and scores are decimal **strings**. Catalogue/summary BFFs are camelCase; proxied maker/market-day payloads are snake_case. * Authenticated `/liquidity-rewards/*` routes require `Authorization: Bearer `. The `/public/liquidity-rewards/*` prefix does not. ### Market scope for market makers The `/markets` endpoint accepts a `marketScope` query parameter that maps to the on-chain `IXOMarketV1.MarketType` enum (`STANDARD=0`, `PULSE=1`, `CLOB=2`, `CLOB_PULSE=3`). Market makers integrating against the XO CLOB **should only use**: * `onlyClob` — `CLOB` + `CLOB_PULSE` (orderbook markets, both long-form and pulse). * `onlyClobPulse` — `CLOB_PULSE` only (BTC 5-minute pulse). The remaining scopes (`default`, `withClob`, `withPulse`, `onlyPulse`) include `STANDARD` and/or `PULSE` markets, which are **LMSR AMM** deployments and are not tradable through the CLOB orderbook. Ignore those scopes (and rows where `market.type` is `0` or `1`) for MM use. version: 1.0.0 contact: name: XO Market url: https://beta.xo.market servers: - url: https://api-mainnet.xo.market/api description: Production xo-backend (XO mainnet, chainId 3223) security: [] tags: - name: Markets description: Market list, filtering, and per-market metadata. - name: Pulse Markets description: Short-horizon (e.g. BTC 5-minute) Pulse markets. - name: Portfolio description: Unauthenticated public portfolio reads. - name: Liquidity Rewards (public) description: | Unauthenticated liquidity-rewards reads under `/public/liquidity-rewards`. No Privy token. - name: Liquidity Rewards (authenticated) description: | Privy-gated liquidity-rewards reads under `/liquidity-rewards`. Send `Authorization: Bearer `. externalDocs: description: Data API overview url: /data-api-reference/introduction paths: /liquidity-rewards/markets/{marketId}/config: get: tags: - Liquidity Rewards (authenticated) summary: Market programme config description: | **Requires `Authorization: Bearer `.** Multi-rail market config: every enrolled programme (CP and/or USDC) in one response. Same payload as the public config route. parameters: - $ref: '#/components/parameters/LrMarketId' responses: '200': description: Programme list for the market. content: application/json: schema: $ref: '#/components/schemas/LiquidityRewardsMarketConfig' '401': description: Missing or invalid Privy Bearer token '403': description: Authenticated user does not have access '404': description: No liquidity reward config for this market security: - PrivyBearer: [] components: parameters: LrMarketId: in: path name: marketId required: true schema: type: string description: | CLOB market id. Use the market's `conditionId` (`0x`-prefixed 32-byte hex). schemas: LiquidityRewardsMarketConfig: type: object required: - market_id - programmes properties: market_id: type: string programmes: type: array items: $ref: '#/components/schemas/LiquidityRewardsProgrammeConfig' LiquidityRewardsProgrammeConfig: type: object description: One enrolled rail (CP or USDC) on a market. properties: currency: type: string enum: - CP - USDC reward_enabled: type: boolean active: type: boolean inactive_reason: type: string nullable: true enum: - reward_disabled - no_daily_pool - outside_program_window - budget_exhausted - not_configured - misconfigured daily_pool: type: string nullable: true budget_total: type: string nullable: true duration_days: type: integer nullable: true program_starts_at_ms: type: integer nullable: true program_ends_at_ms: type: integer nullable: true max_distance_cents: type: string example: '3' single_sided_factor: type: string two_sided_band_low: type: string two_sided_band_high: type: string max_avg_price: type: string nullable: true min_order_rest_seconds: type: integer example: 30 min_order_size_shares: type: integer example: 5 min_payout: type: string example: '1.00' securitySchemes: PrivyBearer: type: http scheme: bearer bearerFormat: JWT description: | Privy access token. Required on `/liquidity-rewards/*`. Send `Authorization: Bearer `. Not used on `/public/liquidity-rewards/*`. ````