IMMIX Assets API

openapi: 3.2.0
info:
  title: REST Assets API
  version: 1.0.0
servers:
- url: https://api.immix.xyz/v1
  description: prod
tags:
- name: Assets
paths:
  /assets:
    get:
      operationId: assets_list
      summary: List assets
      description: The assets this environment's instruments are quoted in, settle in and are written on, sorted by symbol unless `sort` says otherwise. `search` matches a substring of the symbol. Page with `limit` and `cursor`.
      tags:
      - Assets
      parameters:
      - name: search
        in: query
        description: Case-insensitive substring of the symbol.
        required: false
        schema:
          type: string
      - name: symbol
        in: query
        description: Only these symbols, case-insensitive; repeat the parameter or comma-separate.
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: 'Only these types: `COIN`, `TOKEN`, `FIAT`, `STABLE_COIN`, `INDEX`, `COMMODITY`, `STOCK`, `OTHER`, or another type an asset has. Any other value is 400.'
        required: false
        schema:
          $ref: '#/components/schemas/data_assets_ListAssetsRequestTypeItem'
      - name: sort
        in: query
        description: Comma-separated `symbol`, `assetId` or `type`; prefix `-` for descending. Default `symbol`.
        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 assets.'
        required: false
        schema:
          $ref: '#/components/schemas/data_assets_ListAssetsRequestIncludeItem'
      - 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 assets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_AssetPage'
        '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: []
  /assets/{assetId}:
    get:
      operationId: assets_get
      summary: Get an asset
      description: One asset by id. A removed asset is 404.
      tags:
      - Assets
      parameters:
      - name: assetId
        in: path
        description: The asset 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 asset.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_Asset'
        '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_AssetPage:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/data_Asset'
        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 assets.
      title: AssetPage
    data_assets_ListAssetsRequestTypeItemZero:
      type: string
      enum:
      - COIN
      - TOKEN
      - FIAT
      - STABLE_COIN
      - INDEX
      - COMMODITY
      - STOCK
      - OTHER
      title: ListAssetsRequestTypeItemZero
    data_assets_ListAssetsRequestTypeItem:
      oneOf:
      - $ref: '#/components/schemas/data_assets_ListAssetsRequestTypeItemZero'
      - type: string
      title: ListAssetsRequestTypeItem
    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_assets_ListAssetsRequestIncludeItem:
      type: string
      enum:
      - total
      title: ListAssetsRequestIncludeItem
    data_Asset:
      type: object
      properties:
        assetId:
          type: string
          description: The asset's id. Ids are opaque strings.
        symbol:
          type: string
          description: 'The asset''s symbol, as instrument symbols spell it: the `BTC` in `OKX@BTC/USDT`.'
        type:
          type: string
          description: 'The asset class: `COIN`, `TOKEN`, `FIAT`, `STABLE_COIN`, `INDEX`, `COMMODITY`, `STOCK` or `OTHER`. Append-only: tolerate values you don''t know.'
        updatedAtNs:
          type:
          - string
          - 'null'
          pattern: ^[0-9]+$
          description: When the asset record last changed, as a sequencer timestamp in epoch nanoseconds. Null when unknown.
      required:
      - assetId
      - symbol
      - type
      - updatedAtNs
      description: A coin, token, fiat currency or index that instruments are quoted in, settle in or are written on.
      title: Asset
    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