Skip to main content
Use the Stellar Aggregator to quote swaps and, when sender is present, receive a prepared TransactionEnvelope for signing.

Use This When

Do Not Use This When

Base URL

No API key is required; per-IP rate limits apply.

Flow

1

List or select tokens

Use /api/v1/tokens for routable token IDs. Prefer full C-strkeys or SEP-11 identifiers over aliases in deterministic flows.
2

Quote the route

Call /api/v1/quote with from, to, and exactly one of amount_in or amount_out.
3

Choose the execution plane

Keep platform=aggregator for composable Soroban flows. Use platform=all only when a user signs the final envelope directly.
4

Request and sign the envelope

Pass sender to receive transaction.envelopeXdr, a base64 XDR TransactionEnvelope.

Execution Planes

Classic SDEX operations do not compose inside another Soroban contract. Use platform=aggregator for Lending -> Aggregator flows.

Limits

Endpoints

Next Steps

Quickstart

Fetch a quote, inspect the envelope, and submit it through Stellar tooling.

Quote endpoint

Parameters, response fields, errors, and executable examples.

Tokens endpoint

Token identifiers, decimals, and source metadata.

Integration guide

Handle prepared envelopes, fallback routes, retries, and errors.