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

# Health check

> Liveness. Returns `200` whenever the service can answer.



## OpenAPI

````yaml /openapi.json get /v2/health
openapi: 3.1.0
info:
  title: KaleidoSwap Maker API
  version: v2
  description: >-
    Public HTTP API of the KaleidoSwap maker. Wire-compatible with the Boltz
    `/v2` protocol for submarine, reverse, and chain swaps, with KaleidoSwap
    additions (RGB, atomic swaps, pay-through, LSPS1, swap credentials).
    Integrate through the Swap SDK where possible: it verifies every swap the
    maker proposes.
  contact:
    name: KaleidoSwap
    url: https://kaleidoswap.com
servers:
  - url: https://maker.signet.kaleidoswap.com
    description: Signet (Mutinynet)
security: []
tags:
  - name: Service
    description: Maker identity, version, and capabilities.
  - name: Pairs and quotes
    description: Routes the maker trades, their limits and fees, and quotes.
  - name: Submarine swaps
    description: On-chain → Lightning. You lock on chain; the maker pays your invoice.
  - name: Reverse swaps
    description: >-
      Lightning → on-chain. You pay a hold invoice; the maker locks on chain;
      you claim.
  - name: Chain swaps
    description: On-chain → on-chain. Both sides lock; you claim the maker's lockup.
  - name: Swap status
    description: Swap status over HTTP and WebSocket.
  - name: Recovery
    description: Restore swaps from an xpub and recover swap credentials.
  - name: Atomic RGB swaps
    description: BTC ↔ RGB asset swaps in a single transaction.
  - name: Pay-through
    description: Lightning payment → on-chain payout to any address.
  - name: Lightning channels (LSPS1)
    description: Buy inbound Lightning channels (LSPS1).
  - name: Chain data
    description: The maker's view of chain tips and fees.
paths:
  /v2/health:
    get:
      tags:
        - Service
      summary: Health check
      description: Liveness. Returns `200` whenever the service can answer.
      operationId: health
      responses:
        '200':
          description: Process is up.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
components:
  schemas:
    HealthResponse:
      type: object
      description: |-
        `GET /v2/health` / `GET /v2/ready` body — `{"status":"ok"}` or
        `{"status":"ready"}`. Liveness/readiness are distinct semantically;
        the wire shape is identical.
      required:
        - status
      properties:
        liquid:
          type:
            - string
            - 'null'
          description: |-
            Liquid venue state when configured. A degraded venue leaves process
            liveness green so in-flight swaps can still reach this maker.
        rgb:
          type:
            - string
            - 'null'
          description: |-
            RGB wallet state when configured: `ready` once online and synced,
            `degraded` otherwise. Like `liquid`, never fails liveness.
        status:
          type: string
          description: '`"ok"` (health) or `"ready"` (ready).'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.