SDK

Software Development Kits for integrating Omniston liquidity aggregation.

Available SDKs

Node.js SDK

Full-featured SDK for backend integration:

  • TypeScript support

  • RxJS Observable-based API

  • Comprehensive error handling

  • WebSocket subscriptions

React SDK

React hooks for frontend integration:

  • Ready-to-use React hooks

  • TanStack Query integration

  • Real-time price updates

  • Transaction building and sending

  • Wallet connection support

Installation

Node.js

npm install @ston-fi/omniston-sdk

React

npm install @ston-fi/omniston-sdk-react

Quick Start

Node.js

import { Omniston } from '@ston-fi/omniston-sdk';

const omniston = new Omniston({
  apiUrl: 'wss://omni-ws.ston.fi'
});

omniston.requestForQuote({
  // quote parameters
}).subscribe((quoteEvent) => {
  // handle quote updates
});

React

import { useRfq } from '@ston-fi/omniston-sdk-react';

function SwapComponent() {
  const { data: quote, isLoading, error } = useRfq({
    // quote parameters
  });
  // ... component logic
}

Features

  • Best Price Discovery: Automatically finds optimal swap routes

  • Multi-source Aggregation: Combines liquidity from multiple DEXs

  • Real-time Quotes: Live price updates via WebSocket

  • Transaction Building: Ready-to-send transaction objects

  • Error Handling: Comprehensive error types and recovery

Documentation

See individual SDK documentation for detailed usage:

PreviousOverviewNextNode.js

Last updated