SDK

The SDK provides interfaces to communicate with the Onchain LOB API. Here is a description of the TypeScript version of the SDK.

The main object to start with is OnchainLobClient. It holds information about the Onchain LOB API endpoints and the user transaction signing interface.

All methods to interact with the spot market are available in the OnchainLobSpot class.

The SDK also provides type and interface definitions for the objects used.

Getting Started

Prerequisites

Node.js version 20.10.0 or later
npm or Yarn

Installation

Install the SDK package
```
npm install onchain-lob-sdk
```
Install the ws package if you going to use it in the Node.js environment
```
npm install ws
```

PreviousWebsocket API NextOnchainLobClient

Last updated 10 days ago