Skip to main content

​
Compatibility

SDK v0.5.x is compatible with the latest Maker API version. The SDK automatically supports the most recent Maker API release. Always keep your SDK and Maker API updated to ensure full compatibility and access to the latest features.
To check the current Maker API version and updates, refer to the Maker API changelog or your API documentation.

​
API Endpoint Groups

The Maker API provides the following endpoint groups:
Endpoint GroupBase PathDescription
Market/api/v1/market/Asset listings, trading pairs, quote requests, fee estimates
Swaps (Atomic)/api/v1/swaps/HTLC-based atomic swap initialization, execution, and status tracking
Swap Orders/api/v1/swap-orders/Order-based swap management for web and light clients
LSPS1/api/v1/lsps1/Channel ordering, liquidity provisioning, and Lightning channel setup

​
Using the Maker API

To use Maker API features with the SDK: 
import { KaleidoClient } from 'kaleido-sdk';

const client = KaleidoClient.create({
  baseUrl: 'https://api.regtest.kaleidoswap.com',
});

// Access Maker API through client.maker
const assets = await client.maker.listAssets();
const pairs = await client.maker.listPairs();
const quote = await client.maker.getQuote({ asset_id: '...', network: 'BTC' });