Gainium API

openapi: 3.1.0
info:
  title: Gainium API
  version: '2026-11-09'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-09: 8 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Gainium has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 8
    pages-with-code: 0
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-09'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://gainium.io/help/gainium-api-for-developers
  - https://gainium.io/help/mcp
  - https://gainium.io/help/multi-coin-combo-bots
servers:
- url: https://api.gainium.io
paths:
  /api/v2/bots/combo:
    post:
      operationId: post_api_v2_bots_combo
      tags:
      - Api
      summary: 'When creating a combo bot, set useMulti: true, pass the pairs in pair, and optionally maxDealsPerPair.'
      x-source: https://gainium.io/help/multi-coin-combo-bots
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV2BotsComboRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV2BotsComboResponse'
      x-evidence:
        kind: documentation
  /api/v2/bots/combo/{botid}:
    put:
      operationId: put_api_v2_bots_combo_botid
      tags:
      - Api
      summary: To change the pairs of a running multi‑coin combo, send pair to PUT /api/v2/bots/combo/{botId}.
      x-source: https://gainium.io/help/multi-coin-combo-bots
      parameters:
      - name: botid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiV2BotsComboBotidRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutApiV2BotsComboBotidResponse'
      x-evidence:
        kind: documentation
  /api/v2/bots/combo/{botid}/pairs:
    put:
      operationId: put_api_v2_bots_combo_botid_pairs
      tags:
      - Api
      summary: Use PUT /api/v2/bots/combo/{botId}/pairs to add, remove or replace pairs.
      x-source: https://gainium.io/help/multi-coin-combo-bots
      parameters:
      - name: botid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiV2BotsComboBotidPairsRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutApiV2BotsComboBotidPairsResponse'
      x-evidence:
        kind: documentation
  /api/v2/bots/dca:
    get:
      operationId: get_api_v2_bots_dca
      tags:
      - Api
      summary: 'Get bots: GET /api/v2/bots/dca'
      x-source: https://gainium.io/help/gainium-api-for-developers
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/bots/dca/{botid}:
    delete:
      operationId: delete_api_v2_bots_dca_botid
      tags:
      - Api
      summary: 'Archive a bot: DELETE /api/v2/bots/dca/{botId}'
      x-source: https://gainium.io/help/gainium-api-for-developers
      parameters:
      - name: botid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_api_v2_bots_dca_botid
      tags:
      - Api
      summary: 'Update a bot: PUT /api/v2/bots/dca/{botId}'
      x-source: https://gainium.io/help/gainium-api-for-developers
      parameters:
      - name: botid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /messages:
    post:
      operationId: post_messages
      tags:
      - Messages
      summary: Legacy messages endpoint
      description: Legacy endpoint for sending messages to an SSE session. Used when the client supports only SSE.
      x-source: https://gainium.io/help/mcp
      parameters:
      - name: sessionId
        in: query
        required: false
        schema:
          type: string
        description: Identifier of the SSE session to which the message should be sent.
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /sse:
    get:
      operationId: get_sse
      tags:
      - Sse
      summary: Legacy SSE endpoint
      description: Legacy Server‑Sent Events endpoint used by local HTTP mode clients.
      x-source: https://gainium.io/help/mcp
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiV2BotsComboRequest:
      type: object
      properties:
        useMulti:
          type: boolean
          description: Must be true to create a multi‑coin combo bot.
        pair:
          type: array
          description: List of trading pairs to include in the multi‑coin combo bot.
        maxDealsPerPair:
          type: integer
          description: Optional maximum number of open deals per individual pair.
      required:
      - useMulti
      - pair
    PostApiV2BotsComboResponse:
      type: object
      properties:
        botId:
          type: string
          description: Identifier of the newly created combo bot.
    PutApiV2BotsComboBotidRequest:
      type: object
      properties:
        pair:
          type: array
          description: New list of trading pairs for the bot.
      required:
      - pair
    PutApiV2BotsComboBotidResponse:
      type: object
      properties:
        status:
          type: string
          description: Result of the update operation.
    PutApiV2BotsComboBotidPairsRequest:
      type: object
      properties:
        pair:
          type: array
          description: Array of pairs to add, remove, or replace for the bot.
      required:
      - pair
    PutApiV2BotsComboBotidPairsResponse:
      type: object
      properties:
        status:
          type: string
          description: Result of the pair‑modification operation.
tags:
- name: Api
- name: Messages
- name: Sse