Portfolio

These endpoints are related to the current contents of a wallet.

Purchasing

This API is in early alpha for testing by select customers only. Reach out on our Discord for more information.

Authentication

All requests require proper authentication using the method described in the Authentication section. Customers in our alpha program should use their provided API Key for access.

This endpoint does not have a subscription that can be purchased from our website. The wallet based authentication described there does not apply.

General Information

The information provided is as of last confirmed slot when not stale.

Gets all portfolio positions for a specified wallet

Gets all portfolio positions for a specified wallet, including summary with total values and staleness statuses

GET/v1/portfolio/all/{address}

Authorization

bearer

Path parameters

address*string

Wallet address to fetch data for

Query parameters

Response

200

Successful portfolio response with all positions

Body

application/json

wallet*string

Wallet address

positions*all of

Positions

summary*all of

Summary

status*string

Status of the response

Request

JavaScriptCurlPython

const response = await fetch('/v1/portfolio/all/{address}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "wallet": "text",
  "positions": {
    "token": {
      "spot": [
        {
          "asset": [
            {
              "title": "Bitcoin",
              "symbol": "BTC",
              "mint": "text",
              "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
              "underlyings": []
            }
          ],
          "balance": 100,
          "decimals": 6,
          "programId": 1,
          "priceInUSD": 2,
          "priceChange24hPct": -0.1,
          "valueInUSD": 100
        }
      ],
      "yield": [
        {
          "asset": [
            {
              "title": "Bitcoin",
              "symbol": "BTC",
              "mint": "text",
              "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
              "underlyings": []
            }
          ],
          "balance": 100,
          "decimals": 6,
          "programId": 1,
          "priceInUSD": 2,
          "priceChange24hPct": -0.1,
          "valueInUSD": 100,
          "apr": 0.1
        }
      ]
    },
    "domain": [
      {
        "title": "example.sol",
        "accountAddress": "BuwhgpzWdzMjhpFsNB1JgGUEj9gfKhfyRbwoBnAkUGpQ"
      }
    ],
    "dex": {
      "order": [
        {
          "title": "Raydium LP",
          "platform": {
            "title": "Raydium",
            "url": "https://raydium.io"
          },
          "valueInUSD": 1000,
          "assets": [
            {
              "symbol": "BTC",
              "name": "Bitcoin",
              "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png"
            },
            {
              "symbol": "USDT",
              "name": "Tether",
              "logoURI": "https://assets.coingecko.com/coins/images/325/large/Tether-logo.png"
            }
          ],
          "isBid": true,
          "size": 100,
          "offerPriceInUSD": 1.2,
          "marketAddress": "text"
        }
      ],
      "unsettledBalance": [
        {
          "title": "Raydium LP",
          "platform": {
            "title": "Raydium",
            "url": "https://raydium.io"
          },
          "valueInUSD": 1000,
          "assets": [
            {
              "symbol": "BTC",
              "name": "Bitcoin",
              "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
              "balance": 0.1
            },
            {
              "symbol": "USDT",
              "name": "Tether",
              "logoURI": "https://assets.coingecko.com/coins/images/325/large/Tether-logo.png",
              "balance": 100
            }
          ],
          "marketAddress": "text"
        }
      ]
    },
    "liquidity": {
      "amm": [
        {
          "platform": {
            "title": "Raydium",
            "url": "https://raydium.io"
          },
          "valueInUSD": 100,
          "curveType": 0,
          "apr": 0.1,
          "balance": 100,
          "asset": {
            "title": "Bitcoin",
            "symbol": "BTC",
            "mint": "text",
            "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
            "underlyings": []
          }
        }
      ],
      "clmm": [
        {
          "title": "Raydium LP",
          "platform": {
            "title": "Raydium",
            "url": "https://raydium.io"
          },
          "valueInUSD": 1000,
          "poolInfoPda": "text",
          "underlyings": [
            {
              "title": "Bitcoin",
              "symbol": "BTC",
              "mint": "text",
              "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
              "underlyings": [],
              "balance": 0
            }
          ],
          "curveType": 0,
          "apr": 0,
          "isInRange": false,
          "rewardAssets": [
            {
              "title": "Bitcoin",
              "symbol": "BTC",
              "mint": "text",
              "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
              "underlyings": [],
              "balance": 0
            }
          ]
        }
      ]
    },
    "staking": [
      {
        "platform": {
          "title": "Raydium",
          "url": "https://raydium.io"
        },
        "valueInUSD": 100,
        "asset": {
          "title": "Bitcoin",
          "symbol": "BTC",
          "mint": "text",
          "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
          "underlyings": []
        },
        "apr": 0.1,
        "balance": 100,
        "rewardAssets": [
          {
            "title": "Bitcoin",
            "symbol": "BTC",
            "mint": "text",
            "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
            "underlyings": [],
            "balance": 0
          }
        ],
        "pendingRewardInUSD": 1.2
      }
    ],
    "farm": [
      {
        "title": "Raydium LP",
        "platform": {
          "title": "Raydium",
          "url": "https://raydium.io"
        },
        "valueInUSD": 1000,
        "farmAddress": "text",
        "asset": [
          {
            "title": "Bitcoin",
            "symbol": "BTC",
            "mint": "text",
            "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
            "underlyings": []
          }
        ],
        "apr": 0.1,
        "balance": 100,
        "rewardAssets": [
          {
            "title": "Bitcoin",
            "symbol": "BTC",
            "mint": "text",
            "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
            "underlyings": [],
            "balance": 0
          }
        ],
        "pendingRewardInUSD": 1.2
      }
    ],
    "vault": [
      {
        "title": "Raydium LP",
        "platform": {
          "title": "Raydium",
          "url": "https://raydium.io"
        },
        "valueInUSD": 1000,
        "vaultAddress": "text",
        "underlyings": [
          {
            "title": "Bitcoin",
            "symbol": "BTC",
            "mint": "text",
            "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
            "underlyings": [],
            "balance": 0
          }
        ],
        "apr": 0.1,
        "pendingRewardInUSD": 1.2
      }
    ],
    "margin": [
      {
        "title": "Raydium LP",
        "platform": {
          "title": "Raydium",
          "url": "https://raydium.io"
        },
        "valueInUSD": 1000,
        "perpetuals": [
          {
            "title": "SOL-PERP",
            "valueInUSD": 100,
            "logoURI": "https://coin-images.coingecko.com/coins/images/4128/large/solana.png?1718769756",
            "isLong": true,
            "size": 100,
            "notionalValue": 100,
            "avgEntryPrice": 10.5
          }
        ],
        "orders": [
          {
            "title": "SOL-PERP",
            "isBid": true,
            "size": 100,
            "offerPrice": 10.5,
            "logoURI": "https://coin-images.coingecko.com/coins/images/4128/large/solana.png?1718769756"
          }
        ],
        "balances": [
          {
            "asset": [
              {
                "title": "Bitcoin",
                "symbol": "BTC",
                "mint": "text",
                "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
                "underlyings": []
              }
            ],
            "balance": 100,
            "apr": 0.1,
            "valueInUSD": 100
          }
        ]
      }
    ],
    "lending": {
      "tokenPosition": [
        {
          "asset": {
            "symbol": "USDC",
            "name": "USD Coin",
            "logoURI": "https://assets.coingecko.com/coins/images/6319/large/USD_Coin_icon.png"
          },
          "balance": 100,
          "apr": 0.1,
          "valueInUSD": 1.2,
          "platform": {
            "title": "Raydium",
            "url": "https://raydium.io"
          }
        }
      ],
      "leverageFarmPosition": [
        {
          "title": "Raydium LP",
          "platform": {
            "title": "Raydium",
            "url": "https://raydium.io"
          },
          "valueInUSD": 1000,
          "asset": {
            "title": "Bitcoin",
            "symbol": "BTC",
            "mint": "text",
            "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
            "underlyings": []
          },
          "debtInUSD": 100,
          "equityInUSD": 100
        }
      ],
      "nftPosition": [
        {
          "platform": {
            "title": "Raydium",
            "url": "https://raydium.io"
          },
          "valueInUSD": 100,
          "nftName": "NFT Name",
          "collectionName": "Collection Name",
          "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
          "loanAmount": 100,
          "interestAmountInSol": 100,
          "status": "borrowed"
        }
      ]
    },
    "validator": [
      {
        "title": "Solana",
        "valueInUSD": 100,
        "validatorAddress": "StepeLdhJ2znRjHcZdjwMWsC4nTRURNKQY8Nca82LJp",
        "stakeAccountAddress": "3kwR413BhEsTE6vMkze22qKT4txnFZPcsh7RBooFcfTE",
        "authorizedStakerAddress": "stWirqFCf2Uts1JBL1Jsd3r6VBWhgnpdPxCTe1MFjrq",
        "avg24hRewardInUSD": 0.02,
        "balance": 100,
        "status": "inactive",
        "logoURI": "https://s3.amazonaws.com/keybase_processed_uploads/91868aefb0dbe77847d806a85d7b8305_360_360.jpg"
      }
    ],
    "nftmarket": {
      "singleOrder": [
        {
          "title": "Raydium LP",
          "platform": {
            "title": "Raydium",
            "url": "https://raydium.io"
          },
          "valueInUSD": 1000,
          "logoURI": "https://arweave.net/123.jpg",
          "isBid": true,
          "floorPriceInSOL": 10,
          "offerPriceInSOL": 10
        }
      ],
      "poolOrder": [
        {
          "title": "Raydium LP",
          "platform": {
            "title": "Raydium",
            "url": "https://raydium.io"
          },
          "valueInUSD": 1000,
          "logoURI": "https://arweave.net/123.jpg",
          "nftsHeld": 0,
          "mmProfitInSOL": 0,
          "balance": 100,
          "isSharedEscrow": false,
          "floorPriceInSOL": 10,
          "mmProfitInUSD": 100,
          "apy": 10
        }
      ],
      "escrowAccount": [
        {
          "platform": {
            "title": "Raydium",
            "url": "https://raydium.io"
          },
          "valueInUSD": 100,
          "asset": {
            "title": "Bitcoin",
            "symbol": "BTC",
            "mint": "text",
            "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
            "underlyings": []
          },
          "balance": 100
        }
      ]
    },
    "nft": [
      {
        "collectionName": "Collection Name",
        "isCompressed": false,
        "asset": {
          "title": "Bitcoin",
          "symbol": "BTC",
          "mint": "text",
          "logoURI": "https://assets.coingecko.com/coins/images/1/large/bitcoin.png",
          "underlyings": []
        },
        "metadataUrl": "https://arweave.net/123",
        "balance": 1,
        "floorPriceInSOL": 10,
        "valueInUSD": 100
      }
    ]
  },
  "summary": {
    "positions": {
      "token": {
        "spot": {
          "totalValue": 0
        },
        "yield": {
          "totalValue": 0,
          "estimated24hReward": 0
        }
      },
      "domain": {
        "totalValue": 0
      },
      "dex": {
        "order": {
          "totalValue": 0
        },
        "unsettledBalance": {
          "totalValue": 0
        }
      },
      "liquidity": {
        "amm": {
          "totalValue": 0,
          "estimated24hReward": 0
        },
        "clmm": {
          "totalValue": 0,
          "estimated24hReward": 0,
          "totalPendingReward": 0
        }
      },
      "staking": {
        "totalValue": 0,
        "estimated24hReward": 0,
        "totalPendingReward": 0
      },
      "farm": {
        "totalValue": 0,
        "estimated24hReward": 0,
        "totalPendingReward": 0
      },
      "vault": {
        "totalValue": 0,
        "estimated24hReward": 0
      },
      "margin": {
        "totalValue": 0,
        "estimated24hReward": 0
      },
      "lending": {
        "tokenPosition": {
          "totalValue": 0,
          "estimated24hReward": 0
        },
        "leverageFarmPosition": {
          "totalValue": 0
        },
        "nftPosition": {
          "totalValue": 0
        }
      },
      "validator": {
        "totalValue": 0,
        "estimated24hReward": 0
      },
      "nftmarket": {
        "singleOrder": {
          "totalValue": 0
        },
        "poolOrder": {
          "totalValue": 0,
          "estimated24hReward": 0,
          "totalPendingReward": 0
        },
        "escrowAccount": {
          "totalValue": 0
        }
      },
      "nft": {
        "totalValue": 0
      }
    },
    "aggregated": {
      "netWorth": 0,
      "tokenValue": 0,
      "defiValue": 0,
      "nftDefiValue": 0,
      "nftValue": 0,
      "totalPendingReward": 0,
      "estimated24hReward": 0
    },
    "statuses": {
      "farm": {
        "raydium": {
          "error": null,
          "asOf": 0,
          "duration": 0
        }
      },
      "amm": {
        "solana": {
          "error": null,
          "asOf": 0,
          "duration": 0
        }
      },
      "clmm": {
        "raydium": {
          "error": null,
          "asOf": 0,
          "duration": 0
        }
      },
      "staking": {
        "raydium": {
          "error": null,
          "asOf": 0,
          "duration": 0
        }
      }
    },
    "staleJobs": [
      "text"
    ]
  },
  "status": "text"
}

Invalidates the cache for a specified wallet

Invalidates the cache for a specified wallet. Next GET call will still return cached data if available, but everything will be marked as stale regardless of the data age

DELETE/v1/portfolio/all/{address}

Authorization

bearer

Path parameters

address*string

Wallet address to invalidate cache for

Response

200

Request

JavaScriptCurlPython

const response = await fetch('/v1/portfolio/all/{address}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();