> For the complete documentation index, see [llms.txt](https://docs.dexpal.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dexpal.io/readme.md).

# Introduction

DexPal is a discovery, rewards, and data platform for decentralized exchanges. These docs cover the public user experience, beta access, rewards program, roadmap, and the partner DEX API used to send market, rewards, and user-level data into DexPal.

## For Users

| Page                                                 | Scope                                       |
| ---------------------------------------------------- | ------------------------------------------- |
| [Users](/for-users/users.md)                         | User documentation index                    |
| [Beta Access](/for-users/beta-access.md)             | Beta access and early-user benefits         |
| [Product & Roadmap](/for-users/product-roadmap.md)   | Product capabilities and roadmap            |
| [The Degen Club](/for-users/rewards.md)              | Degen Club rewards overview                 |
| [How It Works](/for-users/rewards/how-it-works.md)   | Reward rounds and distribution              |
| [Credit System](/for-users/rewards/credit-system.md) | Credits, points, and round-one distribution |
| [How to Earn](/for-users/rewards/earning.md)         | Ways to earn                                |
| [Competitions](/for-users/rewards/competitions.md)   | Global and DEX-specific competitions        |
| [Referrals](/for-users/rewards/referrals.md)         | Referral rules                              |
| [FAQ](/for-users/rewards/faq.md)                     | Rewards FAQ                                 |

## For Partner DEXes

| Page                                                                                | Scope                                                   |
| ----------------------------------------------------------------------------------- | ------------------------------------------------------- |
| [Partners](/for-partners/partners.md)                                               | Partner documentation index                             |
| [DEX API Specification](/for-partners/dex-api-spec.md)                              | DEX API overview, authentication, envelope, conventions |
| [GET /dexpal/v1/markets](/for-partners/endpoints/dex-markets.md)                    | Market data                                             |
| [GET /dexpal/v1/metrics](/for-partners/endpoints/dex-metrics.md)                    | DEX metrics                                             |
| [GET /dexpal/v1/rewards](/for-partners/endpoints/dex-rewards.md)                    | Rewards                                                 |
| [GET /dexpal/v1/token](/for-partners/endpoints/dex-token.md)                        | Token data                                              |
| [GET /dexpal/v1/earn](/for-partners/endpoints/dex-earn.md)                          | Earn mechanisms                                         |
| [GET /dexpal/v1/users/{address}/accounts](/for-partners/endpoints/user-accounts.md) | User accounts                                           |
| [GET /dexpal/v1/users/positions](/for-partners/endpoints/user-positions.md)         | User positions                                          |
| [GET /dexpal/v1/users/orders](/for-partners/endpoints/user-orders.md)               | User orders                                             |
| [GET /dexpal/v1/users/history](/for-partners/endpoints/user-history.md)             | User history                                            |
| [GET /dexpal/v1/users/holdings](/for-partners/endpoints/user-holdings.md)           | User holdings                                           |
| [GET /dexpal/v1/users/lp-holdings](/for-partners/endpoints/user-lp-holdings.md)     | User LP holdings                                        |
| [AssetObject](/for-partners/schemas/asset-object.md)                                | Asset object schema                                     |
| [CollateralBreakdown](/for-partners/schemas/collateral-breakdown.md)                | Collateral breakdown schema                             |
| [LeverageTier](/for-partners/schemas/leverage-tier.md)                              | Leverage tier schema                                    |
| [TriggerOrder](/for-partners/schemas/trigger-order.md)                              | Trigger order schema                                    |
| [TradingHours](/for-partners/schemas/trading-hours.md)                              | Trading hours schema                                    |
| [TwapConfig](/for-partners/schemas/twap-config.md)                                  | TWAP config schema                                      |
| [Pagination](/for-partners/schemas/pagination.md)                                   | Pagination schema                                       |
| [Error Responses](/for-partners/schemas/error.md)                                   | Error schema                                            |