> ## 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.

# Health

> Checks if the indexer is up and running, and returns which protocols are available for quote requests on each network (mainnet/testnet)



## OpenAPI

````yaml GET /health
openapi: 3.0.0
info:
  title: Soroswap API
  description: >+

    # 🚀 Soroswap API


    **Soroswap.Finance** is both an **Automated Market Maker (AMM)** and a **DEX
    Aggregator** on the Stellar blockchain.


    It aggregates liquidity from Soroban DEXes (**Soroswap, Phoenix, Aqua and
    Comet(TBA)**), and the **Stellar Classic DEX** — giving you **the best trade
    routes, liquidity tools, and real-time market data**.


    ---


    ## 📋 What You Can Do


    - 🔄 **Quote** – Get the best trade route between two assets with
    split-routing logic across AMMs and SDEX.  

    - 🧱 **Build** – Generate and simulate unsigned transactions (XDR) for swaps
    or liquidity actions.  

    - 🚀 **Send** – Submit signed transactions via Soroban RPC or Horizon.

    - ⚡ **Gasless Trustlines** – Use `gaslessTrustline` in `/quote` to open
    trustlines for users without requiring them to hold XLM or deal with
    trustline setup themselves.

    - 💰 **Platform Fees** – Add your own fee to user swaps with
    `platformFee`.  

    - 💧 **Liquidity** – Create LPs, add liquidity, remove liquidity.  

    - 💲 **Price** – Get real-time token prices.  

    - 🧠 **Pools** – View detailed pool information for Soroswap AMM.


    📮 **[Downnload the Postman Collection
    here](https://drive.google.com/drive/folders/1G-LQYE2EojPWP1CSuuS_tDb9vjYbFR6E?usp=drive_link)**

  version: '1.0'
  contact: {}
  x-logo:
    url: https://links.paltalabs.io/soroswap-full.svg
    backgroundColor: '#0e0e0e'
    altText: Soroswap Logo
    href: https://soroswap.finance
servers: []
security: []
tags: []
paths:
  /health:
    get:
      tags:
        - App
      summary: Health
      description: >-
        Checks if the indexer is up and running, and returns which protocols are
        available for quote requests on each network (mainnet/testnet)
      operationId: AppController_checkHealth
      parameters: []
      responses:
        '200':
          description: >-
            Health check result - Shows indexer status and available protocols
            per network
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    properties:
                      indexer:
                        type: object
                        properties:
                          mainnet:
                            type: array
                            items:
                              type: string
                            example:
                              - soroswap
                              - phoenix
                              - aqua
                            description: Available protocols on mainnet
                          testnet:
                            type: array
                            items:
                              type: string
                            example:
                              - soroswap
                              - aqua
                            description: Available protocols on testnet
                      reachable:
                        type: boolean
                        example: true
                        description: Whether the indexer service is reachable
                  aggregator:
                    type: object
                    properties:
                      mainnet:
                        type: object
                        properties:
                          enabled:
                            type: boolean
                          reachable:
                            type: boolean
                          paused:
                            type: boolean
                            nullable: true
                          protocolBps:
                            type: number
                            nullable: true
                          minPartnerBps:
                            type: number
                            nullable: true
                          treasury:
                            type: string
                            nullable: true
                          keeper:
                            type: string
                            nullable: true
                          payout:
                            type: string
                            nullable: true
                          checks:
                            type: object
                            properties:
                              protocolBpsMatches:
                                type: boolean
                                nullable: true
                              minPartnerBpsMatches:
                                type: boolean
                                nullable: true
                              treasuryMatches:
                                type: boolean
                                nullable: true
                              payoutMatches:
                                type: boolean
                                nullable: true
                              keeperMatches:
                                type: boolean
                                nullable: true
                              aggregatorAllowed:
                                type: boolean
                                nullable: true
                          degraded:
                            type: boolean
                          errors:
                            type: array
                            items:
                              type: string

````

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