Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ostium.com/llms.txt

Use this file to discover all available pages before exploring further.

Use getPairs() to fetch the market catalog. 
const { pairs } = await client.getPairs();

for (const pair of pairs) {
  console.log(
    pair.pairId,
    `${pair.pairFrom}/${pair.pairTo}`,
    pair.maxLeverage,
    pair.overnightMaxLeverage,
    pair.midPx,
    pair.isMarketOpen,
  );
}

​
Why it matters

  • pairId is used across reads and management flows
  • pairId for openTrade() is sourced from this list
  • leverage and overnight limits determine whether isDayTrade is needed