# Forkast

> Documentation for Forkast, the prediction market for esports and crypto — user guides, SDK integration, and full REST API reference.

## Knowledge Center

- [📚 Forkast Knowledge Center](https://docs.forkast.gg/knowledge-center/overview.md): Explore the Forkast Knowledge Center for guides on account setup, platform mechanics, rewards, security, and developer resources to master the platform.
- [🗂️ Table Of Content](https://docs.forkast.gg/knowledge-center/table-of-content.md): Explore Forkast's full documentation, covering account setup, platform mechanics, rewards, fees, security practices, and frequently asked questions.
- [👋 Introduction](https://docs.forkast.gg/knowledge-center/introduction.md): Forkast uses a hybrid-decentralized Binary Limit Order Book (CLOB) for fast, transparent, and non-custodial prediction market trading on real-world events.
- [🚀 Sign Up on Forkast](https://docs.forkast.gg/knowledge-center/sign-up-on-forkast.md): Learn how to sign up on Forkast using email, Google SSO, or a Metamask wallet, then set up your trading wallet to start trading.
- [💸 Fee Structure](https://docs.forkast.gg/knowledge-center/fee-structure.md): Learn Forkast's fee structure, including the trading fee and withdrawal fee, plus a current zero-fee promotional period through July 2026.
- [👤 Profile Page](https://docs.forkast.gg/knowledge-center/profile-page.md): Explore the Profile Page to view your wallet details, portfolio value, cash balance, profit/loss, trading volume, and position history.
- [⚙️ Platform Mechanics](https://docs.forkast.gg/knowledge-center/platform-mechanics.md): Learn how Forkast's Platform Mechanics power its CLOB, prediction markets, proxy wallets, and reward programs for gaming and esports trading.
- [🪙 Trading Credits (TC)](https://docs.forkast.gg/knowledge-center/platform-mechanics/trading-credits-tc.md): Learn how Trading Credits (TC) work on Forkast, including how to obtain, convert USDC into, and transfer them within your trading wallet.
- [📅 Markets & Events](https://docs.forkast.gg/knowledge-center/platform-mechanics/markets-and-events.md): Learn how prediction markets and events work, letting users trade on future outcomes and explore related markets grouped by shared topics.
- [📊 Order Book](https://docs.forkast.gg/knowledge-center/platform-mechanics/order-book.md): Learn how Forkast's order book matches buy and sell orders, explains market and limit order types, and helps you manage open positions.
- [🤝 Order Matching Mechanism](https://docs.forkast.gg/knowledge-center/platform-mechanics/order-matching-mechanism.md): Learn how Forkast's order matching engine prioritizes normal, mint, and merge matching to ensure fair and efficient prediction market trades.
- [🏷️ Price-Suggesting Rules](https://docs.forkast.gg/knowledge-center/platform-mechanics/price-suggesting-rules.md): Learn how the Price-Suggesting Rule uses order book data to recommend competitive buy and sell prices for market and limit orders.
- [👛 Trading Wallets](https://docs.forkast.gg/knowledge-center/platform-mechanics/trading-wallets.md): Trading Wallets on Forkast let you trade without ETH for gas fees or manual market approvals, saving you time and money.
- [🧩 Conditional Tokens Framework](https://docs.forkast.gg/knowledge-center/platform-mechanics/conditional-tokens-framework.md): Learn how Forkast's Conditional Tokens Framework tokenizes prediction market outcomes using ERC1155 tokens for splitting, merging, and redeeming positions.
- [📜 Smart Contracts](https://docs.forkast.gg/knowledge-center/platform-mechanics/smart-contracts.md): Explore Forkast's core smart contracts, including Conditional Tokens, CTF Exchange, and Gnosis Safe Proxy, powering its prediction market ecosystem.
- [🔐 Security](https://docs.forkast.gg/knowledge-center/platform-mechanics/smart-contracts/security.md): Forkast's security relies on audited open-source contracts like ConditionalTokens, GnosisSafe, CTFExchange, and OpenZeppelin to protect user funds
- [🎁 Platform Rewards](https://docs.forkast.gg/knowledge-center/platform-rewards.md): Explore Forkast's platform rewards, including liquidity, leaderboard, quest, trading credit codes, and referral incentives for active users.
- [💧 Liquidity Incentives](https://docs.forkast.gg/knowledge-center/platform-rewards/liquidity-incentives.md): Learn how liquidity rewards pay USDC for resting limit orders, boosting order book depth and improving trade execution for all users.
- [🔬 Liquidity Rewards in Depth](https://docs.forkast.gg/knowledge-center/platform-rewards/liquidity-incentives/liquidity-rewards-in-depth.md): Learn how liquidity rewards work, including core mechanics, minimum size cutoffs, max spread rules, and how to earn USDC payouts daily.
- [🧮 Liquidity Calculation Equations](https://docs.forkast.gg/knowledge-center/platform-rewards/liquidity-incentives/liquidity-calculation-equations.md): Learn the equations behind Forkast's Liquidity Rewards Program, including scoring functions and formulas for calculating provider reward shares.
- [🏆 Leaderboard Rewards](https://docs.forkast.gg/knowledge-center/platform-rewards/leaderboard-rewards.md): Learn how Forkast's weekly leaderboard rewards work, including qualification rules, volume and gains formulas, and how to claim your rewards.
- [🗺️ Quests](https://docs.forkast.gg/knowledge-center/platform-rewards/quests.md): Explore Forkast's Questing Rewards, complete trading challenges and milestones, and earn USDC or Trading Credits for your achievements.
- [🎟️ Trading Credit Codes](https://docs.forkast.gg/knowledge-center/platform-rewards/trading-credit-codes.md): Learn how to redeem Trading Credit Codes on Forkast to claim Trading Credits for platform trading through rewards and promotions.
- [📣 Referral System: How It Works](https://docs.forkast.gg/knowledge-center/platform-rewards/referral-system-how-it-works.md): Learn how Forkast's referral system rewards users with trading fee discounts and shared earnings for inviting active new members to the platform.
- [❓ FAQs](https://docs.forkast.gg/knowledge-center/faqs.md): Learn how Forkast's prediction market works on Arbitrum, including account creation, proxy wallets, supported browsers, and blockchain details.
- [⚠️ Wallet Errors FAQ](https://docs.forkast.gg/knowledge-center/faqs/wallet-errors-faq.md): Learn how to fix common Ronin Waypoint wallet errors on Forkast, including popup blocks, wallet detection issues, and token approval failures.
- [❗ Trading Errors FAQ](https://docs.forkast.gg/knowledge-center/faqs/trading-errors-faq.md): Find solutions to common trading errors like insufficient balance, limit price issues, order minimums, and wallet signature failures in this FAQ.
- [💵 Refund Policy](https://docs.forkast.gg/knowledge-center/refund-policy.md): Learn how Forkast handles refunds for canceled or ambiguous markets, including eligibility rules, credit code policies, and the resolution process.
- [🚫 Cancelled Markets](https://docs.forkast.gg/knowledge-center/cancelled-markets.md): Learn when and why Forkast may cancel a market, what triggers a cancellation, and what happens to redemptions and refunds afterward.
- [🛡️ Security Best Practices](https://docs.forkast.gg/knowledge-center/security-best-practices.md): Learn essential security best practices for Forkast, including phishing prevention, private key protection, and tools to safeguard your crypto assets.

## Developer Docs

- [👨‍💻 Forkast Developer Docs](https://docs.forkast.gg/developers/overview.md): Explore Forkast developer docs to integrate TypeScript or Python SDKs for placing orders, tracking balances, and accessing live market data.
- [📖 Glossary](https://docs.forkast.gg/developers/glossary.md): Explore the Forkast SDK glossary for clear definitions of events, markets, tokens, outcomes, order books, and proxy wallets.
- [🤖 MCP Server Integration](https://docs.forkast.gg/developers/mcp-server-integration.md): Connect AI coding tools like Copilot, Cursor, and Claude Code to our MCP server for structured access to Forkast SDK docs and API references.
- [🧰 Forkast SDK Integration Guide](https://docs.forkast.gg/developers/sdk-guide.md): Learn to install and initialize the Forkast SDK for Node.js and Python, then explore markets, accounts, and orders with code examples.
- [👤 Account](https://docs.forkast.gg/developers/sdk-guide/account.md): Learn how to authenticate, manage trading credits, retrieve positions, redeem markets, and view portfolio stats using ForkastSDK account functions.
- [🔑 Authenticate with Key](https://docs.forkast.gg/developers/sdk-guide/account/authenticate-with-key.md): Learn how to authenticate with Forkast SDK by signing a message using your wallet private key to obtain a valid access token.
- [✅ Approve Trading Credits](https://docs.forkast.gg/developers/sdk-guide/account/approve-trading-credits.md): Learn how to sign a Gnosis Safe multisend transaction to approve Trading Credits and Conditional Tokens using the Forkast SDK.
- [📈 Get Positions by Market Status](https://docs.forkast.gg/developers/sdk-guide/account/get-positions-by-market-status.md): Fetch a paginated list of user positions filtered by market status using the Forkast SDK, sorted by current value descending.
- [🏦 Redeem Positions By Markets](https://docs.forkast.gg/developers/sdk-guide/account/redeem-positions-by-markets.md): Redeem winning positions across multiple markets in one multisend transaction using the Forkast SDK with TypeScript code examples.
- [📊 Get Portfolio Stats](https://docs.forkast.gg/developers/sdk-guide/account/get-portfolio-stats.md): Retrieve a user's portfolio stats—PnL, ROI, volume, and trade count—using an accessToken or userId with the Forkast SDK.
- [🏪 Market](https://docs.forkast.gg/developers/sdk-guide/market.md): Access read-only market data—events, order books, token prices, and categories—to discover markets and display live pricing.
- [📅 Get All Events](https://docs.forkast.gg/developers/sdk-guide/market/get-all-events.md): Learn how to fetch a paginated list of market events using the Forkast SDK, with optional filtering by status, page, and limit.
- [🔍 Get Event Data](https://docs.forkast.gg/developers/sdk-guide/market/get-event-data.md): Learn how to fetch detailed event data by eventId using the Forkast SDK, including accessing specific markets and outcome identifiers.
- [📊 Get Orderbook](https://docs.forkast.gg/developers/sdk-guide/market/get-orderbook.md): Fetch live bid/ask order book depth for a market outcome using the Forkast SDK to assess liquidity and optimal price levels.
- [💲 Get Token Prices](https://docs.forkast.gg/developers/sdk-guide/market/get-token-prices.md): Learn how to fetch token price info for a market and side using the ForkastSDK getTokenPrices method with the Forkast API.
- [🧾 Order](https://docs.forkast.gg/developers/sdk-guide/order.md): Learn how OrderService enables authenticated order management, including placing single or bulk orders, fetching open orders, and cancelling trades.
- [📋 Get Orders](https://docs.forkast.gg/developers/sdk-guide/order/get-orders.md): Fetch paginated orders for a wallet address filtered by outcome ID and status using the Forkast SDK order service.
- [🎯 Place Single Order](https://docs.forkast.gg/developers/sdk-guide/order/place-single-order.md): Learn how to place a single limit buy or sell order using the Forkast SDK by validating, signing, and submitting it.
- [📤 Place Bulk Orders](https://docs.forkast.gg/developers/sdk-guide/order/place-bulk-orders.md): Place up to five limit orders in a single request with the Forkast SDK, validating and signing each order before submission.
- [🧹 Cancel All Orders by Market](https://docs.forkast.gg/developers/sdk-guide/order/cancel-all-orders-by-market.md): Cancel all open orders by outcome, market, or event using the Forkast SDK with a single required identifier parameter.
- [❌ Cancel Specific Order](https://docs.forkast.gg/developers/sdk-guide/order/cancel-specific-order.md): Cancel a specific order by its order ID using the Forkast SDK with TypeScript examples, required parameters, and authentication details.
- [💰 Balance](https://docs.forkast.gg/developers/sdk-guide/balance.md): Learn how to retrieve user wallet balances with ForkastSDK, including USDC, USDT, and CGPC balances via the getBalances function.
- [⏱️ Rate Limits](https://docs.forkast.gg/developers/sdk-guide/rate-limits.md): Learn Forkast's API rate limits, including global and endpoint-specific caps, HTTP 429 errors, and best practices for handling requests.
- [💡 Examples](https://docs.forkast.gg/developers/sdk-guide/examples.md): Learn how to authenticate, place and cancel bulk orders, and redeem resolved positions using ready-to-run TypeScript examples with the Forkast client.
- [✍️ Create Order Signature](https://docs.forkast.gg/developers/sdk-guide/create-order-signature.md): Learn how to create and sign Forkast orders using EIP-712 typed data, including domain setup, order structure, and amount calculations.
- [📝 Changelog](https://docs.forkast.gg/developers/sdk-guide/changelog.md): Browse the Forkast SDK changelog for release notes covering the TypeScript client on npm and Python client on PyPI.
- [🔌 Websockets](https://docs.forkast.gg/developers/websockets.md): Learn to connect via Socket.IO WebSockets, join rooms, and subscribe to static and dynamic topics for real-time market and user updates.
- [📡 Market Updates](https://docs.forkast.gg/developers/websockets/market-updates.md): Learn how to receive real-time Socket.IO updates for market orderbooks, trades, open orders, and volume with this WebSocket API guide.
- [🔔 User Updates](https://docs.forkast.gg/developers/websockets/user-updates.md): Connect to the socket server as an authenticated user to receive real-time updates on your positions, activities, and TC balance.

## API Reference

- [Login with signed message](https://docs.forkast.gg/api-reference/auth/login-with-signed-message.md): Authenticate with a Web3 wallet. Submit the wallet-signed login message together with your session ID to receive a JWT access token, refresh token, and user…
- [Get user profile](https://docs.forkast.gg/api-reference/user/get-user-profile.md): Returns the authenticated user's profile, including display name, avatar, wallet and proxy-wallet addresses, and account preference flags.
- [Get user profit](https://docs.forkast.gg/api-reference/user/get-user-profit.md): Returns profit statistics for a user. Defaults to the authenticated user; pass userId to look up another account's public profit stats.
- [Get user trade volume](https://docs.forkast.gg/api-reference/user/get-user-trade-volume.md): Returns the total traded volume for a user, used for volume-based stats and leaderboard calculations.
- [Get user traded count](https://docs.forkast.gg/api-reference/user/get-user-traded-count.md): Returns the number of trades a user has executed on the platform.
- [Get user balances](https://docs.forkast.gg/api-reference/balances/get-user-balances.md): Returns the authenticated user's Trading Credit balances available for placing orders.
- [Get outcome balances](https://docs.forkast.gg/api-reference/balances/get-outcome-balances.md): Returns the authenticated user's share balances for each outcome of the given market token.
- [Get event by slug](https://docs.forkast.gg/api-reference/markets/get-event-by-slug.md): Fetches a single event by its URL slug, including its markets, outcomes, resolution status, and metadata.
- [List events](https://docs.forkast.gg/api-reference/markets/list-events.md): Lists prediction-market events with pagination. Each event includes its markets, outcomes, and current pricing snapshot.
- [Get order book](https://docs.forkast.gg/api-reference/markets/get-order-book.md): Returns the live order book (bids and asks with price levels and sizes) for a market outcome. outcomeType selects the side: 0 = Yes, 1 = No.
- [Get token prices](https://docs.forkast.gg/api-reference/markets/get-token-prices.md): Returns current outcome-token prices for a market, optionally filtered by order side.
- [List categories](https://docs.forkast.gg/api-reference/categories/list-categories.md): Lists the market categories (e.g. esports, crypto, sports) used to organize events on Forkast.
- [Get orders](https://docs.forkast.gg/api-reference/orders/get-orders.md): Lists orders for the authenticated wallet, filtered by outcome and order status, with pagination.
- [Cancel order by ID](https://docs.forkast.gg/api-reference/orders/cancel-order-by-id.md): Cancels a specific open order by its ID. Only the order's owner can cancel it.
- [Cancel all orders by outcome ID](https://docs.forkast.gg/api-reference/orders/cancel-all-orders-by-outcome-id.md): Cancels all of the authenticated wallet's open orders for the given outcome.
- [Cancel all orders by market ID](https://docs.forkast.gg/api-reference/orders/cancel-all-orders-by-market-id.md): Cancels all of the authenticated wallet's open orders in the given market.
- [Place single order](https://docs.forkast.gg/api-reference/orders/place-single-order.md): Places a single limit order. Send the order parameters (token, side, price, amount) together with the EIP-712-signed CTF Exchange order object produced by the…
- [Place bulk orders](https://docs.forkast.gg/api-reference/orders/place-bulk-orders.md): Places multiple signed limit orders in a single request. Each entry carries its own EIP-712-signed order object; the response reports per-order results.
- [Get positions](https://docs.forkast.gg/api-reference/positions/get-positions.md): Lists the authenticated user's positions with market/outcome filters and pagination, including size, average price, and current value.
- [Get signature discount](https://docs.forkast.gg/api-reference/positions/get-signature-discount.md): Returns a signed fee-discount voucher (signature, expiration, percent) for the authenticated wallet, which can be attached to order placement to apply the…
- [Redeem positions](https://docs.forkast.gg/api-reference/positions/redeem-positions.md): Redeems the authenticated user's winning positions in resolved markets.
- [Split position](https://docs.forkast.gg/api-reference/positions/split-position.md): Splits collateral into a full set of outcome tokens via the Conditional Tokens Framework. Requires a Gnosis Safe transaction signature (signature + dataSign).
- [Merge position](https://docs.forkast.gg/api-reference/positions/merge-position.md): Merges a full set of complementary outcome tokens back into collateral via the Conditional Tokens Framework.