Skip to main content
GET
/
api
/
v1
/
lsps1
/
get_info
TypeScript SDK - Get LSP Info
import { KaleidoClient } from '@kaleidoswap/kaleidoswap-sdk';

const client = new KaleidoClient({
  baseUrl: 'https://api.staging.kaleidoswap.com/api/v1'
});

const lspInfo = await client.getLspInfo();
console.log(`LSP Pubkey: ${lspInfo.pubkey}`);
console.log(`Connection URL: ${lspInfo.lsp_connection_url}`);
{
  "lsp_connection_url": "<string>",
  "options": {
    "min_required_channel_confirmations": 0,
    "min_funding_confirms_within_blocks": 0,
    "min_onchain_payment_confirmations": 1,
    "supports_zero_channel_reserve": true,
    "min_onchain_payment_size_sat": 1,
    "max_channel_expiry_blocks": 20160,
    "min_initial_client_balance_sat": 0,
    "max_initial_client_balance_sat": 1000000,
    "min_initial_lsp_balance_sat": 0,
    "max_initial_lsp_balance_sat": 16777215,
    "min_channel_balance_sat": 50000,
    "max_channel_balance_sat": 16777215
  },
  "assets": [
    {
      "name": "US Dollar Notes",
      "asset_id": "rgb:$i4cFKwt-2C5LZ3X-l$kOTGN-O6l1AOP-aP9COyn-7IeBkEM",
      "ticker": "USDT",
      "precision": 6,
      "issued_supply": 0,
      "min_initial_client_amount": 0,
      "max_initial_client_amount": 0,
      "min_initial_lsp_amount": 0,
      "max_initial_lsp_amount": 10000,
      "min_channel_amount": 0,
      "max_channel_amount": 10000
    }
  ]
}

Overview

This endpoint provides essential information about the LSP including supported assets, options, and connection details.
This is typically the first endpoint you should call when integrating with the KaleidoSwap API.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

lsp_connection_url
string
required
options
OrderOptions · object
required
assets
AssetsOptions · object[]
required