> ## Documentation Index
> Fetch the complete documentation index at: https://docs.joyride.exchange/llms.txt
> Use this file to discover all available pages before exploring further.

# Trigger settlement

> Settle all positions for an expired round using TWAP prices.
Cancels resting orders on expired instruments and optionally creates
instruments for the next round. Idempotent — settling the same
expiration twice returns success with zero counts. When
`next_expiration` is provided, `twap_prices` must include BTC, ETH,
and SOL so rollover creation stays complete and deterministic.




## OpenAPI

````yaml /_generated/openapi.yaml post /v1/admin/settle
openapi: 3.1.0
info:
  title: Joyride Exchange REST API
  version: 1.0.0
  description: >
    REST API for the Joyride 0DTE Options Exchange.


    ## Authentication


    **Public endpoints** (`/health`, `/v1/market/*`, `/v1/spot/*`,
    `/v1/oracle/*`) require no authentication.


    **Competition prize claims** (`/v1/competition/claim`) are
    self-authenticated

    by a Solana ed25519 signature over the wallet, Discord handle, and payout

    destination in the request body. No JWT is required for that endpoint.


    **Account endpoints** (`/v1/account/*`, `/v1/orders/*`,
    `/v1/social/profile`, `/v1/social/avatar`) require JWT authentication via
    one of:

    1. `Authorization: Bearer <jwt>` header (primary — native clients)

    2. `Cookie: joyride_session=<jwt>` (web clients, set automatically by
    `/v1/auth/verify`)


    **Withdrawal endpoints** (`/withdrawals`, `/v1/withdrawals`) require the

    `Authorization: Bearer <jwt>` header. A session cookie alone is not
    accepted.


    Obtain a JWT by completing the SIWS (Sign In With Solana) flow:

    1. `POST /v1/auth/nonce` with your wallet address to get a nonce

    2. Sign the canonical SIWS message with your wallet

    3. `POST /v1/auth/verify` with wallet, signature, and message to receive a
    JWT


    **Mutating admin endpoints** require a bearer token:

    ```

    Authorization: Bearer <ADMIN_TOKEN>

    ```


    ## Data Conventions


    - **Prices**: Integer values in USDC micros (1 USDC = 1,000,000 micros).
      Example: `1500000` = $1.50
    - **Sizes**: Integer values in millicontracts (1 contract = 1000
    millicontracts).
      Example: `1000` = 1 contract
    - **Balances**: USDC micros. Example: `10_000_000_000` = $10,000

    - **Timestamps**: Unix microseconds (µs since epoch)

    - **Instrument IDs**: Format `{ASSET}_USDC-{DMMMYY}-{STRIKE}-{C|P}`.
      Example: `SOL_USDC-28FEB26-150-C`

    ## Trading


    **Trading is WebSocket-only.** The HTTP API has no order placement
    endpoints.

    See the AsyncAPI spec for WebSocket trading methods.
  contact:
    name: Joyride Engineering
    email: engineering@joyride.exchange
  license:
    name: Proprietary
servers:
  - url: https://joyride.exchange/api
    description: Production
security: []
tags:
  - name: Authentication
    description: |
      SIWS (Sign In With Solana) authentication flow. Obtain a JWT for use
      with all authenticated endpoints. No prior authentication required.
  - name: Health
    description: Service health check.
  - name: Market Data
    description: Publicly accessible market data. No authentication required.
  - name: Account
    description: User-specific account data. Requires user identification.
  - name: Orders
    description: User order history. Requires user identification.
  - name: Withdrawals
    description: Request signed withdrawal authorizations and list withdrawal history.
  - name: Social
    description: Social features — profiles, leaderboard, and activity.
  - name: Referrals
    description: Referral-code validation and attribution surfaces.
  - name: Competition
    description: Competition-specific collection flows.
  - name: Spot
    description: Spot prices and volatility data.
  - name: Oracle
    description: Oracle data — prices, TWAP previews, and settlement timing.
  - name: AI Chat
    description: >
      AI-powered trading assistant. Uses SIWS (Sign In With Solana)
      authentication

      and JWT sessions. Returns responses as Server-Sent Events (SSE).
  - name: Admin
    description: Administrative operations. Requires admin bearer token.
paths:
  /v1/admin/settle:
    post:
      tags:
        - Admin
      summary: Trigger settlement
      description: |
        Settle all positions for an expired round using TWAP prices.
        Cancels resting orders on expired instruments and optionally creates
        instruments for the next round. Idempotent — settling the same
        expiration twice returns success with zero counts. When
        `next_expiration` is provided, `twap_prices` must include BTC, ETH,
        and SOL so rollover creation stays complete and deterministic.
      operationId: settle
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettleRequest'
      responses:
        '200':
          description: Settlement completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettleResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - adminAuth: []
components:
  schemas:
    SettleRequest:
      type: object
      properties:
        expiration:
          type: integer
          description: Expiration to settle (Unix seconds)
          example: 1740729600
        twap_prices:
          type: object
          additionalProperties:
            type: number
          description: 'TWAP prices per asset in dollars (e.g., {"SOL": 180.25})'
          example:
            SOL: 180.25
            BTC: 97500.5
            ETH: 3200.75
        next_expiration:
          type: integer
          description: >-
            Optional — if set, creates instruments for the next round and
            requires BTC, ETH, and SOL entries in twap_prices
          example: 1740816000
      required:
        - expiration
        - twap_prices
    SettleResponse:
      type: object
      properties:
        settled_instruments:
          type: integer
          example: 30
        settled_positions:
          type: integer
          example: 42
        cancelled_orders:
          type: integer
          example: 15
        created_instruments:
          type: integer
          example: 30
        settlements:
          type: array
          items:
            type: object
            properties:
              wallet:
                type: string
              instrument_id:
                type: string
              quantity:
                type: integer
              avg_price:
                type: integer
              settlement_price:
                type: integer
              payout:
                type: integer
              pnl:
                type: integer
            required:
              - wallet
              - instrument_id
              - quantity
              - avg_price
              - settlement_price
              - payout
              - pnl
      required:
        - settled_instruments
        - settled_positions
        - cancelled_orders
        - created_instruments
        - settlements
    Error:
      type: object
      properties:
        error:
          type: string
          description: >-
            Human-readable error message (auth failures may include an `auth_*`
            code prefix)
          example: Instrument not found
      required:
        - error
  responses:
    BadRequest:
      description: Bad request — missing or invalid parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: >
        Authentication required or invalid admin token.

        For JWT-protected endpoints, `error` is prefixed with an auth code:

        `auth_missing`, `auth_missing_or_wallet_query`, `auth_malformed`,
        `auth_expired`, or `auth_signature_invalid`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    adminAuth:
      type: http
      scheme: bearer
      description: Admin token set via the ADMIN_TOKEN environment variable.

````