@biorswap/sdk

The official TypeScript SDK for integrating Biorswap Exchange into your dApp. Access cross-chain swaps, real-time asset data, price history, and transaction management through a simple, typed API.

Installation

npm install @biorswap/sdk

Quick Start

import { SwapClient, AssetsClient } from '@biorswap/sdk';

const swapClient = new SwapClient({ apiKey: 'YOUR_API_KEY' });
const assetsClient = new AssetsClient({ apiKey: 'YOUR_API_KEY' });

// Fetch supported assets
const assets = await assetsClient.getAllAssets();

// Get a swap quote
const quote = await swapClient.getSwapQuote({
  from: 'ETH.ETH',
  to: 'BSC.BNB',
  amount: '1000000000000000000',
});

Clients

AssetsClient

Query assets and price data across all supported chains.

| Method | Description | |---|---| | getAllAssets(start?, limit?, name?) | Paginated list of all supported assets | | getAssets(formattedAssetIds) | Fetch specific assets by ID | | getAsset(assetId, price?) | Fetch a single asset with optional price | | getAssetPriceHistory(assetId, time, timeType?) | Historical price data for an asset |

SwapClient

Execute and manage cross-chain swaps end-to-end.

| Method | Description | |---|---| | getSwapMetadata(params) | Supported chains, tokens, and swappers | | getAssetsBySearchQuery(params) | Search assets by name or symbol | | getBalance(input) | Wallet balance across chains | | getSwapQuote(input) | Get the best single swap route | | getMultipleSwapQuotes(input) | Compare multiple routes | | confirmSwap(input) | Confirm a quote and initiate the swap | | getGasEstimate(input) | Estimate gas for a swap | | getSwapTransaction(input) | Retrieve a swap transaction payload | | checkApproval(input) | Check token approval status | | checkStatus(input) | Poll swap execution status | | getSwapTransactionHistory(addresses) | Full transaction history for addresses | | reportSwapFailure(input) | Report a failed swap | | getAffiliateDashboard(address) | Affiliate stats for an address | | createAffiliateLink(input) | Generate an affiliate referral link |

Supported Chains

Biorswap supports swaps across EVM chains (Ethereum, BNB Chain, Polygon, Avalanche, and more), Solana, Cosmos-based chains, Starknet, and Terra. See the full list in the docs.

Documentation & Examples

• Integration Guide
• Examples
  • MetaMask (EVM)
  • Phantom (Solana)
  • Keplr (Cosmos)
  • Terra

Development

# Build
npm run build

# Test
npm run test

License

GPL-3.0 © Biorswap