Public API

Base URL: https://api.parchment.trade

Paths below are relative to the base URL. Each one also answers under the /api/parchment prefix, so /queue and /api/parchment/queue are the same endpoint.

The full reference is the API reference, built from the OpenAPI document at GET /openapi.json. The TypeScript SDK wraps most routes.

Conventions

• camelCase field names.
• Integers in JSON request and response bodies are strings with an n suffix: "10000000n", except staking accRewardPerShare and rewardDebt (u256 values as plain decimal strings). Parse n strings as JavaScript BigInt (drop the n, or use the SDK). Cursors are opaque strings except GET /leaderboards's nextCursor, a u64 n string; pass its digits without the n back as cursor.
• Two exceptions use other encodings. POST /triggers/prepare takes takeProfitWad, stopLossWad and expiresAtMs as plain decimal strings without the n ("78000000000000000000"), exactly as the trigger message signs them, and returns expiresAtMs the same way; an n suffix there returns 400 bad_request. In GET /markets/{id}/corporate-actions, leverageCap and pauseBeforeCloseMinutes (and each event's maxLeverage) are JSON numbers, not strings.
• Numeric query and path parameters (limit, numeric cursor, fromMs, toMs, nowMs, days, ids) use plain decimal numbers without the n: ?limit=10 works; ?limit=10n returns 400.
• Successful JSON response bodies are wrapped as { "data": ... }, except GET /openapi.json, which returns the OpenAPI document unwrapped. The field tables below describe the object inside data. The SDK unwraps it for you.
• Amounts are in base units (USDC has 6 decimals). Prices are 1e18 fixed-point integers.
• Previews are estimates at the current mid, not fills.
• There is no order book. Normal fills are at the oracle mid.

Routes

{owner} and {walletAddress} are wallet addresses.

POST /sponsor sponsors gas for a session-key trade. POST /sponsor/execute executes a sponsored transaction with its signatures. POST /orders/digest-hint takes a request transaction's digest and hands its pending orders to the keeper. See Gas sponsorship.

Transaction actions

POST /transactions/{action} returns an unsigned transaction kind: txBytesBase64, commands (the Move calls) and note. Gas is not included. The body is the action's input; see the OpenAPI document.

exit-early-bounded takes unlocks and maxPenalty. It exits exactly the quoted entries (pass the game profile's earlyExitUnlocks) and aborts on chain if it would forfeit more than maxPenalty (pass earlyExitPenaltyNow). Prefer it to exit-early, which exits every entry eligible when it executes.

liquidate, liquidate-retired and sweep answer 403 keeper_only, with no transaction. Liquidation is permissionless on chain, not through this API.

Payout queue

GET /queue

GET /accounts/{walletAddress}/queue

Pool and staking

GET /lp includes stakerShareBps: the stakers' share of the next retained fee at current coverage, and the curve parameters stakerShareMinBps, stakerShareMaxBps, stakerCovLowBps, stakerCovHighBps.

GET /staking includes the PARCHMENT penalty payout to stakers: parchDripRemaining, parchDripNow, parchDripLastMs, parchDripEndMs.

Locked and vesting PARCHMENT

GET /game/{walletAddress}

These fields are null unless lockedLedgerStatus is "current".

Transaction builders: POST /transactions/release-unlocked, POST /transactions/exit-early-bounded and POST /transactions/exit-early. All return unsigned transactions for your wallet to sign.