Info API (Beta)
POST /info serves every read-only query — market metadata, balances, positions, orders, the book, fees, and history. Reads need no signature. The body's type field selects the query, and each type has its own page with a Try it panel.
{ "type": "l2Book", "coin": "4" }coin is the instrument's numeric id as a string — the index from perpMeta, or an Outcome market's instrument_id from outcomeMeta. Outcome reads that take instrumentId / instrumentIds want it as an integer. Send the exact camelCase type shown on each page; accountAccessStatus requires a case-sensitive match. Every type goes to the same host, even those answered by the API service rather than the node — see Networks.
Request types
Shared
Reads that are not tied to one instrument type. clearinghouseState picks the sub-account with accountType (perp or outcome), and getMaxPositions takes a perp or an Outcome instrument. The history types are served from an index and can briefly lag the latest block; most are paged — see Paged history.
| Type | Use it to |
|---|---|
l2Book | Take a one-off order-book snapshot for one instrument. |
trades | Seed the public trade tape for one instrument with its latest 300 trades. |
clearinghouseState | Load the Positions panel: every position plus the margin summary, for the perp or outcome sub-account. |
frontendOpenOrders | Render the Open Orders tab, including trigger and TP/SL fields. Outcome orders appear only with exchangeId: 1 or "all". |
userFees | Show the maker / taker rate a user currently pays. |
feeTierInfo | Render the static fee-tier ladder (volume thresholds → rates). |
feeTierRates | Show effective rates for an account type, including the user’s tier and referral discount. |
builderState | Read a builder’s on-chain claimable balance and fee eligibility before claimBuilderRewards. |
referral | Render the Referral page: referrer, rewards, referrer stage. |
userRole | Pick the referral view to render: regular user, referrer, or affiliate. |
userClaimRewards | Render the referral reward claim history. |
agentOwner | Check whether an agent key is still authorized, and for which account. |
approvedAgents | List the agent keys an account has approved (e.g. an API-key management page). |
getLatestBlockNumber | Check node liveness or read the current block height. |
epochHistory | Map block numbers to consensus epochs. |
exchangeRates | Convert USDC amounts to USD or a local fiat currency for display. |
tags | Label instruments with tag names; resolves the tagIds on webData2 asset rows. |
marketTags | Build the markets menu: top-level tabs, their sub-tags, and which instruments sit under each. |
userOverview | Fill a portfolio or vault performance card: PnL, ROE, volume, max drawdown, equity over a period. |
candleSnapshot | Seed a candlestick chart; then keep the last bar live with candle. |
historicalOrders | Render the Order History tab (limit / market orders). |
historicalTpslOrders | Render the TP/SL tab of Order History. |
historicalTriggerOrders | Render the Trigger tab of Order History. |
twapHistory | Render the TWAP tab of Order History (finished or cancelled TWAPs). |
orderDetails | Open an order-detail view from one orderId. |
userFills | Render Trade History / reconcile executions (maker or taker fills). |
userTwapSliceFills | List the individual child fills of a user’s TWAP orders. |
userFundings | Render Funding History (collected and paid settlements). |
userNonFundingLedgerUpdates | Render the Deposits & Withdrawals / transfer ledger. |
getMaxPositions | Compute the max buy / sell size at a price the user typed into the order ticket. |
Account setup
Query a main account's bound referral code and channel trading access with accountAccessStatus. This is a public POST /info query; it does not require a signature or Token. Trading access does not guarantee that an order passes every validation.
| Type | Use it to |
|---|---|
accountAccessStatus | Query a main account’s bound referral code and trading access on a channel. |
approvedBuilders | List every builder a user has approved and its fee cap (e.g. a builder-approval settings page). |
maxBuilderFee | Check that a user has approved your builder, and at what cap, before sending orders with a builder fee. |
approveAgentEligibility | Decide whether to show “Enable trading” or a deposit prompt before approveAgent. |
Deposits & withdrawals
Served by the API service, not the node.
| Type | Use it to |
|---|---|
settings | Look up the Bridge2 contract address before a native Arbitrum USDC deposit. |
depositWithPermit | Deposit Arbitrum USDC for a user who holds no ETH for gas (signs an EIP-2612 permit). |
dayTotalWithdraw | Show how much a user has already withdrawn today on the withdraw form. |
sendTokenFee | Show the activation fee on a send or cross-chain withdraw form before signing tokenSend. |
Builder
Analytics for a builder's own dashboard. Pass the builder wallet address as user.
| Type | Use it to |
|---|---|
builderMeOverview | Headline numbers for a builder dashboard: users, volume, fees, rank. |
builderMeDailySeries | Plot a builder’s daily fees or user count. |
builderMeShare | Break a builder’s fees down by trading user or by instrument. |
builderMeEarned | List a builder’s earnings, one row per order. |
builderMeClaimed | List a builder’s past reward claims. |
builderMeClaimable | Show claimable vs. lifetime earned / claimed on a builder dashboard. |
Vaults
Vault profiles and a user's vault holdings. Deposit and withdraw with vaultTransfer.
| Type | Use it to |
|---|---|
vaultDetails | Render a vault page: profile, TVL, lock-up, depositors, and one user’s withdrawable amount. |
uservaultequities | List the vaults a user holds, with current equity and lock-up end. |
Perpetuals
Market metadata, positions, margin, and the order types only perpetuals accept (triggers and TP/SL).
| Type | Use it to |
|---|---|
perpMeta | Resolve perp symbols to the numeric coin id every other call takes. Cache at startup. |
perpMetaDetail | Show margin tiers and max leverage for one base asset (BTC, not BTC-USDC). |
marketTicker | Fill a perp market header on first load: last, mark, oracle, funding, 24h change and volume. |
activeAssetCtx | Show a perp market header: mark, oracle, funding rate, open interest. |
webData2 | Fill a markets table with 24h stats for every instrument, plus the user’s open orders, in one call. |
perpClearinghouseState | Show token balances held in the perp sub-account. |
activeAssetData | Fill the order ticket: the user’s leverage, max tradeable size, and available margin on one instrument. |
triggerOrders | List a user’s pending trigger (stop) orders, with any TP/SL children. |
tpslOrders | List all of a user’s pending take-profit / stop-loss orders. |
positionTpslOrders | Show the TP/SL pairs bound to one open position (position row → its TP/SL). |
tpslOrderPosition | Resolve a TP/SL child order id back to the position it protects (order → position). |
getLiquidationPrices | Preview the estimated liquidation price before the user submits an order. |
preCheckIsolatedMarginAdjust | Fill the Adjust Margin dialog: max add / remove and the new liquidation price before updateIsolatedMargin. |
Outcome
Event and market metadata, market context, positions, and open orders, plus the timeline and price-window data of recurring crypto markets. The metadata, context, timeline, price, and probability types are API-service aggregations. For one market's book, use the shared l2Book; for account value and margin, clearinghouseState with accountType: "outcome".
| Type | Use it to |
|---|---|
outcomeMeta | Build the Outcome discovery feed or an event page: events, nested markets, live prices, settlement state. |
outcomeNavTags | Build the Outcome category bar and tag menu; each node carries the category / tag to pass to outcomeMeta. |
outcomeAssetCtxs | Fill 24h volume / price-change columns in an Outcome market grid. |
outcomeSeriesTimeline | Render the past / current / upcoming window strip of a recurring crypto Outcome series. |
cryptoPrice | Show the price-to-beat and settlement price of a crypto Outcome window. |
cryptoPriceHistory | Seed the underlying-asset price chart on a crypto Outcome market. |
outcomeProbability | Backfill a YES-probability chart; append live closes from candle. |
outcomeMetaByInstrument | Read on-chain trading params (tick, fee curve, resolution status) for one Outcome instrument. |
outcomeL2Book | Snapshot the books of several Outcome instruments at once (e.g. every market of an event). |
outcomePositions | List a user’s Outcome positions with event title and outcome names attached. |
outcomeBalances | Show token balances held in the Outcome sub-account. |
outcomeFrontendOpenOrders | Render resting Outcome orders with event title, slug, and outcome names attached. |
Paged history
The order, fill, funding, and ledger history types share one paging scheme. candleSnapshot, orderDetails, and userTwapSliceFills do not use it.
| Response | data is { data, hasMore, total? }: the rows, whether more exist, and the total when known |
| Paging | offset / limit — default 300, max 2000, newest first |
| Filters | user, startTimeMs / endTimeMs, accountType, contract (all / active), coin, side |
| Side | Buy / Sell on the request; responses use B / A |