Get aggregated portfolio

Authorizations

X-Client-Secret

string

header

required

Contact Mesh to get client Secret

X-Client-Id

string

header

required

Contact Mesh to get client Id

Query Parameters

UserId

string

required

End user ID to get the aggregated portfolio for.

TimezoneOffset

integer

Offset in second, used to calculate daily return for cryptocurrencies.

Response

200 - application/json

content

object

content.actualPortfolioPerformance

number | null

Actual performance based on the cost basis.

content.cryptocurrenciesValue

number

Total USD value of all cryptocurrencies in the portfolio.

content.cryptocurrencyPositions

object[] | null

List of cryptocurrency positions

content.equitiesValue

number

Total USD portfolio value of all equities (sum(equity price * equity amount)). Does not include cash balance.

content.equityPositions

object[] | null

List of equity positions

content.nftPositions

object[] | null

List of NFT positions

content.nftPositions.addressExplorerLink

string | null

content.nftPositions.amount

number

content.nftPositions.animationUrl

string | null

content.nftPositions.backgroundColor

string | null

content.nftPositions.blockchain

enum<string>

Available options:

ethereum,

polygon,

klaytn

content.nftPositions.contractAddress

string | null

content.nftPositions.contractDescription

string | null

content.nftPositions.contractExternalLink

string | null

content.nftPositions.contractName

string | null

content.nftPositions.contractSchemaName

string | null

content.nftPositions.contractSymbol

string | null

content.nftPositions.contractType

string | null

content.nftPositions.costBasis

number | null

content.nftPositions.creatorAddress

string | null

content.nftPositions.currentOffer

object

content.nftPositions.description

string | null

content.nftPositions.imageOriginalUrl

string | null

content.nftPositions.imageUrl

string | null

content.nftPositions.lastSale

object

content.nftPositions.marketplaceId

string | null

content.nftPositions.marketplacePermalink

string | null

content.nftPositions.marketValue

number | null

Amount of NFTs multiplied by NFT value

content.nftPositions.name

string | null

content.nftPositions.numberOfSales

integer | null

content.nftPositions.paymentTokenSymbol

string | null

content.nftPositions.portfolioPercentage

number | null

What percentage of total portfolio value is taken by this NFT

content.nftPositions.tokenId

string | null

content.nftPositions.twitterUsername

string | null

content.nftsValue

number

Total USD value of all NFTs in the portfolio.

content.portfolioCostBasis

number | null

Amount of money spent to buy all positions of the portfolio.

displayMessage

string | null

User-friendly display message that can be presented to the end user

errorData

any | null

errorType

string | null

Strictly-typed error type that is explaining the reason of an unsuccessful status of the operation. All possible error types are available in the documentation.

message

string | null

A message generated by the API

status

enum<string>

Available options:

ok,

serverFailure,

permissionDenied,

badRequest,

notFound,

conflict,

tooManyRequest,

locked,

unavailableForLegalReasons