Forkast Dev Docs
Welcome to the Forkast developer hub. Here you will find everything required to integrate with our Central Limit Order Book (CLOB) services—order book depth, real-time pricing, historical data, and aggregated spreads.All endpoints documented here are powered by our OpenAPI specification. Use the playground on each page to send test requests against
https://clob.forka.st (CLOB), https://relayer.forka.st (Relayer), or https://data-api.forka.st (Data API).Quick navigation
Jump straight into the resources you need. Every link below opens the corresponding API reference page, so you have an easy index even on mobile devices.Platform
- Introduction — overview of the Forkast CLOB ecosystem and documentation structure.
- API Rate Limits — current throttling caps for live Forkast endpoints.
Authentication
- Authentication overview — understand L1 wallet signing and L2 API credential flows.
- Create API key — issue deterministic credentials from an L1 signature.
- Revoke API key — invalidate an existing API key/pair.
- List API keys — inspect active and revoked credentials for an address.
CLOB
Health
- API Health Check — simple readiness probe that returns
OK.
Orderbook
- Get order book summary — single-token snapshot of bids, asks, and market metadata.
- Get multiple order books summaries by request — batch snapshots for multiple tokens in one call.
Orders
- Create order — submit new orders to the Forkast CLOB with configurable execution policies.
- Place multiple orders (batch) — queue up to 15 placements in a single call.
- Get order — inspect status, fills, and trade associations for a previously submitted order.
- Get orders by IDs — batch retrieval (HTTP 207 Multi-Status) of up to 500 order details in one call.
- List open orders — stream the live orders owned by your authenticated L2 credentials.
- Cancel order — remove resting orders by ULID and see which cancellations succeeded.
Pricing
- Get market price — best bid/ask for a token-side pair.
- Get multiple market prices by request — batch POST variant that returns quotes for every requested side.
- Get midpoint price — midpoint quote for any token.
- Get price history for a traded token — historical price series with configurable window and fidelity.
- Get bid-ask spreads — aggregated spread information for one or more tokens.
Trades
- Trades overview — recap of how authenticated trade feeds work.
- List trades — filter fills where your credentials acted as maker or taker.
- Get trade volumes — fetch aggregate and 24h volumes for up to 100 conditions.
Relayer
- Relayer Health Check — confirm that
https://relayer.forka.stis returningOK.
Wallet
- Proxy wallet call — batched RelayHub calls routed through the managed relayer host.
- Deploy Safe wallet — SafeProxyFactory deployment identical to the former CLOB endpoint, now hosted on the relayer domain.
Relayer core
- Get relayer nonce — discover the next nonce for
SAFEorSAFE-CREATEoperations. - List relayer transactions — retrieve the full history of submissions tied to your credentials.
- Get relayer transaction — poll a single
transactionIDfor state transitions. - Submit relayer transaction — primary entry point for Safe executions and deployments.
- Check Safe deployment — confirm if a deterministic Safe address already exists on-chain.
Auxiliary operations
- Relayer approve operation — ask the operator to issue ERC-20
approve()transactions. - Relayer set-approval operation — toggle
setApprovalForAllon Conditional Tokens. - Relayer split position — convert collateral into outcome tokens via the relayer.
- Relayer merge position — merge outcome positions back into collateral.
- Relayer redeem position — redeem resolved outcome tokens and return collateral.
Data API
- Data API overview — explains the analytics-focused surface powered by Forkast subgraphs.
- Health check — confirms
https://data-api.forka.stis running.
Portfolio
- Get current positions — cached balances plus unrealized PnL.
- Get closed positions — realized trades with exit timestamps.
- Get portfolio value — fetch per-wallet USD exposure.
- Get total markets traded — count unique markets for a wallet.
Activity & markets
- Get trades — replay Forkast fills with maker/taker data.
- Get user activity — ledger view that includes splits, merges, and rewards.
- Get top holders — leaderboard of balances per market.
- Get open interest — cached OI per condition ID.
- Get live volume for an event — aggregate collateral flow per event.
Builders
- Get aggregated builder leaderboard — preview of partner performance metrics.
- Get daily builder volume time-series — day-by-day builder stats.
Working with the playground
1
Open an endpoint and ensure the required parameters are filled in. Defaults are provided where possible.
2
Click Send request to hit the live environment. Responses include headers, body, and timing information.
3
Use the Copy button above the generated cURL snippet to bring requests into your tooling or scripts.
Glossary
| Term | Definition |
|---|---|
| Token | Represents exposure to a specific yes/no outcome within a market. Prices float between 0 and 1 to reflect sentiment, and the token tied to the resolved outcome redeems for 1 USDC. Tokens are sometimes referred to as asset IDs. |
| Market | A single outcome pairing on the CLOB. Each market references two token IDs (yes/no), plus a market address, question ID, and condition ID. |
| Event | A collection of closely related markets grouped under a shared topic so traders can find the entire set at once. |
| Slug | A human-readable identifier embedded in the URL for a market or event, designed to be easy to reference and share. |
| Central Limit Order Book | The off-chain matching engine that processes resting and market orders before any settlement is posted on-chain. |
| Polygon Network | The layer-2 blockchain that Forkast uses for on-chain lifecycle actions such as contract deployment and token transfers. |
| Fork | A copy and adaptation of an open-source project. In Forkast, it refers to creating your own prediction market connected to global liquidity. |