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

# Introduction

> Welcome to the Futarchy DEX API - A CoinGecko-compatible API for the Futarchy protocol

## What is Futarchy DEX API?

The Futarchy DEX API is a CoinGecko-compatible DEX API that automatically discovers and aggregates all DAOs from the Futarchy protocol, providing real-time pricing and trading information.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Get started with the API in minutes
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/overview">
    Explore all available endpoints
  </Card>

  <Card title="Configuration" icon="gear" href="/configuration">
    Learn how to configure your API instance
  </Card>

  <Card title="Pricing Methodology" icon="calculator" href="/concepts/pricing-methodology">
    Understand how prices are calculated
  </Card>
</CardGroup>

## Key Features

<AccordionGroup>
  <Accordion icon="magnifying-glass" title="Automatic DAO Discovery">
    The API automatically discovers all DAOs from the Futarchy protocol without manual configuration.
  </Accordion>

  <Accordion icon="coins" title="Real-Time Pricing">
    Get accurate real-time prices calculated from spot pool reserves with support for various token decimals.
  </Accordion>

  <Accordion icon="chart-line" title="Volume Tracking">
    Trading volumes are calculated from protocol fees, providing accurate volume metrics.
  </Accordion>

  <Accordion icon="droplet" title="Liquidity Metrics">
    Access comprehensive liquidity information for all pools in USD.
  </Accordion>

  <Accordion icon="bolt" title="High Performance">
    Built with Bun for exceptional performance with intelligent caching and rate limiting.
  </Accordion>
</AccordionGroup>

## Base URL

```
https://market-api.metadao.fi
```

All API requests should be made to this base URL.

## Available Endpoints

| Endpoint                                   | Description                                              |
| ------------------------------------------ | -------------------------------------------------------- |
| `GET /`                                    | API information and available endpoints                  |
| `GET /api/tickers`                         | All DAO tickers with pricing and volume information      |
| `GET /api/supply/:mintAddress`             | Complete supply breakdown with allocation details        |
| `GET /api/supply/:mintAddress/total`       | Total supply only                                        |
| `GET /api/supply/:mintAddress/circulating` | Circulating supply (excludes team performance package)   |
| `GET /api/volume/aggregate`                | Aggregate volume with daily breakdown for all DAO tokens |
| `GET /health`                              | Health check endpoint for monitoring                     |

See the [API Reference](/api-reference/overview) for detailed documentation on each endpoint.

## Response Format

All endpoints return JSON responses. See the [API Reference](/api-reference/overview) for detailed response schemas.

## Rate Limits

<Info>
  The API implements rate limiting of **60 requests per minute** per IP address to ensure fair usage and system stability.
</Info>

## Getting Help

<CardGroup cols={2}>
  <Card title="GitHub Issues" icon="github" href="https://github.com/metaDAOproject/futarchy-coingecko-api/issues">
    Report bugs or request features
  </Card>

  <Card title="Discord Community" icon="discord" href="https://discord.metadao.fi">
    Join our community for support
  </Card>
</CardGroup>
