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

# Introduction

> Paxos Labs API V2 reference

# Paxos Labs API

The Paxos Labs API V2 provides REST (and GraphQL) endpoints for analytics and data across Paxos onchain products. All list endpoints support cursor-based pagination and a flexible `filter` query parameter.

## Authentication

Include your API key in the `x-api-key` header:

```
x-api-key: pxl_<public_id>_<secret>
```

## Base URL

```
https://api.paxoslabs.com
```

## Endpoints

### Amplify

| Endpoint                          | Method | Description                                          |
| --------------------------------- | ------ | ---------------------------------------------------- |
| `/v2/amplify/vaultAssets`         | GET    | List depositable/withdrawable assets for accounts    |
| `/v2/amplify/vaultApys`           | GET    | Historical and current account APY data              |
| `/v2/amplify/vaultTvls`           | GET    | Historical and current account TVL data              |
| `/v2/amplify/vaultCompositions`   | GET    | Current asset composition for accounts               |
| `/v2/amplify/withdrawalRequests`  | GET    | Withdrawal requests filtered by status, chain, asset |
| `/v2/amplify/withdrawalVolumes`   | GET    | Historical withdrawal volume by time interval        |
| `/v2/amplify/liquidityShortfalls` | GET    | Current liquidity shortfalls across accounts         |

### Address Book

| Endpoint                 | Method | Description                                               |
| ------------------------ | ------ | --------------------------------------------------------- |
| `/v2/addressBookEntries` | GET    | Known address entries filtered by chain, address, or name |

### Webhooks

<Info>
  **Coming Soon** — Webhook subscriptions for real-time event notifications are under active development.
</Info>

## Pagination

All list endpoints accept `pageSize` (default 25, max 100) and `pageToken`. Omit `pageToken` for the first page; use the returned `nextPageToken` for subsequent pages.

## Filtering

List endpoints accept a `filter` query string using `=`, `!=`, `AND`, and `OR` operators:

```
filter=chainId=1 AND status=PENDING
```

***