Skip to content
parchmentdocs
Open app

API reference

Every route of the Parchment public API, version 0.3.0, generated from its OpenAPI document. The TypeScript SDK wraps most routes; the Public API guide covers access and limits.

Base URL

Production
https://api.parchment.trade
Download openapi.json

Conventions

The public HTTP API of Parchment, at https://api.parchment.trade. Every path is also served under /api/parchment (for example /api/parchment/markets), the form the TypeScript SDK uses.

JSON responses wrap their payload as { data }; errors are { error: { code, message } } with an HTTP status. Every integer is an n-suffixed decimal string ("5000000n"), USDC amounts are in base units (6 decimals) and *Wad values are scaled by 1e18. A price that has not been read stays price_unavailable, and referral bonuses stay estimates.

The live price, trade and order streams are Server-Sent Events (text/event-stream). Transaction routes return unsigned transaction bytes for the wallet to sign. Requests are rate limited per client IP; a 429 carries Retry-After.

Routes

Markets5Markets and the synthetic order bookPrices5Storage price reads and the display-only live price streamAccounts11Accounts, open positions, and historyHouse pool (LP)1LP equity and the FIFO claim queuePayout queue2FIFO payout queue length, instantly payable cash, and a wallet's rankStaking3Staking pool and per-staker viewsReferrals1Referral binds and estimated bonusesOrders4Keeper-filled two-step order requestsPreviews2Open and close previewsBuilder codes5Builder codes, ownership, status, on-top fees, and approvalsGame8Game state, leaderboards, feeds, and PnL cardsTransactions3Transaction-kind builders and gas sponsorship of two-step order transactionsProtocol6Config, protocol summary, and API limitsStats2Protocol monitoring: mint cap, payout queue, side exposure, fee split, fill price age, and short-hold PnL by day; daily activity: per-market volume, liquidations and fills, collateral deposits vs withdrawals, with since-launch totals