API overview - PaperDrill

The REST API lets you read public market data and manage credit-funded orders with a scoped API key. Use the generated endpoint pages for complete request fields, response schemas, and interactive examples.

Connect

Interface	URL
REST API	`https://api.paperdrill.dev/v1`
WebSocket	`wss://api.paperdrill.dev`

Public market-data endpoints do not require authentication. Protected endpoints expect your complete API key in the x-api-key header.

Conventions

Topic	Convention
Decimal values	Prices, quantities, balances, and volumes are strings such as `"125.50"`
Symbols	Use the exact underscore-delimited value returned by `GET /markets`, such as `SOL_USD`
Precision	Read `pricePrecision` and `qtyPrecision` before constructing an order
Timestamps	Responses use either ISO 8601 strings or Unix milliseconds as documented per field
Pagination	Order history uses one-based `page` and `limit` parameters
Request IDs	Save the `X-Request-Id` header when reporting a problem

Keep decimal values as strings until you can process them with decimal or scaled-integer arithmetic.

Retry safely

Retry read requests after 429, 503, or 504 with exponential backoff and jitter. Do not blindly retry order creation after a timeout because the API does not accept an idempotency key; inspect order history first. See Errors and rate limits for recovery guidance, or choose an endpoint for its full contract.