Skip to main content
POST
/
api
/
v1
/
developer
/
wallet
/
pnl
Get Pnl
curl --request POST \
  --url https://api.allium.so/api/v1/developer/wallet/pnl \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
[
  {
    "chain": "ethereum",
    "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
  },
  {
    "chain": "solana",
    "address": "vines1vzrYbzLMRdu58ou5XTby4qAqVRLmqo36NKPTg"
  }
]
'
{
  "data": {
    "chain": "<string>",
    "address": "<string>",
    "tokens": [
      {
        "token_address": "<string>",
        "average_cost": {
          "amount": "<string>",
          "currency": "USD"
        },
        "raw_balance": "<string>",
        "current_price": {
          "amount": "<string>",
          "currency": "USD"
        },
        "current_balance": {
          "amount": "<string>",
          "currency": "USD"
        },
        "realized_pnl": {
          "amount": "<string>",
          "currency": "USD"
        },
        "unrealized_pnl": {
          "amount": "<string>",
          "currency": "USD"
        },
        "unrealized_pnl_ratio_change": 123,
        "attributes": {
          "total_liquidity_usd": {
            "amount": 123,
            "details": "<string>"
          },
          "price_diff_1d": 123,
          "price_diff_pct_1d": 123,
          "price_diff_1h": 123,
          "price_diff_pct_1h": 123,
          "total_supply": 123,
          "fully_diluted_valuation_usd": 123,
          "volume_1h": 123,
          "volume_1d": 123,
          "volume_usd_1h": 123,
          "volume_usd_1d": 123,
          "volume_24h": 123,
          "volume_usd_24h": 123,
          "trade_count_1h": 123,
          "trade_count_1d": 123,
          "all_time_high": 123,
          "all_time_low": 123,
          "image_url": "<string>",
          "token_creation_time": "2023-11-07T05:31:56Z",
          "holders_count": 123,
          "stellar_fields": {}
        },
        "historical_breakdown": [
          {
            "trade": {
              "token_address": "<string>",
              "token_amount": "<string>",
              "token_price_usd": "<string>",
              "timestamp": "2023-11-07T05:31:56Z"
            },
            "average_cost": {
              "amount": "<string>",
              "currency": "USD"
            },
            "realized_pnl": {
              "amount": "<string>",
              "currency": "USD"
            }
          }
        ]
      }
    ],
    "total_balance": {
      "amount": "<string>",
      "currency": "USD"
    },
    "total_realized_pnl": {
      "amount": "<string>",
      "currency": "USD"
    },
    "total_unrealized_pnl": {
      "amount": "<string>",
      "currency": "USD"
    },
    "total_unrealized_pnl_ratio_change": 123
  },
  "items": [
    {
      "chain": "<string>",
      "address": "<string>",
      "tokens": [
        {
          "token_address": "<string>",
          "average_cost": {
            "amount": "<string>",
            "currency": "USD"
          },
          "raw_balance": "<string>",
          "current_price": {
            "amount": "<string>",
            "currency": "USD"
          },
          "current_balance": {
            "amount": "<string>",
            "currency": "USD"
          },
          "realized_pnl": {
            "amount": "<string>",
            "currency": "USD"
          },
          "unrealized_pnl": {
            "amount": "<string>",
            "currency": "USD"
          },
          "unrealized_pnl_ratio_change": 123,
          "attributes": {
            "total_liquidity_usd": {
              "amount": 123,
              "details": "<string>"
            },
            "price_diff_1d": 123,
            "price_diff_pct_1d": 123,
            "price_diff_1h": 123,
            "price_diff_pct_1h": 123,
            "total_supply": 123,
            "fully_diluted_valuation_usd": 123,
            "volume_1h": 123,
            "volume_1d": 123,
            "volume_usd_1h": 123,
            "volume_usd_1d": 123,
            "volume_24h": 123,
            "volume_usd_24h": 123,
            "trade_count_1h": 123,
            "trade_count_1d": 123,
            "all_time_high": 123,
            "all_time_low": 123,
            "image_url": "<string>",
            "token_creation_time": "2023-11-07T05:31:56Z",
            "holders_count": 123,
            "stellar_fields": {}
          },
          "historical_breakdown": [
            {
              "trade": {
                "token_address": "<string>",
                "token_amount": "<string>",
                "token_price_usd": "<string>",
                "timestamp": "2023-11-07T05:31:56Z"
              },
              "average_cost": {
                "amount": "<string>",
                "currency": "USD"
              },
              "realized_pnl": {
                "amount": "<string>",
                "currency": "USD"
              }
            }
          ]
        }
      ],
      "total_balance": {
        "amount": "<string>",
        "currency": "USD"
      },
      "total_realized_pnl": {
        "amount": "<string>",
        "currency": "USD"
      },
      "total_unrealized_pnl": {
        "amount": "<string>",
        "currency": "USD"
      },
      "total_unrealized_pnl_ratio_change": 123
    }
  ],
  "error": "<string>",
  "cursor": "<string>"
}
This endpoint provides current PnL metrics for wallet addresses, including unrealized PnL, realized PnL, average cost, current balance, and current USD balance.

​
Supported Chains

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
min_liquidity
number

Minimum liquidity of which tokens must have to be included in the response.

Body

application/json
Required array length: 1 - 20 elements
​
chain
string
required

Lowercase chain name

​
address
string
required

Wallet address

Response

Successful Response

​
data
PnlByWallet · object

Single item response data of type T

​
items
(PnlByWallet · object | PnlError · object)[] | null

Response items of type T

​
error
string | null

Error message

​
cursor
string | null

Pagination cursor for next page