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.

const book = await client.getSimOrderbook({
  pairId: 0,
  levels: 20,
});
Use this for depth views and execution visualizations.

​
Response schema

interface Response {
  pairId: string;
  pairFrom: string;
  pairTo: string;
  levels: [
    Array<{ px: string; sz: string; n: number }>,
    Array<{ px: string; sz: string; n: number }>
  ];
  time: number;
}