> For the complete documentation index, see [llms.txt](https://lumagg.gitbook.io/lumagg/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lumagg.gitbook.io/lumagg/overview/readme.md).

# Welcome

LumAgg is a liquidity aggregator for Stellar. It quotes routes across Soroban DEXes (multi-hop and split when useful) and builds unsigned transactions for atomic execution through the LumAgg Aggregator contract.

**Production API:** `https://api.lumagg.xyz`

**Complete docs:** `https://lumagg.gitbook.io/`

The GitBook site is the canonical public documentation. The legacy interactive page at `https://lumagg.xyz/docs` remains available for compatibility, but is not linked from the product navigation.

## What do you want to do?

### Integrate a wallet, dApp, or bot

1. [Integrator Guide](/lumagg/integrate/integrator-guide.md) — `GET /quote` → `POST /build_tx` → sign → submit
2. [JavaScript / TypeScript Example](/lumagg/integrate/javascript-integration-example.md) — browser integration with an application-owned wallet adapter
3. [API Reference](/lumagg/integrate/api-reference.md) and [OpenAPI](https://github.com/Lum-Agg/stellar-dex-agg/tree/main/docs/openapi.yaml)
4. npm SDK: [`@lumagg/sdk`](https://www.npmjs.com/package/@lumagg/sdk)

### Self-host a quote stack

Start with [Deployment Overview](/lumagg/deploy/deployment-overview.md) if you are choosing between the release binaries, or use the [Self-hosted Aggregator Quickstart](/lumagg/deploy/self-hosted-aggregator-quickstart.md) to run the split worker/API topology directly.

| Need                                              | Guide                                                                                    |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| Single-process quote API                          | [LumAgg Swap API](/lumagg/deploy/lumagg-swap-api.md)                                     |
| Split worker/API quote stack                      | [Self-hosted Aggregator Quickstart](/lumagg/deploy/self-hosted-aggregator-quickstart.md) |
| Shared market state + API replicas                | [Production Aggregator](/lumagg/deploy/aggregator-deployment.md)                         |
| Public stats, swap history, and arbitrage history | [Analytics Indexer](/lumagg/analytics/analytics-indexer.md)                              |
| Aggregator / vault contracts                      | [Smart contracts](/lumagg/on-chain-products/contracts-deployment.md)                     |

### Run atomic round-trip arbitrage

Start with [Arbitrage Deployment](/lumagg/deploy/arbitrage-deployment.md) and [Round-trip Arbitrage](/lumagg/on-chain-products/round-trip-arb.md).

## Supported liquidity

Soroswap, Aquarius (including CLMM), Phoenix, Sushi V3, and Comet. Classic Stellar DEX routing is available for comparison and Classic-only execution; it is not combined with Soroban legs in one transaction.

Source and issues: [LumAgg monorepo](https://github.com/Lum-Agg/stellar-dex-agg).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://lumagg.gitbook.io/lumagg/overview/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.