> ## 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.

# Bitcoin Swap API: Additional Resources

> Links for KaleidoSwap API integrators — OpenAPI specifications, SDKs and CLI, node and protocol references, test networks, and support channels

## Specifications & Clients

<CardGroup cols={2}>
  <Card title="OpenAPI Specifications" icon="file-code" href="https://github.com/kaleidoswap/specs">
    Versioned specs for the KaleidoSwap APIs, updated on each release. Diff two versions instead of discovering changes at runtime.
  </Card>

  <Card title="TypeScript & Python SDKs" icon="code" href="/sdk/introduction">
    Typed clients generated from those specs, wrapping both the Maker API and your node behind `client.maker.*` and `client.rln.*`.
  </Card>

  <Card title="CLI" icon="terminal" href="/cli/introduction">
    Drive a node, quote, and swap from the terminal — useful for probing the API by hand before writing a client.
  </Card>

  <Card title="Getting Started" icon="rocket" href="/api-reference/getting-started">
    Base URLs, authentication, request format, versioning, and rate limits.
  </Card>
</CardGroup>

## Protocol References

<CardGroup cols={2}>
  <Card title="Swap Protocol" icon="arrows-rotate" href="/api-reference/swap-protocol">
    The atomic HTLC flow end to end, with the sequence diagram and the endpoints used at each step.
  </Card>

  <Card title="RGB Lightning Node" icon="code-branch" href="https://github.com/kaleidoswap/rgb-lightning-node">
    The node that serves the RLN API and whitelists swapstrings. This is the KaleidoSwap fork; the [upstream project](https://github.com/RGB-Tools/rgb-lightning-node) is maintained by RGB Tools.
  </Card>

  <Card title="LSPS1 (bLIP-51)" icon="scroll" href="https://github.com/lightning/blips/blob/master/blip-0051.md">
    The Channel Requests specification our [channel order endpoints](/api-reference/rgb-lsps1-apis) implement, extended here with RGB asset allocation.
  </Card>

  <Card title="RGB Protocol Documentation" icon="gem" href="https://docs.rgb.info">
    Client-side validation, asset interfaces, and the specification behind the `rgb:` contract IDs the API returns.
  </Card>
</CardGroup>

## Environments & Testing

Integrate against Signet before mainnet. No API key is required today, and anonymous requests are still served.

| Environment            | REST base URL                                        | WebSocket                                                                |
| ---------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------ |
| **Signet (MutinyNet)** | `https://api.signet.kaleidoswap.com/api/v1`          | `wss://api.signet.kaleidoswap.com/api/v1/market/ws/{client_id}`          |
| **Mainnet**            | `https://api.kaleidoswap.com/api/v1` *(coming soon)* | `wss://api.kaleidoswap.com/api/v1/market/ws/{client_id}` *(coming soon)* |

Asset IDs are not portable between environments — read them from `GET /api/v1/market/assets` and key your configuration per environment.

<CardGroup cols={2}>
  <Card title="Mutiny Faucet" icon="faucet" href="https://faucet.mutinynet.com/">
    Get Signet Bitcoin to fund a node and open test channels.
  </Card>

  <Card title="Mutinynet Explorer" icon="magnifying-glass-chart" href="https://mutinynet.com/">
    Confirm on-chain that a swap settled or a channel open actually confirmed.
  </Card>

  <Card title="Node Hosting" icon="server" href="/desktop-app/getting-started/node-hosting">
    Deployment options for the RGB Lightning Node the swap endpoints require.
  </Card>
</CardGroup>

## Related Documentation

<CardGroup cols={2}>
  <Card title="Troubleshooting" icon="triangle-exclamation" href="/api-reference/troubleshooting">
    The three error envelopes, status-code semantics, retry strategy, and a fix per symptom.
  </Card>

  <Card title="SDK Examples" icon="file-code" href="/sdk/examples">
    End-to-end code for the atomic swap flow, if you would rather read working code than endpoint tables.
  </Card>

  <Card title="Architecture" icon="diagram-project" href="/whats-kaleidoswap/architecture">
    Where the maker, the LSP, and your node sit relative to each other.
  </Card>

  <Card title="Glossary" icon="book" href="/whats-kaleidoswap/glossary">
    RFQ, swapstring, HTLC, layer, and the rest of the vocabulary these endpoints assume.
  </Card>
</CardGroup>

## Get Help

Check [Troubleshooting](/api-reference/troubleshooting) for errors and the [FAQ](/api-reference/faq) for questions.

For anything else, report a problem through your preferred channel from the options below, including:

1. Request URL and HTTP method
2. Request payload (redact any API key)
3. Full error response, including `request_id`
4. Timestamp of the request
5. Environment (Signet / Mainnet)

<CardGroup cols={2}>
  <Card title="Telegram Community" icon="telegram" href="https://t.me/kaleidoswap">
    Ask the community.
  </Card>

  <Card title="Email Support" icon="envelope" href="mailto:support@kaleidoswap.com">
    Direct support for urgent issues.
  </Card>
</CardGroup>