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

API Reference

Info Methods

Read-only methods. No wallet or signature is required.

getAsset getResolutionPrice getLastResolutionPrice getBalance getOrderBook getBookOrders getTopOfBook getPosition getAgentApproval getAgentApprovalNonce getExchangeConfig

Info Methods

Exchange Methods

All submitted actions are signed with the configured EOA wallet.

placeOrder placeAgentOrder cancelOrder cancelAll cancelReplaceOrder cancelAgentOrder cancelAllAgent cancelReplaceAgentOrder claim claimAgent withdraw approveAgent revokeAgent signAgentApproval

Exchange Methods

Deposit Methods

These methods communicate directly with onchain contracts through the configured RPC URL.

getSettlementToken getPermit2 getAccountLedger getPendingBalance getProcessedBalance getPendingDepositCount getNextPendingDepositId getProcessedDepositIndex getMinBlockWait canProcessNext getSettlementTokenBalance getSettlementTokenAllowance approveDepositLedger approvePermit2 deposit signDepositPermit depositWithPermit parseAmount

Deposit Methods

Susbcription Methods

These methods manage the market WebSocket connection and subscribe to real-time order, trade, cancel, and resolution updates by assetId.

connect close subscribeOrderBook unsubscribeOrderBook

Subscription Methods

Oracle Methods

These methods manage the oracle WebSocket connection and subscribe to real-time price updates by symbolId.

connect close subscribePrice unsubscribePrice

Oracle Methods

Last updated