sender is present, receive a prepared TransactionEnvelope for signing.
Use This When
| Need | Use |
|---|---|
| Quote a Soroban swap for contract composition | platform=aggregator |
| Compare Soroban and Classic execution for a direct-user flow | platform=all |
| Return a prepared envelope with resource fee and footprint | Add sender and keep simulate=true |
| Build a token picker | GET /api/v1/tokens |
Do Not Use This When
| Need | Use instead |
|---|---|
| You need MultiversX swap transaction data | MultiversX Aggregator |
| You need Stellar lending account or pool behavior | Stellar Lending |
| You already have an envelope and only need submission | Submit through your Stellar RPC or wallet flow |
Base URL
Flow
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.Choose the execution plane
Keep
platform=aggregator for composable Soroban flows. Use platform=all only when a user signs the final envelope directly.Execution Planes
platform | Sources | Envelope behavior | Use when |
|---|---|---|---|
aggregator (default) | Soroswap, Aquarius, Phoenix, static SAC bridges | Soroban batch_execute | A Soroban contract or app needs composable execution |
sdex | Stellar SDEX | Classic path payment route | A direct-user Classic flow controls envelope construction |
all | Soroban and Classic sources | Returns only the winning quote | A direct-user UI wants a single displayed route |
Limits
| Action | Limit or behavior |
|---|---|
| Any request | 100 requests per second per IP |
| Quote freshness | Quotes use the latest pool snapshot available to the service |
| Snapshot refresh | Soroban stream loop about every 5 s, sanity resync every 60 s |
| Liquidity sources | Soroswap, Aquarius, Phoenix, Stellar SDEX, static SAC bridges |
| Reverse quotes | Single-path only |
| Amount format | Use integer strings in the token’s smallest unit |
Endpoints
| Endpoint | Method | Job |
|---|---|---|
/api/v1/quote | GET | Quote a route and optionally return a prepared envelope |
/api/v1/tokens | GET | List routable tokens from the current snapshot |
/health | GET | Return service and snapshot status |
/ready | GET | Return readiness, including stale-snapshot failures |
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.