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

# Get health



## OpenAPI

````yaml /api-reference/stellar-aggregator-openapi.json get /health
openapi: 3.1.0
info:
  title: Stellar DEX Aggregator API
  description: >-
    Soroban DEX aggregator and routing engine for Stellar. Bounded multi-DEX
    routing across Soroban venues: Soroswap, Aquarius, Phoenix, Sushi, and
    Comet.


    ## Features

    - Forward & reverse quotes (given input → output, or target output → input)

    - Multi-path split allocation across pools to minimize price impact

    - Optional server-side simulated `TransactionEnvelope` requiring account
    sequence and signature

    - Auto-fallback when the on-chain budget rejects the requested config

    - Echoes USD value + protocol/referral fees
  license:
    name: MIT
    identifier: MIT
  version: 0.1.0
servers:
  - url: https://stellar-swap.xoxno.com
    description: Public deployment; verify network with /api/v1/config
security: []
tags:
  - name: Discovery
    description: Deployment, pools and referral fee policy
  - name: Health
    description: Liveness and readiness probes
  - name: Tokens
    description: Routable token catalog
  - name: Quote
    description: Routing, quoting, and transaction-envelope construction
paths:
  /health:
    get:
      tags:
        - Health
      operationId: health
      responses:
        '200':
          description: Service is up — body carries snapshot stats
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
components:
  schemas:
    HealthResponse:
      type: object
      description: >-
        Process liveness and cached snapshot statistics. Use `/ready` for
        freshness.
      required:
        - status
        - pools
        - tokens
        - decimals_entries
        - last_applied_ledger
        - last_applied_cursor
        - seconds_since_last_apply
        - static_fee_bps
        - usd_prices_cached
      properties:
        decimals_entries:
          type: integer
          description: Tokens with a resolved decimal precision.
          minimum: 0
        last_applied_cursor:
          type: string
          description: Opaque event-stream resume cursor.
        last_applied_ledger:
          type: integer
          format: int32
          description: Last ledger applied through by the snapshot.
          minimum: 0
        pools:
          type: integer
          description: Indexed swap edges; multi-token pools may contribute multiple edges.
          minimum: 0
        seconds_since_last_apply:
          type: integer
          format: int64
          description: Seconds since the snapshot last advanced.
          minimum: 0
        static_fee_bps:
          type: integer
          format: int32
          description: Cached router admin fee, before referral fees.
          minimum: 0
        status:
          type: string
          description: Process answered the request; does not guarantee snapshot freshness.
        tokens:
          type: integer
          description: Token identifiers in the snapshot interner.
          minimum: 0
        usd_prices_cached:
          type: integer
          description: Entries in the oracle price cache.
          minimum: 0

````

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