LogoLogo
  • About XPress
  • Trading
    • Order Book
    • Order Types
    • Fees
  • Architecture
    • Prices and Precision
    • Gas costs
  • Audits
  • LP Vault
    • Overview
    • Token Composition
  • Deposits & Withdrawals
  • FOR DEVELOPERS
    • API
      • Contract API
      • Common objects
      • HTTP API
      • Websocket API
    • SDK
      • OnchainLobClient
      • OnchainLobSpot
    • Router Integration
Powered by GitBook
On this page
  • Getting Started
  • Prerequisites
  • Installation
  1. FOR DEVELOPERS

SDK

PreviousWebsocket APINextOnchainLobClient

Last updated 5 months ago

The 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

  • version 20.10.0 or later

  • or

Installation

  1. Install the SDK package

    npm install onchain-lob-sdk

  2. Install the package if you going to use it in the Node.js environment

    npm install ws
SDK
Node.js
npm
Yarn
ws