HiddenSwap API

openapi: 3.1.0
info:
  title: HiddenSwap API
  version: '2026-11-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-11: 7 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; HiddenSwap has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 6
    pages-with-code: 1
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://hiddenswap.com/developers
paths:
  /api/currencies:
    get:
      operationId: get_api_currencies
      tags:
      - Api
      summary: Coins GET /api/currencies lists every coin as rows of [id, ticker, name, network, label, icon, memoName, flags] .
      x-source: https://hiddenswap.com/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCurrenciesResponse'
      x-evidence:
        kind: documentation
  /api/orders:
    post:
      operationId: post_api_orders
      tags:
      - Api
      summary: Create an order POST /api/orders with a JSON body.
      x-source: https://hiddenswap.com/developers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiOrdersRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiOrdersResponse'
      x-evidence:
        kind: documentation
  /api/orders/{id}:
    get:
      operationId: get_api_orders_id
      tags:
      - Api
      summary: Order status GET /api/orders/{id} with your key returns the same fields with the current status.
      x-source: https://hiddenswap.com/developers
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiOrdersIdResponse'
      x-evidence:
        kind: documentation
  /api/partner/stats:
    get:
      operationId: get_api_partner_stats
      tags:
      - Api
      summary: 'Your stats GET /api/partner/stats : your status, orders, finished swaps, volume, earnings, payouts and a month by month breakdown.'
      x-source: https://hiddenswap.com/developers
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/quote:
    get:
      operationId: get_api_quote
      tags:
      - Api
      summary: Quote GET /api/quote?from=&to=&amount=&rateType=float|fixed .
      x-source: https://hiddenswap.com/developers
      parameters:
      - name: from
        in: query
        required: true
        schema:
          type: string
      - name: to
        in: query
        required: true
        schema:
          type: string
      - name: amount
        in: query
        required: true
        schema:
          type: string
      - name: rateType
        in: query
        required: true
        schema:
          type: string
        description: float or fixed
      - name: side
        in: query
        required: false
        schema:
          type: string
        description: to for exact amount to receive (fixed only)
      - name: amountTo
        in: query
        required: false
        schema:
          type: string
        description: exact amount to receive when side=to
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiQuoteResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_quote
      tags:
      - Api
      summary: POST /api/quote
      x-source: https://hiddenswap.com/developers
      parameters:
      - name: amount
        in: query
        required: false
        schema:
          type: string
      - name: from
        in: query
        required: false
        schema:
          type: string
      - name: rateType
        in: query
        required: false
        schema:
          type: string
      - name: to
        in: query
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiQuoteRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -s "https://hiddenswap.com/api/quote?from=btc&to=xmr&amount=0.01&rateType=float"  -H "Authorization: Bearer hs_live_YOUR_KEY"
          All rates GET /api/rates returns the floating rate of every main pair in one response: every listed coin to and from Monero, and the
          main coins against each other. Each pair has rate (before the network fee), the amountFrom it was quoted for and the amountTo that buys '
  /api/rates:
    get:
      operationId: get_api_rates
      tags:
      - Api
      summary: All rates GET /api/rates returns the floating rate of every main pair in one response.
      x-source: https://hiddenswap.com/developers
      parameters:
      - name: from
        in: query
        required: false
        schema:
          type: string
      - name: to
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiRatesResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiCurrenciesResponse:
      type: object
      properties:
        id:
          type: string
        ticker:
          type: string
        name:
          type: string
        network:
          type: string
        label:
          type: string
        icon:
          type: string
        memoName:
          type: string
        flags:
          type: integer
    PostApiOrdersRequest:
      type: object
      properties:
        from:
          type: string
        to:
          type: string
        amount:
          type: string
        rateType:
          type: string
        address:
          type: string
        sourceAddress:
          type: string
        extraId:
          type: string
        rateId:
          type: string
        side:
          type: string
        amountTo:
          type: string
      required:
      - from
      - to
      - amount
      - rateType
      - address
      - sourceAddress
    PostApiOrdersResponse:
      type: object
      properties:
        orderId:
          type: string
        depositAddress:
          type: string
        depositExtraId:
          type: string
        amount:
          type: string
        depositDeadline:
          type: string
          description: present for fixed rate
    GetApiOrdersIdResponse:
      type: object
      properties:
        orderId:
          type: string
        status:
          type: string
          description: waiting, confirming, exchanging, sending, finished, failed, refunded or expired
        depositAddress:
          type: string
        depositExtraId:
          type: string
        transactionHashes:
          type: array
          description: once known
    GetApiQuoteResponse:
      type: object
      properties:
        rateId:
          type: string
          description: present for fixed quotes
        expiresAt:
          type: string
          description: present for fixed quotes
    PostApiQuoteRequest:
      type: object
      properties:
        from:
          type: string
        to:
          type: string
        amount:
          type: string
        rateType:
          type: string
        address:
          type: string
        sourceAddress:
          type: string
    GetApiRatesResponse:
      type: object
      properties:
        rate:
          type: string
        amountFrom:
          type: string
        amountTo:
          type: string
        min:
          type: string
        max:
          type: string
        networkFee:
          type: string
        updatedAt:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api