Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Ostium home page

Support
Trade Now
Trade Now

Website
Developers
Blog
X/Twitter

SDK

SDK Overview
Errors
Changelog

Client Modes

Client Modes
Client Configuration
Self + Self
Self + Gasless
Delegated + Self
Delegated + Gasless
Read-only
Testnet

Helpers

transaction builders
getTraderAddress
isReadOnly
getSmartAccountAddress
checkUsdcAllowance
getBalances
approveUsdc
setupGaslessDelegation
setDelegate
removeDelegate

Read Methods

getPairs
getAllPrices
getOpenPositions
getOpenOrders
getOrders
getBuilderOrders
getFills
getFillsByTime
getSimSlippage
getSimOrderbook
getCandles
streamPrices
streamPositionUpdates
streamAccountUpdates

Write Methods

openTrade
closeTrade
modifyOrder
updateCollateral
cancelOrder

Builder API

Builder API Overview
GET /v1/prices
POST /v1/ohlc
WS /v1/prices/stream
POST /v1/trade
/v1/subgraph/gn
POST /v1/pimlico/sponsor

Builder

Builder Set Up
Getting keys from the App
React Example

Trader

Traders Overview
Trader Quickstart

Legacy

Legacy Developer Docs

Response schema

Helpers

isReadOnly

Check whether an Ostium client was created in read-only mode.

const readOnly = client.isReadOnly();

Returns true for clients created with createReadOnly().

Response schema

type Response = boolean;

getTraderAddress

getSmartAccountAddress

⌘I

Ostium home page

x github linkedin

Terms of Use Privacy Policy Nasdaq Subscriber Agreement

x github linkedin

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform

Assistant

Responses are generated using AI and may contain mistakes.