> For the complete documentation index, see [llms.txt](https://zefyrswap.gitbook.io/doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zefyrswap.gitbook.io/doc/api-endpoints/overview.md).

# Overview

The **ZefyrSwap** API provides a simple REST interface for getting quotes and preparing swaps on Base Network. All endpoints are accessible at your deployment URL.\
\
**Base URL:** [`https://api.zefyrswap.com/api`](https://api.zefyrswap.com/api)

**Authentication:** Currently, no API key is required.

**Response Format:** All successful responses return JSON with appropriate data structures. \
\
**Error Format:** Error responses include an [#error-codes](#error-codes "mention") field with a descriptive message.

**Rate Limits:** For development, **no rate limits** are enforced for now. 

## Endpoints

**Health Check:** Verify API and RPC connection status.

```
GET /health
```

**Get Quote:** Find the best swap route across all supported DEXes.

```
POST /quote
```

**Prepare Swap:** Generate transaction data for executing a swap.

```
POST /swap
```

**Token Information:** Get metadata for any ERC-20 token.

```
GET /token/{tokenAddress}
```

## Error Codes

| Code | Description           | Resolution                    |
| ---- | --------------------- | ----------------------------- |
| 400  | Bad Request           | Check your request parameters |
| 500  | Internal Server Error | Contact support or try again  |
| 503  | Service Unavailable   | RPC provider may be down      |

**Testing:** User can test the API using tools like curl, Postman, or directly from your application. \
\
See our Integration examples for complete code samples.