GET
/
v2
/
address
/
{address}
/
positions
Get DEFI positions for an address
curl --request GET \
  --url https://api.getnimbus.io/v2/address/{address}/positions \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "positionId": "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
      "owner": "0x7383b5e076553f79822374baca843c8fac02d510fb0f4ab344fc7ab591be94a7",
      "input": [
        {
          "amount": "<any>",
          "value": "<any>",
          "token": "<any>"
        }
      ],
      "yieldCollected": [
        {
          "amount": "<any>",
          "value": "<any>",
          "token": "<any>"
        }
      ],
      "current": {
        "tokens": [
          {
            "amount": "<any>",
            "value": "<any>",
            "token": "<any>"
          }
        ],
        "yield": [
          {
            "amount": "<any>",
            "value": "<any>",
            "token": "<any>"
          }
        ]
      },
      "fee": 0,
      "chain": "SUI",
      "type": "Staking",
      "farming": [
        {
          "base_apr": "<any>",
          "rewards_apr": "<any>",
          "total_apr": "<any>",
          "total_apy": "<any>",
          "rewards": "<any>"
        }
      ],
      "meta": {
        "protocol": {
          "name": "<any>",
          "logo": "<any>",
          "url": "<any>",
          "protocol": "<any>"
        }
      }
    }
  ]
}

Authorizations

x-api-key
string
header
required

API key for authentication. Trial key: trial-0a620a64-975b-4f45-a73f-9d363200c92e

Path Parameters

address
string
required

The address to get positions for

Query Parameters

chain
string

The blockchain to query

protocol
string

List of protocols to query positions separated by commas. You can get supported protocols from api "/v2/defi/protocols"

force_refresh
boolean

Whether to force refresh the positions

Response

Successful response with position information

data
object[]