Getting Started

You can use the endpoints in this API documentation or install the SDK via npm.

npm install @overlay.fun/kit npm package

//import package
import OverlayClient from '@overlay.fun/kit';

// initialize
const client = new OverlayClient({
  env: 'devnet',
  api_key: 'your-wallet-api-key',
  auth_key: 'your-wallet-auth-key'
});


// Create wallet
const wallet = await client.wallet.create({
  network: 'solana', // or "bsc" "base" "polygon" "blast" etc
});

// Fetch wallet
const wallet = await client.wallet.get("wallet-address");

// Create token
const token = await client.token.create({
  network: 'solana', // or "bsc" "base" "polygon" "blast" etc
  name: 'My Token',
  symbol: 'MTK',
  description: 'This is test token',
  image: 'image url'
  decimals: 9,
  supply: '1000000',
  website: 'https://example.com'
});

// Fetch token
const token = await client.token.get("mint-address");

// Transfer token
await client.token.transfer(token.mint, {
  network: 'solana"' // or "bsc" "base" "polygon" "blast" etc
  recipient: 'wallet-address',
  amount: '100'
});