> For the complete documentation index, see [llms.txt](https://docs.yellow.pro/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yellow.pro/api-and-programmatic-access/overview.md).

# Overview

The Yellow\.pro platform provides REST and WebSocket APIs for authentication, trading, account management, and market data. There are two base URLs:

* **Authentication API** — wallet-based authentication, JWT tokens, and session management
* **Trading API** — trading, positions, transfers, market data, and the WebSocket stream

New here? Start with [**Getting Started with API**](/api-and-programmatic-access/getting-started-with-api.md) to authenticate and obtain your API keys.

## Base URLs

| API                          | Base URL                       |
| ---------------------------- | ------------------------------ |
| Authentication               | `https://auth.api.yellow.pro`  |
| Trading (REST + market data) | `https://trade.api.yellow.pro` |
| WebSocket                    | `wss://trade.api.yellow.pro`   |

{% hint style="info" %}
All examples in these docs use the production hosts above. Market data endpoints are served from the Trading API base URL and require no authentication.
{% endhint %}

## Contents

<table data-view="cards"><thead><tr><th>Section</th><th>Description</th><th data-card-target data-type="content-ref">Target</th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td>Authentication flow, JWT and API key (HMAC) auth</td><td><a href="/pages/A1mfhRAfhFqd11yLirhJ">/pages/A1mfhRAfhFqd11yLirhJ</a></td></tr><tr><td><strong>API Key Management</strong></td><td>Create, list, and revoke API keys; scopes and IP allow-lists</td><td><a href="/pages/Z3MLvjXcrYgvwXhep5Zt">/pages/Z3MLvjXcrYgvwXhep5Zt</a></td></tr><tr><td><strong>Signing Requests with API Keys</strong></td><td>HMAC-SHA256 signature algorithm with Node.js and Python examples</td><td><a href="/pages/rzf8cfsOWGOTIasti2a6">/pages/rzf8cfsOWGOTIasti2a6</a></td></tr><tr><td><strong>Authentication Service API</strong></td><td>Challenge, verify, refresh, login, logout, /auth/me</td><td><a href="/pages/2rOuB3oa1NidRlvJegfY">/pages/2rOuB3oa1NidRlvJegfY</a></td></tr><tr><td><strong>Trading API Service</strong></td><td>Health, auth testing, and exchange market data</td><td><a href="/pages/2Ru1SUrK8zwZxLGVZx3P">/pages/2Ru1SUrK8zwZxLGVZx3P</a></td></tr><tr><td><strong>Market Data API</strong></td><td>Prices, momentum, std, VWMA (no auth required)</td><td><a href="/pages/4MEn0MDlp42nsFaBrAc2">/pages/4MEn0MDlp42nsFaBrAc2</a></td></tr><tr><td><strong>Spot Trading</strong></td><td>Spot accounts, orders, trades, deposits, withdrawals</td><td><a href="/pages/EckwQiJYDFi1hoekJiQS">/pages/EckwQiJYDFi1hoekJiQS</a></td></tr><tr><td><strong>Perpetuals Trading</strong></td><td>Positions, leverage, margin, perp orders, funding</td><td><a href="/pages/moDsy47UG6g0Js1tZxOt">/pages/moDsy47UG6g0Js1tZxOt</a></td></tr><tr><td><strong>Account Transfers</strong></td><td>Internal transfers and send history</td><td><a href="/pages/kGKcEoG276t9oLbtAfr6">/pages/kGKcEoG276t9oLbtAfr6</a></td></tr><tr><td><strong>WebSocket API</strong></td><td>Real-time streams and liquidation warnings</td><td><a href="/pages/1NnLaPr1Zv4BLqfLQfsJ">/pages/1NnLaPr1Zv4BLqfLQfsJ</a></td></tr><tr><td><strong>Error Handling</strong></td><td>Error response formats, codes, HTTP statuses</td><td><a href="/pages/ucuK9QHClhdRd5GaT8r4">/pages/ucuK9QHClhdRd5GaT8r4</a></td></tr><tr><td><strong>Reference</strong></td><td>Rate limits, data types, implementation notes</td><td><a href="/pages/YrKDorjpmd9bY55CV07J">/pages/YrKDorjpmd9bY55CV07J</a></td></tr></tbody></table>