API Documentation
Address
Airdrops
Events
Farming
DEFI Actions
Get DeFi positions for specified addresses
Retrieves holding and positions data for multiple addresses on specified chain
curl --request GET \
--url https://api.getnimbus.io/v1/portfolios
[
{
"address": "<string>",
"chain": "<string>",
"holding": [
{
"owner": "0x7383b5e076553f79822374baca843c8fac02d510fb0f4ab344fc7ab591be94a7",
"name": "suirwd.io - Sui Reward Token",
"symbol": "SUIRWD.IO",
"logo": "https://suicamp.b-cdn.net/suireward/suirwd_icon.png",
"amount": "9683.2",
"amountRaw": "9683200000000",
"balance": "9683.2",
"contractAddress": "0xca2c295de7931476539e5fc68e96c289f84bb0967d579b13e1fbf84412c87eb4::SuiReward::SUIREWARD",
"contractDecimals": 9,
"rate": 0,
"price": {
"price": 0,
"symbol": "SUIRWD.IO",
"decimal": 9,
"source": "C"
},
"last_24h_price": "2023-11-07T05:31:56Z",
"avgCost": 0,
"last_transferred_at": "2023-11-07T05:31:56Z",
"positionId": "SUI-0xca2c295de7931476539e5fc68e96c289f84bb0967d579b13e1fbf84412c87eb4::SuiReward::SUIREWARD",
"category": "Other",
"sector": "Other",
"rank": "No rank yet",
"positionType": "token",
"chain": "SUI",
"is_spam": true
}
],
"positions": [
{
"positionId": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
"owner": "0x7383b5e076553f79822374baca843c8fac02d510fb0f4ab344fc7ab591be94a7",
"input": [
{
"amount": 230.1003476015875,
"value": 89.34665515948616,
"token": {
"contract_address": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
"timestamp": 1732681440,
"price": 0.38829430763915,
"last24hPrice": 0.2,
"poolId": "lending:0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI",
"decimals": 9,
"name": "Scallop",
"symbol": "SCA",
"source": "Nimbus",
"logo": "https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
}
}
],
"yieldCollected": [
{
"amount": 230.1003476015875,
"value": 89.34665515948616,
"token": {
"contract_address": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
"timestamp": 1732681440,
"price": 0.38829430763915,
"last24hPrice": 0.2,
"poolId": "lending:0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI",
"decimals": 9,
"name": "Scallop",
"symbol": "SCA",
"source": "Nimbus",
"logo": "https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
}
}
],
"current": {
"tokens": [
{
"amount": 230.1003476015875,
"value": 89.34665515948616,
"token": {
"contract_address": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
"timestamp": 1732681440,
"price": 0.38829430763915,
"last24hPrice": 0.2,
"poolId": "lending:0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI",
"decimals": 9,
"name": "Scallop",
"symbol": "SCA",
"source": "Nimbus",
"logo": "https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
}
}
],
"yield": [
{
"amount": 230.1003476015875,
"value": 89.34665515948616,
"token": {
"contract_address": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
"timestamp": 1732681440,
"price": 0.38829430763915,
"last24hPrice": 0.2,
"poolId": "lending:0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI",
"decimals": 9,
"name": "Scallop",
"symbol": "SCA",
"source": "Nimbus",
"logo": "https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
}
}
]
},
"fee": 0,
"chain": "SUI",
"type": "Staking",
"farming": [
{
"base_apr": 10,
"rewards_apr": 20,
"total_apr": 30,
"total_apy": 40,
"rewards": [
{
"token_address": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
"logo": "https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI",
"token_name": "Scallop",
"token_symbol": "SCA",
"token_decimals": 9
}
]
}
],
"meta": {
"protocol": {
"name": "Scallop",
"logo": "https://strapi-dev.scand.app/uploads/Scallop_e86ded6cf4.jpg",
"url": "https://scallop.io/",
"protocol": "Scallop"
}
}
}
]
}
]
Query Parameters
Comma-separated list of addresses (max 50)
Chain identifier (currently only supports ECLIPSE)
Response
The wallet address
Chain identifier
List of holdings filtered by whitelisted contract addresses
The owner's address
"0x7383b5e076553f79822374baca843c8fac02d510fb0f4ab344fc7ab591be94a7"
Token name
"suirwd.io - Sui Reward Token"
Token symbol
"SUIRWD.IO"
URL to token logo
"https://suicamp.b-cdn.net/suireward/suirwd_icon.png"
Formatted token amount
"9683.2"
Raw token amount
"9683200000000"
Token balance
"9683.2"
Token contract address
"0xca2c295de7931476539e5fc68e96c289f84bb0967d579b13e1fbf84412c87eb4::SuiReward::SUIREWARD"
Token decimals
9
Token rate
0
Price change in last 24 hours
Average cost of token
0
Timestamp of last transfer
Unique position identifier
"SUI-0xca2c295de7931476539e5fc68e96c289f84bb0967d579b13e1fbf84412c87eb4::SuiReward::SUIREWARD"
Token category
"Other"
Token sector
"Other"
Token rank
"No rank yet"
Type of position
"token"
Blockchain network
"SUI"
Whether token is marked as spam
true
List of Eclipse user positions
"0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA"
"0x7383b5e076553f79822374baca843c8fac02d510fb0f4ab344fc7ab591be94a7"
230.1003476015875
89.34665515948616
"0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA"
9
"Scallop"
"SCA"
"https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
1732681440
0.38829430763915
0.2
"lending:0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI"
"Nimbus"
230.1003476015875
89.34665515948616
"0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA"
9
"Scallop"
"SCA"
"https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
1732681440
0.38829430763915
0.2
"lending:0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI"
"Nimbus"
230.1003476015875
89.34665515948616
"0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA"
9
"Scallop"
"SCA"
"https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
1732681440
0.38829430763915
0.2
"lending:0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI"
"Nimbus"
230.1003476015875
89.34665515948616
"0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA"
9
"Scallop"
"SCA"
"https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
1732681440
0.38829430763915
0.2
"lending:0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI"
"Nimbus"
0
"SUI"
Staking
"Staking"
10
20
30
40
"0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA"
"https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
"Scallop"
"SCA"
9
curl --request GET \
--url https://api.getnimbus.io/v1/portfolios
[
{
"address": "<string>",
"chain": "<string>",
"holding": [
{
"owner": "0x7383b5e076553f79822374baca843c8fac02d510fb0f4ab344fc7ab591be94a7",
"name": "suirwd.io - Sui Reward Token",
"symbol": "SUIRWD.IO",
"logo": "https://suicamp.b-cdn.net/suireward/suirwd_icon.png",
"amount": "9683.2",
"amountRaw": "9683200000000",
"balance": "9683.2",
"contractAddress": "0xca2c295de7931476539e5fc68e96c289f84bb0967d579b13e1fbf84412c87eb4::SuiReward::SUIREWARD",
"contractDecimals": 9,
"rate": 0,
"price": {
"price": 0,
"symbol": "SUIRWD.IO",
"decimal": 9,
"source": "C"
},
"last_24h_price": "2023-11-07T05:31:56Z",
"avgCost": 0,
"last_transferred_at": "2023-11-07T05:31:56Z",
"positionId": "SUI-0xca2c295de7931476539e5fc68e96c289f84bb0967d579b13e1fbf84412c87eb4::SuiReward::SUIREWARD",
"category": "Other",
"sector": "Other",
"rank": "No rank yet",
"positionType": "token",
"chain": "SUI",
"is_spam": true
}
],
"positions": [
{
"positionId": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
"owner": "0x7383b5e076553f79822374baca843c8fac02d510fb0f4ab344fc7ab591be94a7",
"input": [
{
"amount": 230.1003476015875,
"value": 89.34665515948616,
"token": {
"contract_address": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
"timestamp": 1732681440,
"price": 0.38829430763915,
"last24hPrice": 0.2,
"poolId": "lending:0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI",
"decimals": 9,
"name": "Scallop",
"symbol": "SCA",
"source": "Nimbus",
"logo": "https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
}
}
],
"yieldCollected": [
{
"amount": 230.1003476015875,
"value": 89.34665515948616,
"token": {
"contract_address": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
"timestamp": 1732681440,
"price": 0.38829430763915,
"last24hPrice": 0.2,
"poolId": "lending:0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI",
"decimals": 9,
"name": "Scallop",
"symbol": "SCA",
"source": "Nimbus",
"logo": "https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
}
}
],
"current": {
"tokens": [
{
"amount": 230.1003476015875,
"value": 89.34665515948616,
"token": {
"contract_address": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
"timestamp": 1732681440,
"price": 0.38829430763915,
"last24hPrice": 0.2,
"poolId": "lending:0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI",
"decimals": 9,
"name": "Scallop",
"symbol": "SCA",
"source": "Nimbus",
"logo": "https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
}
}
],
"yield": [
{
"amount": 230.1003476015875,
"value": 89.34665515948616,
"token": {
"contract_address": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
"timestamp": 1732681440,
"price": 0.38829430763915,
"last24hPrice": 0.2,
"poolId": "lending:0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI",
"decimals": 9,
"name": "Scallop",
"symbol": "SCA",
"source": "Nimbus",
"logo": "https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI"
}
}
]
},
"fee": 0,
"chain": "SUI",
"type": "Staking",
"farming": [
{
"base_apr": 10,
"rewards_apr": 20,
"total_apr": 30,
"total_apy": 40,
"rewards": [
{
"token_address": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
"logo": "https://token-logo.service.getnimbus.io/api/v1/logo?address=0x7016...&chain=SUI",
"token_name": "Scallop",
"token_symbol": "SCA",
"token_decimals": 9
}
]
}
],
"meta": {
"protocol": {
"name": "Scallop",
"logo": "https://strapi-dev.scand.app/uploads/Scallop_e86ded6cf4.jpg",
"url": "https://scallop.io/",
"protocol": "Scallop"
}
}
}
]
}
]