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

# Quickstart

> Get started with KaleidoSwap in minutes

<CardGroup cols={2}>
  <Card title="Desktop App" icon="desktop" href="#desktop-app-quickstart">
    Atomic swaps via the desktop application
  </Card>

  <Card title="Developer" icon="code" href="#developer-quickstart">
    Integrate KaleidoSwap into your application
  </Card>
</CardGroup>

***

## Desktop App Quickstart

<Steps>
  <Step title="Download & Install">
    Download the latest release for your platform:

    * [macOS (Apple Silicon)](https://github.com/kaleidoswap/desktop-app/releases)
    * [macOS (Intel)](https://github.com/kaleidoswap/desktop-app/releases)
    * [Windows](https://github.com/kaleidoswap/desktop-app/releases)
    * [Linux (AppImage)](https://github.com/kaleidoswap/desktop-app/releases)

    <Tip>
      Always verify the binary signatures before installing. [Learn how →](/desktop-app/verify-binaries)
    </Tip>
  </Step>

  <Step title="Create Wallet">
    Launch KaleidoSwap and create a new wallet:

    1. Click "Create New Wallet"
    2. **Save your 12-word recovery phrase securely**
    3. Set a strong password
    4. Confirm your seed phrase

    <Warning>
      **Never share your recovery phrase!** Anyone with access to it can steal your funds.
    </Warning>
  </Step>

  <Step title="Deposit Funds">
    Get your Bitcoin address and deposit funds:

    1. Navigate to "Wallet" → "Receive"
    2. Copy your Bitcoin address
    3. Send BTC to this address from your exchange or wallet
    4. Wait for confirmations (usually 10-60 minutes)
  </Step>

  <Step title="Open a Channel">
    Connect to a Lightning Service Provider:

    1. Go to "Channels" → "Open Channel"
    2. Select an LSP or use the default
    3. Choose channel capacity (recommended: 1M sats minimum)
    4. Select RGB assets to allocate (e.g., USDT)
    5. Confirm and wait for channel to open
  </Step>

  <Step title="Make Your First Swap">
    Execute an atomic swap:

    1. Go to "Swap" tab
    2. Select assets: BTC → USDT (or vice versa)
    3. Enter amount to swap
    4. Review the quote
    5. Confirm swap
    6. Wait for completion (usually less than 30 seconds)
  </Step>
</Steps>

<Check>
  **Congratulations!** You've completed your first atomic RGB asset swap on Lightning Network.
</Check>

***

## Developer Quickstart

### Python SDK

<CodeGroup>
  ```bash Installation theme={null}
  pip install kaleido-sdk
  ```

  ```python Basic Usage theme={null}
  from kaleido_sdk import KaleidoClient

  # Initialize client
  client = KaleidoClient.create(
      base_url="https://api.signet.kaleidoswap.com",
      node_url="<Your RGB Lightning Node URL>"
  )

  # Get available trading pairs
  pairs = client.maker.list_pairs()
  print(f"Available pairs: {len(pairs)}")

  # Get a quote for BTC to USDT
  quote = client.maker.get_quote({
      "from_asset": {"asset_id": "BTC", "layer": "BTC_LN", "amount": 100000},
      "to_asset": {"asset_id": "USDT", "layer": "RGB_LN"}
  })
  print(f"Quote received: {quote}")
  ```
</CodeGroup>

<Card title="Python SDK Documentation" icon="python" href="/sdk/introduction">
  Explore the complete SDK documentation →
</Card>

### TypeScript SDK

<CodeGroup>
  ```bash npm theme={null}
  npm install kaleido-sdk
  ```

  ```bash yarn theme={null}
  yarn add kaleido-sdk
  ```

  ```typescript Basic Usage theme={null}
  import { KaleidoClient } from 'kaleido-sdk';

  // Initialize client
  const client = KaleidoClient.create({
    baseUrl: 'https://api.signet.kaleidoswap.com'
  });

  // Get available trading pairs
  const pairs = await client.maker.listPairs();
  console.log(`Available pairs: ${pairs.length}`);

  // Get a quote for BTC to USDT
  const quote = await client.maker.getQuote({
    from_asset: { asset_id: 'BTC', layer: 'BTC_LN', amount: 100000 },
    to_asset: { asset_id: 'USDT', layer: 'RGB_LN' }
  });
  console.log(`Quote received:`, quote);
  ```
</CodeGroup>

<Card title="TypeScript SDK Documentation" icon="js" href="/sdk/introduction">
  Explore the complete SDK documentation →
</Card>

### API Quick Reference

<CodeGroup>
  ```bash Get Trading Pairs theme={null}
  curl https://api.signet.kaleidoswap.com/api/v1/pairs
  ```

  ```bash Get Asset List theme={null}
  curl https://api.signet.kaleidoswap.com/api/v1/assets
  ```

  ```bash Request Quote theme={null}
  curl -X POST https://api.signet.kaleidoswap.com/api/v1/quotes \
    -H "Content-Type: application/json" \
    -d '{
      "from_asset": "BTC",
      "to_asset": "USDT",
      "from_amount": 100000
    }'
  ```
</CodeGroup>

<Card title="API Reference" icon="book" href="/api-reference/introduction">
  View complete API documentation →
</Card>

***

## Available Networks

<Tabs>
  <Tab title="Signet">
    **API URL**: `https://api.signet.kaleidoswap.com/api/v1`

    **WebSocket**: `wss://api.signet.kaleidoswap.com/ws/{client_id}`

    * Bitcoin Signet (MutinyNet) — public testnet with realistic conditions
    * Recommended for integration testing before mainnet
    * **Currently live**
  </Tab>

  <Tab title="Regtest">
    **API URL**: `https://api.regtest.kaleidoswap.com/api/v1`

    **WebSocket**: `wss://api.regtest.kaleidoswap.com/ws/{client_id}`

    * Local regtest network — instant block generation, full control
    * Best for rapid development and unit testing
    * **Currently live**
  </Tab>

  <Tab title="Mainnet">
    **API URL**: `https://api.kaleidoswap.com/api/v1`

    * Bitcoin Mainnet — production environment
    * **Coming soon**
  </Tab>
</Tabs>

***

## Next Steps

<CardGroup cols={3}>
  <Card title="Desktop App Guide" icon="book-open" href="/desktop-app/getting-started/introduction">
    Advanced features: channels, backups, and more
  </Card>

  <Card title="SDK Examples" icon="code" href="/sdk/examples">
    Real-world code examples for common workflows
  </Card>

  <Card title="API Documentation" icon="brackets-curly" href="/api-reference/introduction">
    Deep dive into REST API endpoints
  </Card>

  <Card title="Join Community" icon="users" href="https://t.me/kaleidoswap">
    Get help and connect with other users
  </Card>
</CardGroup>