For the complete documentation index, see llms.txt. This page is also available as Markdown.

Getting Started with API

Authenticate with the Yellow.pro API and start calling endpoints.

This guide walks you through authenticating with the Yellow.pro API so you can start calling endpoints.

All trading, account, and transfer endpoints require authentication. Market data endpoints are public and need no credentials.

For API base URLs, see Base URLs.

Authentication Flow

Yellow.pro uses Ethereum wallet-based authentication with a challenge-response mechanism:

1

Request a challenge

POST to /auth/challenge with your wallet address.

2

Sign the challenge

Sign the returned challenge text with your Ethereum wallet.

3

Verify the signature

POST to /auth/verify with your wallet address, the challenge, and the signature.

4

Receive tokens

Get a JWT access token and a refresh token for API access.

5

Use the access token

Include the JWT in the Authorization header on authenticated endpoints.

Authorization: Bearer <your-jwt-token>

See the Authentication Service API for full request and response details on each endpoint.

Authentication Methods

All authenticated endpoints support two authentication methods.

Obtained via the /auth/verify endpoint. Include the token in the Authorization header:

Authorization: Bearer <token>

Supported by all authenticated endpoints.

Security Notes

Next Steps

Create an API key

Section
Description
Target

API Key Management

Create, list, and revoke API keys

Signing Requests with API Keys

HMAC-SHA256 signing with code examples

Market Data API

Prices and indicators (no auth required)

Spot Trading

Place and manage spot orders

Perpetuals Trading

Positions, leverage, and perpetual orders

Last updated

Was this helpful?