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

> ## Agent Instructions
> Soroswap Aggregator API: base URL https://api.soroswap.finance, pick the network with ?network=mainnet or ?network=testnet (omitted means mainnet).
> Auth: Authorization: Bearer sk_... on every call. Get a key at https://console.soroswap.finance/register. A missing or invalid key returns 401 with code and registerUrl (POST /send returns 403 instead); an expired JWT or a missing role returns 403. Free plan 1 request/s; see https://docs.soroswap.finance/api/plans.md.
> Flow: POST /quote (assetIn, assetOut as C... contract addresses, amount as an integer string in the smallest unit, tradeType, protocols) -> POST /quote/build with the unchanged quote and from -> the user signs the XDR -> POST /send. Build right after quoting: a Soroban XDR is valid for 180 seconds. Submit it as is, never re-simulate it.
> Partner id: every account has one (9 hex chars, permanent). Read partnerId from GET /partner, or in the console at https://console.soroswap.finance under Fees & payouts. The partner fee itself is switched on by Soroswap; see https://docs.soroswap.finance/api/fees.md.
> AI tools: docs MCP at https://docs.soroswap.finance/mcp (claude mcp add --transport http soroswap-docs https://docs.soroswap.finance/mcp), skill with npx skills add https://docs.soroswap.finance. Other clients: https://docs.soroswap.finance/api/build-with-ai.md.
> Units and Stellar pitfalls: https://docs.soroswap.finance/api/stellar-gotchas.md. Errors and retries: https://docs.soroswap.finance/api/errors.md.

# Console

> The Soroswap partner console at https://console.soroswap.finance: sign up, create sk_ API keys (up to 10, each shown once), find your partner id under Fees & payouts, set your partner fee (25 to 300 bps) and USDC payout wallet, read monthly statements and your rate-limit plan. Everything it does is also available through the API.

The [Soroswap console](https://console.soroswap.finance) is where you manage your API account
in a browser. It uses the same production API as your integration
(`https://api.soroswap.finance`), so a change you make there applies to your next call.

> [card] [Sign up](https://console.soroswap.finance/register)
>
> Create an account with your email and a password.

> [card] [Sign in](https://console.soroswap.finance/login)
>
> Open your account to get a key or change your fee.

## What you can do today

* **Sign up and sign in** with email and password, and reset a forgotten password from the
  sign-in page.
* **API keys.** Create up to 10 named keys. Each starts with `sk_` and is shown once, so copy it
  when it appears. Disable, revoke or delete a key without touching the others.
* **Swaps.** Your mainnet swaps routed through the aggregator with your partner id.
* **Fees and payouts.** Your partner id, your partner fee (25 to 300 bps) and the wallet that
  receives your share: a funded Stellar account (`G...`) with a USDC trustline. The rate can be
  edited once Soroswap has activated your account as a partner. Until then the page shows how to
  contact us. See [Fees and revenue share](https://docs.soroswap.finance/api/fees.md).
* **Statements.** Read your monthly payouts.
* **Plan.** See your rate-limit tier. See [Plans and rate limits](https://docs.soroswap.finance/api/plans.md).
* **Settings.** Your account, your session and closing the account.

## Find your partner id

Every API account has a partner id: 9 lowercase hex characters, such as `3fa9c01d2`. Soroswap
creates it with the account and it never changes. It is how swaps, fees and payouts are
attributed to you, and it is the `id` you pass in `Partner { id, bps }` when you call the
aggregator contract yourself.

**1. Sign in**

Open [console.soroswap.finance](https://console.soroswap.finance/login).

**2. Open Fees & payouts**

It is in the left menu.

**3. Copy the partner id**

The **Partner** card at the top shows it in the **Partner id** row, with a copy button.

The **Overview** page also shows it under **Partner fee**. From code, it is `partnerId` in the
response of [`GET /partner`](https://docs.soroswap.finance/api-reference/partner/partner-profile).

> [!NOTE]
>
> Having a partner id does not turn the partner fee on. Soroswap activates the fee for your account
> and agrees your share with you: write to [dev@paltalabs.io](mailto:dev@paltalabs.io). Until then swaps routed with your id
> pay the protocol fee.

## Coming next

Usage analytics for your keys will be added to the console.

## The same through the API

The console is a front end for public endpoints. Anything it does, your backend can do too:

* Account and key: [`POST /register`](https://docs.soroswap.finance/api-reference/account/register),
  [`POST /login`](https://docs.soroswap.finance/api-reference/account/login) and
  [`POST /api-keys/generate`](https://docs.soroswap.finance/api-reference/account/generate-api-key).
* Partner fee, payout wallet and statements: [`GET /partner`](https://docs.soroswap.finance/api-reference/partner/partner-profile),
  [`PUT /partner/rate`](https://docs.soroswap.finance/api-reference/partner/set-rate),
  [`PUT /partner/payout-address`](https://docs.soroswap.finance/api-reference/partner/set-payout-address) and
  [`GET /partner/statements`](https://docs.soroswap.finance/api-reference/partner/list-payouts). The
  [Fees](https://docs.soroswap.finance/api/fees.md) page has curl examples.

## Questions

Write to [dev@paltalabs.io](mailto:dev@paltalabs.io) or ask in the developer channels on
[Discord](https://discord.gg/A2rQ3cm9XG).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.