API Methods

This section explains how to fetch deposits, unstakes, points, and exchange rates using the Data API.

---

Overview

The SDK provides data-fetching methods under the api namespace. These methods query Lombard's backend APIs.

import { createLombardSDK } from '@lombard.finance/sdk';
import { config } from './lib/lombard';

const sdk = createLombardSDK(config);

---

deposits

Fetch all deposits for an address.

const deposits = await sdk.api.deposits('0x1234...');
// deposits: Deposit[]

Response Type

See Deposit in packages/sdk/src/api-functions/getDepositsByAddress/getDepositsByAddress.ts

interface Deposit {
  isNative: boolean;
  txHash: string;
  eventIndex: number;
  amount: BigNumber;
  tokenAmount?: BigNumber;
  depositAddress?: string;
  fromAddress?: string;
  toAddress?: string;
  toChainId: ChainId | SuiChain | SolanaChain | StarknetChainId;
  fromChainId?: ChainId | SuiChain | SolanaChain | StarknetChainId;
  blockHeight?: number;
  blockTime?: number;
  notarizationStatus: ENotarizationStatus;
  sessionState: ESessionState;
  claimTxHash?: string;
  isClaimed: boolean;
  sanctioned?: boolean;
}

---

unstakes

Fetch all unstakes for an address.

const unstakes = await sdk.api.unstakes('0x1234...');
// unstakes: Unstake[]

// With filters
const filtered = await sdk.api.unstakes('0x1234...', {
  show_redeems: true,   // default: true
  show_unstakes: true,  // default: true
  to_native: false,     // default: false
});

Response Type

See Unstake in packages/sdk/src/api-functions/getUnstakesByAddress/getUnstakesByAddress.ts

interface Unstake {
  isNative: boolean;
  txHash: string;
  fromChainId: ChainId | SuiChain | SolanaChain | StarknetChainId;
  toChainId?: ChainId | SuiChain | SolanaChain | StarknetChainId | 'bitcoin';
  blockHeight: number;
  blockTime: number;
  fromAddress: string;
  toAddress?: string;
  amount: BigNumber;
  payoutTxHash?: string;
  payoutTxIndex?: number;
  payoutTxStatus: PayoutTxStatus;
  sanctioned?: boolean;
  notarizationStatus?: ENotarizationStatus;
  sessionState?: ESessionState;
  claimTxHash?: string;
}

---

points

Fetch Lux points for an address.

// Current season
const points = await sdk.api.points('0x1234...');
// points: { totalPoints, holdingPoints, ... }

// Specific season
const s1 = await sdk.api.points('0x1234...', 1);
const s2 = await sdk.api.points('0x1234...', 2);

---

exchangeRatio

Fetch the current exchange ratios for all supported tokens.

const ratios = await sdk.api.exchangeRatio();

// Access LBTC ratios
const lbtcRatio = ratios.LBTC;
console.log(`LBTC:BTC = ${lbtcRatio.tokenBTCRatio}`);  // How many LBTC per 1 BTC
console.log(`BTC:LBTC = ${lbtcRatio.BTCTokenRatio}`);  // How many BTC per 1 LBTC

---

depositAddress

Get an existing BTC deposit address for a recipient.

import { ChainId } from '@lombard.finance/sdk';

try {
  const btcAddress = await sdk.api.depositAddress(
    '0x1234567890abcdef1234567890abcdef12345678',
    ChainId.ethereum
  );
  // btcAddress: 'bc1q...'
} catch (error) {
  // No existing deposit address found
}

With Options

import { ChainId } from '@lombard.finance/sdk';

const btcAddress = await sdk.api.depositAddress(
  '0x1234...',
  ChainId.ethereum,
  {
    partnerId: 'YOUR_PARTNER_ID',  // optional
    token: 'LBTC',                  // optional
  }
);

---