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

# Introduction to Vulcx — best-price swaps on Fogo

> Vulcx is a swap aggregator on Fogo with multi-hop routing across Vortex, Fluxbeam, Fogo.fun, Moonit, and more.

# Welcome to Vulcx

Vulcx aggregates liquidity across the **Fogo** ecosystem to find the best swap execution for any token pair.

## Why Vulcx?

* **Best-price routing.** Multi-hop routing across Vortex, Fluxbeam, Fogo.fun, and Moonit bonding curves to find optimal execution.
* **Fast execution.** Get a quote and build a ready-to-sign transaction in a single API call.
* **Simple integration.** Three endpoints cover the entire swap lifecycle: quote, build transaction, submit.

## Endpoints

| Endpoint               | Method   | Auth required | Description                                              |
| ---------------------- | -------- | :-----------: | -------------------------------------------------------- |
| `/api/v1/quote`        | GET      |       ✅       | Get the best route and estimated output for a token pair |
| `/api/v1/swap`         | POST     |       ✅       | Build an unsigned swap transaction                       |
| `/api/v1/instructions` | POST     |       ✅       | Get raw instructions for custom transaction composition  |
| `/api/v1/stream`       | GET (WS) |       ✅       | Live-updating quotes over a WebSocket                    |
| `/api/v1/tokens`       | GET      |       —       | Curated list of well-known token mints                   |
| `/health`              | GET      |       —       | Service health check                                     |

Every endpoint requires an API key (`Authorization: Bearer vulcx_...`) except `/health` and
`/api/v1/tokens` — see [Authentication](/get-started/authentication).

## Quick example

Get a quote for swapping 1 FOGO to USDC on Fogo:

<CodeGroup>
  ```bash cURL theme={"theme":"github-dark"}
  curl "https://api.vulcx.xyz/api/v1/quote?inputMint=So11111111111111111111111111111111111111112&outputMint=uSd2czE61Evaf76RNbq4KPpXnkiL3irdzgLFUMe3NoG&amount=1000000000&swapMode=ExactIn&slippageBps=50" \
    -H "Authorization: Bearer $VULCX_KEY"
  ```

  ```typescript TypeScript theme={"theme":"github-dark"}
  const response = await fetch(
    "https://api.vulcx.xyz/api/v1/quote?" +
      new URLSearchParams({
        inputMint: "So11111111111111111111111111111111111111112",
        outputMint: "uSd2czE61Evaf76RNbq4KPpXnkiL3irdzgLFUMe3NoG",
        amount: "1000000000",
        swapMode: "ExactIn",
        slippageBps: "50",
      }),
    { headers: { Authorization: `Bearer ${process.env.VULCX_KEY}` } }
  );
  const { data } = await response.json();
  console.log(`Output: ${data.amountOut}, Hops: ${data.hopCount}`);
  ```

  ```python Python theme={"theme":"github-dark"}
  import os, requests

  resp = requests.get(
      "https://api.vulcx.xyz/api/v1/quote",
      params={
          "inputMint": "So11111111111111111111111111111111111111112",
          "outputMint": "uSd2czE61Evaf76RNbq4KPpXnkiL3irdzgLFUMe3NoG",
          "amount": "1000000000",
          "swapMode": "ExactIn",
          "slippageBps": "50",
      },
      headers={"Authorization": f"Bearer {os.environ['VULCX_KEY']}"},
  )
  data = resp.json()["data"]
  print(f"Output: {data['amountOut']}, Hops: {data['hopCount']}")
  ```
</CodeGroup>

<Note>
  Every request above needs an API key — see [Authentication](/get-started/authentication) for how
  to get one and use it. `/health` and `/api/v1/tokens` are the only endpoints that don't require it.
</Note>

## Next steps

<CardGroup cols={2}>
  <Card title="Supported Chains" icon="link" href="/concepts/chains">
    Fogo capabilities and supported DEXs.
  </Card>

  <Card title="Architecture" icon="sitemap" href="/get-started/architecture">
    High-level overview of how Vulcx routes and executes swaps.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Full endpoint documentation with Try It.
  </Card>

  <Card title="Executing Swaps" icon="bolt" href="/guides/executing-swaps">
    End-to-end guide for your first swap.
  </Card>

  <Card title="Self-Hosted" icon="server" href="/get-started/self-hosted">
    Run the community binary on your own infra with your own FluxRPC key.
  </Card>
</CardGroup>


## Related topics

- [Swap routing — multi-hop best-price paths on Fogo](/concepts/routing.md)
- [Vulcx architecture — how swaps are routed on Fogo](/get-started/architecture.md)
- [Composing Swaps On-Chain (CPI)](/guides/onchain-cpi.md)
- [Changelog](/updates/index.md)
- [sdk.quote()](/sdk/quote.md)