IMMIX Venues API

openapi: 3.2.0
info:
  title: REST Venues API
  version: 1.0.0
servers:
- url: https://api.immix.xyz/v1
  description: prod
tags:
- name: Venues
paths:
  /venues:
    get:
      operationId: venues_list
      summary: List venues
      description: The venues this environment serves, sorted by code unless `sort` says otherwise. Page with `limit` and `cursor`.
      tags:
      - Venues
      parameters:
      - name: search
        in: query
        description: Case-insensitive substring of the code or display name.
        required: false
        schema:
          type: string
      - name: code
        in: query
        description: Only these venue codes; repeat the parameter or comma-separate.
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: Comma-separated `code`, `displayName` or `venueId`; prefix `-` for descending. Default `code`.
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Page size, 1-100; larger values are clamped. Default 50.
        required: false
        schema:
          type: integer
      - name: cursor
        in: query
        description: '`nextCursor` or `prevCursor` from a previous page, sent with the same filters and sort.'
        required: false
        schema:
          type: string
      - name: include
        in: query
        description: '`total` adds the exact number of matching venues.'
        required: false
        schema:
          $ref: '#/components/schemas/data_venues_ListVenuesRequestIncludeItem'
      - name: X-Request-Id
        in: header
        description: 'Your own id for the request: 8 to 128 of `[A-Za-z0-9._-]`. It becomes the request''s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: A page of venues.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_VenuePage'
        '400':
          description: The request is malformed, or its cursor is not valid for it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_Error'
        '401':
          description: The bearer token is missing or not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_Error'
        '503':
          description: A store is temporarily unavailable; retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_Error'
      security:
      - bearerAuth: []
  /venues/{venueId}:
    get:
      operationId: venues_get
      summary: Get a venue
      description: One venue by id. A removed venue, or one another environment serves, is 404.
      tags:
      - Venues
      parameters:
      - name: venueId
        in: path
        description: The venue id.
        required: true
        schema:
          type: string
      - name: X-Request-Id
        in: header
        description: 'Your own id for the request: 8 to 128 of `[A-Za-z0-9._-]`. It becomes the request''s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The venue.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_Venue'
        '400':
          description: The request is malformed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_Error'
        '401':
          description: The bearer token is missing or not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_Error'
        '404':
          description: No such resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_Error'
        '503':
          description: A store is temporarily unavailable; retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_Error'
      security:
      - bearerAuth: []
components:
  schemas:
    data_Venue:
      type: object
      properties:
        venueId:
          type: string
          description: The venue's id. Ids are opaque strings.
        code:
          type: string
          description: 'The venue code. Instrument symbols carry it upper-cased as their venue prefix: `okx` is the `OKX@` in `OKX@BTC/USDT`.'
        displayName:
          type: string
          description: The name to show people.
        updatedAtNs:
          type:
          - string
          - 'null'
          pattern: ^[0-9]+$
          description: When the venue record last changed, as a sequencer timestamp in epoch nanoseconds. Null when unknown.
      required:
      - venueId
      - code
      - displayName
      - updatedAtNs
      description: A trading venue that IMMIX connects to.
      title: Venue
    data_ErrorBody:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable, UPPER_SNAKE and append-only; tolerate codes you don't know. Branch on this, never on the message.
        message:
          type: string
          description: For display only; its wording may change at any time.
        retryable:
          type: boolean
          description: 'Whether sending the identical request again, after `Retry-After` or a short pause, can succeed with nothing else changed. `false` where something must change first: the request, the caller''s standing, or the platform''s own records or deployment.'
        requestId:
          type: string
          description: The request's id, also sent as X-Request-Id; quote it to support.
      required:
      - code
      - message
      - retryable
      - requestId
      title: ErrorBody
    data_venues_ListVenuesRequestIncludeItem:
      type: string
      enum:
      - total
      title: ListVenuesRequestIncludeItem
    data_VenuePage:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/data_Venue'
        nextCursor:
          type:
          - string
          - 'null'
          description: Pass as `cursor` for the next page. Null on the last page.
        prevCursor:
          type:
          - string
          - 'null'
          description: Pass as `cursor` for the previous page. Null on the first page.
        total:
          type:
          - integer
          - 'null'
          description: Exact count matching the filter. Null unless `include=total`.
        asOfSeqTsNs:
          type:
          - string
          - 'null'
          pattern: ^[0-9]+$
          description: The sequencer timestamp (epoch-ns) the data is complete through; also sent as X-Immix-As-Of-Seq-Ts. Null when unknown.
      required:
      - items
      - nextCursor
      - prevCursor
      - total
      - asOfSeqTsNs
      description: A page of venues.
      title: VenuePage
    data_Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/data_ErrorBody'
        currentVersion:
          type: string
          pattern: ^-?[0-9]+$
          description: 'On a 412 `VERSION_CONFLICT` from a conditional write: the row''s current version (the `ETag` carries the same token); re-read, reapply, retry. No operation of this API is a conditional write yet, so no response carries it.'
      required:
      - error
      description: Every non-2xx response carries this envelope.
      title: Error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer