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

# Overview

> REST API documentation for avnu services

## Base URL

### avnu base url

Used to interact with avnu & fetch tokens metadata

<CodeGroup>
  ```text Mainnet theme={null}
  https://starknet.api.avnu.fi
  ```

  ```text Sepolia theme={null}
  https://sepolia.api.avnu.fi
  ```
</CodeGroup>

### impulse base url

Used to fetch market data

<CodeGroup>
  ```text Mainnet theme={null}
  https://starknet.impulse.avnu.fi
  ```

  ```text Sepolia theme={null}
  https://sepolia.impulse.avnu.fi
  ```
</CodeGroup>

## Authentication (optional)

Most endpoints are public. For higher rate limits or sponsored transactions, use an API key:

```bash theme={null}
GET /endpoint
Headers:
  x-api-key: your-api-key
```

<Card title="Join Developer Group" icon="telegram" href="https://t.me/avnu_developers">
  Join our developer community on Telegram
</Card>

## Available APIs

<Info>
  All core APIs (Swap, DCA, Paymaster, Staking) are on **v3**. Markets and Token List remain on **v1** (stable).
</Info>

<CardGroup cols={2}>
  <Card title="Swap API" icon="arrow-right-arrow-left" href="/api/swap">
    Get quotes and execute swaps (v3)
  </Card>

  <Card title="Paymaster API" icon="gas-pump" href="/api/paymaster">
    Gasless & gasfree transactions (V1)
  </Card>

  <Card title="DCA API" icon="calendar-days" href="/api/dca">
    Create and manage DCA orders (v3)
  </Card>

  <Card title="Staking API" icon="layer-group" href="/api/staking">
    Native token staking (v3)
  </Card>

  <Card title="Markets API" icon="chart-line" href="/api/markets">
    Real-time price feeds (v1)
  </Card>

  <Card title="Token List API" icon="coins" href="/api/tokens">
    Token metadata and verification (v1)
  </Card>
</CardGroup>

## Rate Limits

| Tier       | Limit         | Requirements     |
| ---------- | ------------- | ---------------- |
| Public     | 300 req/5min  | None             |
| Integrated | Higher limits | API key required |

## SDKs

<CardGroup cols={2}>
  <Card title="TypeScript SDK" icon="node-js" href="https://github.com/avnu-labs/avnu-sdk">
    Official TypeScript/JavaScript SDK
  </Card>
</CardGroup>

## Support

<CardGroup cols={2}>
  <Card title="Telegram" icon="paper-plane" href="https://t.me/avnu_developers">
    Get help from developers
  </Card>

  <Card title="Status Page" icon="signal" href="https://health.avnu.fi">
    API health monitoring
  </Card>
</CardGroup>
