Portfolio
Get balances for a specific yield
Retrieve all balances associated with a yield opportunity for a specific wallet address, including active, pending, claimable, and withdrawable balances. The network is automatically determined from the yield configuration.
post/v1/yields/{yieldId}/balances
Request
- Base URL: https://api.yield.xyz
- URL: https://api.yield.xyz/v1/yields/{yieldId}/balances
- Auth: API key in header x-api-key
Path parameters
yieldIdstring required
Example:ethereum-eth-lido-staking
The unique identifier of the yield opportunity
Request body
Example request
{
"address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
"arguments": {
"cAddressBech": "0x123...",
"pAddressBech": "P-avax1...",
"autoSweepDayOfMonth": 20,
"autoSweepTimezone": "Europe/London"
}
}Response
Returns balance information including different balance types (active, entering, exiting, withdrawable, claimable, locked) with amounts and available actions
Example response
{
"yieldId": "ethereum-eth-lido-staking",
"balances": [
{
"address": "0x1234...",
"amount": "2.625",
"amountRaw": "2625000000000000000",
"date": "2025-04-23T08:00:00Z",
"feeConfigurationId": "fee-config-1",
"pendingActions": [
{
"intent": "manage",
"type": "CLAIM_REWARDS",
"passthrough": "eyJhZGRyZXNzZXMiOnsiYWRkcmVzcyI6ImNvc21vczF5ZXk...",
"arguments": {
"fields": [
{
"name": "amount",
"type": "string",
"label": "Amount to Enter",
"required": true,
"options": [
"individual",
"batched"
],
"optionsRef": "/api/v1/validators?integrationId=eth-lido",
"minimum": "1.0",
"maximum": "100.0"
}
]
},
"amount": "0.1"
}
],
"token": {
"symbol": "ETH",
"name": "Ethereum",
"decimals": 18,
"network": "Ethereum",
"address": "0x...",
"logoURI": "https://...",
"isPoints": true,
"coinGeckoId": "ethereum"
},
"validator": {
"address": "cosmosvaloper1abc...",
"name": "StakeKit Validator",
"logoURI": "https://stakekit.com/logo.png",
"website": "https://stakekit.com",
"rewardRate": {
"total": 6.5,
"rateType": "APR",
"components": [
{
"rate": 0.04,
"rateType": "APR",
"token": {
"symbol": "ETH",
"name": "Ethereum",
"decimals": 18,
"network": "Ethereum",
"address": "0x...",
"logoURI": "https://...",
"isPoints": true,
"coinGeckoId": "ethereum"
},
"yieldSource": "protocol_incentive",
"description": "LDO distributed to incentivize stETH adoption via Lido Boost"
}
]
},
"provider": {
"name": "Morpho",
"id": "morpho",
"logoURI": "https://morpho.xyz/logo.png",
"description": "A peer-to-peer DeFi lending protocol",
"website": "https://morpho.xyz",
"type": "protocol",
"rank": 1,
"preferred": true,
"revshare": {
"trial": {
"minRevShare": 0.3,
"maxRevShare": 0.7
},
"standard": {
"minRevShare": 0.3,
"maxRevShare": 0.7
},
"pro": {
"minRevShare": 0.3,
"maxRevShare": 0.7
}
},
"uniqueId": "luganodes"
},
"commission": 0.05,
"tvlUsd": "18,340,000",
"tvl": "8250.45",
"tvlRaw": "8250450000000000000000",
"votingPower": 0.013,
"preferred": true,
"minimumStake": "1.0",
"remainingPossibleStake": "285,714.28",
"remainingSlots": 8,
"nominatorCount": 321,
"status": "active",
"providerId": "provider-1",
"subnet": {
"id": 1,
"name": "Apex",
"tokenSymbol": "α",
"tvl": "1000000",
"pricePerShare": "1.0"
}
},
"validators": [
{
"address": "cosmosvaloper1abc...",
"name": "StakeKit Validator",
"logoURI": "https://stakekit.com/logo.png",
"website": "https://stakekit.com",
"rewardRate": {
"total": 6.5,
"rateType": "APR",
"components": [
{
"rate": 0.04,
"rateType": "APR",
"token": {
"symbol": "ETH",
"name": "Ethereum",
"decimals": 18,
"network": "Ethereum",
"address": "0x...",
"logoURI": "https://...",
"isPoints": true,
"coinGeckoId": "ethereum"
},
"yieldSource": "protocol_incentive",
"description": "LDO distributed to incentivize stETH adoption via Lido Boost"
}
]
},
"provider": {
"name": "Morpho",
"id": "morpho",
"logoURI": "https://morpho.xyz/logo.png",
"description": "A peer-to-peer DeFi lending protocol",
"website": "https://morpho.xyz",
"type": "protocol",
"rank": 1,
"preferred": true,
"revshare": {
"trial": {
"minRevShare": 0.3,
"maxRevShare": 0.7
},
"standard": {
"minRevShare": 0.3,
"maxRevShare": 0.7
},
"pro": {
"minRevShare": 0.3,
"maxRevShare": 0.7
}
},
"uniqueId": "luganodes"
},
"commission": 0.05,
"tvlUsd": "18,340,000",
"tvl": "8250.45",
"tvlRaw": "8250450000000000000000",
"votingPower": 0.013,
"preferred": true,
"minimumStake": "1.0",
"remainingPossibleStake": "285,714.28",
"remainingSlots": 8,
"nominatorCount": 321,
"status": "active",
"providerId": "provider-1",
"subnet": {
"id": 1,
"name": "Apex",
"tokenSymbol": "α",
"tvl": "1000000",
"pricePerShare": "1.0"
}
}
],
"amountUsd": "2,500.00",
"isEarning": true,
"priceRange": {
"min": "2700",
"max": "3310"
},
"tokenId": "12345",
"shareAmount": "1.5",
"shareAmountRaw": "1500000000000000000",
"shareToken": {
"symbol": "ETH",
"name": "Ethereum",
"decimals": 18,
"network": "Ethereum",
"address": "0x...",
"logoURI": "https://...",
"isPoints": true,
"coinGeckoId": "ethereum"
}
}
],
"outputTokenBalance": {
"address": "0x1234...",
"amount": "2.625",
"amountRaw": "2625000000000000000",
"date": "2025-04-23T08:00:00Z",
"feeConfigurationId": "fee-config-1",
"pendingActions": [
{
"intent": "manage",
"type": "CLAIM_REWARDS",
"passthrough": "eyJhZGRyZXNzZXMiOnsiYWRkcmVzcyI6ImNvc21vczF5ZXk...",
"arguments": {
"fields": [
{
"name": "amount",
"type": "string",
"label": "Amount to Enter",
"required": true,
"options": [
"individual",
"batched"
],
"optionsRef": "/api/v1/validators?integrationId=eth-lido",
"minimum": "1.0",
"maximum": "100.0"
}
]
},
"amount": "0.1"
}
],
"token": {
"symbol": "ETH",
"name": "Ethereum",
"decimals": 18,
"network": "Ethereum",
"address": "0x...",
"logoURI": "https://...",
"isPoints": true,
"coinGeckoId": "ethereum"
},
"validator": {
"address": "cosmosvaloper1abc...",
"name": "StakeKit Validator",
"logoURI": "https://stakekit.com/logo.png",
"website": "https://stakekit.com",
"rewardRate": {
"total": 6.5,
"rateType": "APR",
"components": [
{
"rate": 0.04,
"rateType": "APR",
"token": {
"symbol": "ETH",
"name": "Ethereum",
"decimals": 18,
"network": "Ethereum",
"address": "0x...",
"logoURI": "https://...",
"isPoints": true,
"coinGeckoId": "ethereum"
},
"yieldSource": "protocol_incentive",
"description": "LDO distributed to incentivize stETH adoption via Lido Boost"
}
]
},
"provider": {
"name": "Morpho",
"id": "morpho",
"logoURI": "https://morpho.xyz/logo.png",
"description": "A peer-to-peer DeFi lending protocol",
"website": "https://morpho.xyz",
"type": "protocol",
"rank": 1,
"preferred": true,
"revshare": {
"trial": {
"minRevShare": 0.3,
"maxRevShare": 0.7
},
"standard": {
"minRevShare": 0.3,
"maxRevShare": 0.7
},
"pro": {
"minRevShare": 0.3,
"maxRevShare": 0.7
}
},
"uniqueId": "luganodes"
},
"commission": 0.05,
"tvlUsd": "18,340,000",
"tvl": "8250.45",
"tvlRaw": "8250450000000000000000",
"votingPower": 0.013,
"preferred": true,
"minimumStake": "1.0",
"remainingPossibleStake": "285,714.28",
"remainingSlots": 8,
"nominatorCount": 321,
"status": "active",
"providerId": "provider-1",
"subnet": {
"id": 1,
"name": "Apex",
"tokenSymbol": "α",
"tvl": "1000000",
"pricePerShare": "1.0"
}
},
"validators": [
{
"address": "cosmosvaloper1abc...",
"name": "StakeKit Validator",
"logoURI": "https://stakekit.com/logo.png",
"website": "https://stakekit.com",
"rewardRate": {
"total": 6.5,
"rateType": "APR",
"components": [
{
"rate": 0.04,
"rateType": "APR",
"token": {
"symbol": "ETH",
"name": "Ethereum",
"decimals": 18,
"network": "Ethereum",
"address": "0x...",
"logoURI": "https://...",
"isPoints": true,
"coinGeckoId": "ethereum"
},
"yieldSource": "protocol_incentive",
"description": "LDO distributed to incentivize stETH adoption via Lido Boost"
}
]
},
"provider": {
"name": "Morpho",
"id": "morpho",
"logoURI": "https://morpho.xyz/logo.png",
"description": "A peer-to-peer DeFi lending protocol",
"website": "https://morpho.xyz",
"type": "protocol",
"rank": 1,
"preferred": true,
"revshare": {
"trial": {
"minRevShare": 0.3,
"maxRevShare": 0.7
},
"standard": {
"minRevShare": 0.3,
"maxRevShare": 0.7
},
"pro": {
"minRevShare": 0.3,
"maxRevShare": 0.7
}
},
"uniqueId": "luganodes"
},
"commission": 0.05,
"tvlUsd": "18,340,000",
"tvl": "8250.45",
"tvlRaw": "8250450000000000000000",
"votingPower": 0.013,
"preferred": true,
"minimumStake": "1.0",
"remainingPossibleStake": "285,714.28",
"remainingSlots": 8,
"nominatorCount": 321,
"status": "active",
"providerId": "provider-1",
"subnet": {
"id": 1,
"name": "Apex",
"tokenSymbol": "α",
"tvl": "1000000",
"pricePerShare": "1.0"
}
}
],
"amountUsd": "2,500.00",
"isEarning": true,
"priceRange": {
"min": "2700",
"max": "3310"
},
"tokenId": "12345",
"shareAmount": "1.5",
"shareAmountRaw": "1500000000000000000",
"shareToken": {
"symbol": "ETH",
"name": "Ethereum",
"decimals": 18,
"network": "Ethereum",
"address": "0x...",
"logoURI": "https://...",
"isPoints": true,
"coinGeckoId": "ethereum"
}
},
"rewardRate": {
"total": 6.5,
"rateType": "APR",
"components": [
{
"rate": 0.04,
"rateType": "APR",
"token": {
"symbol": "ETH",
"name": "Ethereum",
"decimals": 18,
"network": "Ethereum",
"address": "0x...",
"logoURI": "https://...",
"isPoints": true,
"coinGeckoId": "ethereum"
},
"yieldSource": "protocol_incentive",
"description": "LDO distributed to incentivize stETH adoption via Lido Boost"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.