Skip to main content
GET
Get a wallet earn summary

Path Parameters

userPubkey
string
required

User wallet address

Example:

"VEG1EMtttdHunMbSza8uoms1R18VXmYSph2bBpHcSJd"

Query Parameters

programId
string
default:KLend2g3cP87fffoy8q1mQqGKjrxjC8boSyAYavgmjD

KLend program ID

Example:

"KLend2g3cP87fffoy8q1mQqGKjrxjC8boSyAYavgmjD"

obligationTypes
default:["Vanilla","Lending","LendingFixedRate","Multiply","MultiplyFixedRate","Leverage","LeverageFixedRate"]

Obligation types to include. Defaults to all seven types for compatibility. Earn products are Vanilla, Lending, and LendingFixedRate. Allowed values: Vanilla, Lending, LendingFixedRate, Multiply, MultiplyFixedRate, Leverage, LeverageFixedRate.

Example:

"Vanilla,Lending,LendingFixedRate"

includePrivateCredit
enum<string>
default:false

Include private-credit vault positions, earnings, and activity alongside Earn vaults. Also accepts other truthy/falsy strings such as "1"/"0", "yes"/"no", "on"/"off".

Available options:
true,
false

Response

OK

totalUsd
string
required

Known earning and idle USD value across all tokens

Example:

"1234.56789"

earningUsd
string
required

Known USD value in earning positions

Example:

"1234.56789"

idleUsd
string
required

Known USD value held idle

Example:

"1234.56789"

blendedApy
string | null
required

USD-weighted APY across all earning positions

Example:

"0.123"

earnedToDateUsd
string
required

Lifetime vault and lending interest earned in USD for the requested obligation types

Example:

"1234.56789"

interestEarnedPerSecondUsd
string
required

Current estimated interest earned per second in USD

Example:

"1234.56789"

tokens
object[]
required