๐Ÿ“Š Get Orderbook

Fetch live bid/ask order book depth for a market outcome using the Forkast SDK to assess liquidity and optimal price levels.

Fetches the order book for a specific market outcome. It provides the live bid/ask depth for a specific outcome, which is useful for showing market liquidity and choosing the best price level before placing orders.

import { ForkastSDK, Network } from "@forkastgg/client";

const sdk = new ForkastSDK(Network.MAINNET, "YOUR_API_KEY");
const marketService = sdk.getMarketService();

const orderBook = await marketService.getOrderBook(123, 1, 0);

Parameters

FieldTypeRequiredDescription
marketIdnumberYesMarket identifier
outcomeIdnumberYesTrade side (0 = buy, 1 = sell)
outcomeTypenumberYesOutcome type

Response

interface OrderBook {
  asks: Array<{ price: number; size: number }>;
  bids: Array<{ price: number; size: number }>;
}

// Example
/*
{
  "asks": [{ "price": 0.75, "size": 100 }],
  "bids": [{ "price": 0.68, "size": 80 }]
}
*/

Key Fields

FieldDescription
asksSell offers with price and available shares
bidsBuy offers with price and available shares