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.

createReadOnly() is the no-signing, no-submission mode.
  • no private key
  • no signer
  • no transaction building
  • all read methods available

When to use it

  • price widgets
  • charts and dashboards
  • analytics tools
  • account views that display positions, orders, fills, or candles

Example

const client = await OstiumClient.createReadOnly();

const { pairs } = await client.getPairs();
const { prices } = await client.getAllPrices();
const positions = await client.getOpenPositions({ user: '0xTraderAddress' });
Write methods throw INVALID_CONFIG in this mode.