Skip to main content

VenuesAPI

Access via client.venues.

list

List available venues with optional filters.
async list(query?: VenueQuery): Promise<VenueListResponse>
interface VenueQuery {
  /** Filter by blockchain */
  blockchain?: 'solana' | 'polygon' | 'ethereum';
  /** Filter by token symbol (e.g., 'USDC') */
  token?: string;
}

interface VenueListResponse {
  venues: Venue[];
  count: number;
  strategyCount: number;
}

get

Get a specific venue by ID.
async get(id: number): Promise<Venue>

Venue Type

interface Venue {
  id: number;
  name: string;
  protocol: string;
  blockchain: 'solana' | 'polygon' | 'ethereum';
  iconUrl?: string;
  status: 'active' | 'paused' | 'deprecated';
  strategies: Strategy[];
}

interface Strategy {
  strategyId: number;
  name: string;
  token: string;
  tokenAddress: string;
  apy: number;
  tvl?: string;
  minDeposit?: string;
  maxDeposit?: string;
  status: 'active' | 'paused';
}