Skip to main content

getDailyEarnings

Get daily earnings for a wallet within a date range (YYYY-MM-DD format).

Signature

getDailyEarnings(walletAddress: string, startDate?: string, endDate?: string): Promise<DailyEarningsResponse>

Parameters

ParameterTypeRequiredDescription
walletAddressstringSmart wallet address
startDatestringStart date (YYYY-MM-DD format)
endDatestringEnd date (YYYY-MM-DD format)

Returns

Daily earnings breakdown

Return Type

// TokenEarnings is a record of token symbols to amounts
type TokenEarnings = Record<string, number>; // e.g., { "USDC": 100.5, "WETH": 0.025 }

interface DailyEarning {
wallet_address?: string;
snapshot_date: string;
current_earnings_by_token: TokenEarnings;
lifetime_earnings_by_token: TokenEarnings;
unrealized_earnings_by_token: TokenEarnings;
total_earnings_by_token: TokenEarnings;
daily_current_delta_by_token: TokenEarnings;
daily_lifetime_delta_by_token: TokenEarnings;
daily_unrealized_delta_by_token: TokenEarnings;
daily_total_delta_by_token: TokenEarnings;
created_at?: string;
}

interface DailyEarningsResponse {
success: boolean;
walletAddress: string;
data: DailyEarning[];
count: number;
filters: {
startDate: string | null;
endDate: string | null;
};
}

Example

const daily = await sdk.getDailyEarnings(
"0x...",
"2024-01-01",
"2024-01-31"
);

daily.data.forEach(d => {
console.log(`Date: ${d.snapshot_date}`);
console.log(` Total USDC: $${d.total_earnings_by_token["USDC"] || 0}`);
console.log(` Total WETH: ${d.total_earnings_by_token["WETH"] || 0} ETH`);
console.log(` Daily USDC Delta: $${d.daily_total_delta_by_token["USDC"] || 0}`);
});