Portfolio

GET /portfolio-indexor/allBalances

Return all balances on all chains of logged user

Headers

Name	Value
Content-Type	application/json
x-join-key	api_token

Params (Query)

Name	Type	Description
currency	string	target currency

Response

200

{
    "addresses": [
        {
            "address": string
            "chain": string
        }
    ],
    "tokens": {
        "arbitrum-mainnet": [
            {
                "balance": string,
                "contract_address": string,
                "contract_decimals": number,
                "contract_name": string,
                "contract_ticker_symbol": string,
                "is_spam": boolean,
                "quote": number,
                "chainName": string,
                "logo_url": string,
                "quote_24h": number,
                "quote_24h_variation": number,
                "quote_rate": number,
                "quote_rate_24h": number,
                "quote_rate_24h_variation": number,
                "native_token": true,
                "defi": boolean
            }
        ],
        "base-mainnet": [
            {
                "balance": string,
                "contract_address": string,
                "contract_decimals": number,
                "contract_name": string,
                "contract_ticker_symbol": string,
                "is_spam": boolean,
                "quote": number,
                "chainName": string,
                "logo_url": string,
                "quote_24h": number,
                "quote_24h_variation": number,
                "quote_rate": number,
                "quote_rate_24h": number,
                "quote_rate_24h_variation": number,
                "native_token": true,
                "defi": boolean
            }
        ],
        "bsc-mainnet": [
            {
                "balance": string,
                "contract_address": string,
                "contract_decimals": number,
                "contract_name": string,
                "contract_ticker_symbol": string,
                "is_spam": boolean,
                "quote": number,
                "chainName": string,
                "logo_url": string,
                "quote_24h": number,
                "quote_24h_variation": number,
                "quote_rate": number,
                "quote_rate_24h": number,
                "quote_rate_24h_variation": number,
                "native_token": true,
                "defi": boolean
            }
        ],
        "eth-mainnet": [
            {
                "balance": string,
                "contract_address": string,
                "contract_decimals": number,
                "contract_name": string,
                "contract_ticker_symbol": string,
                "is_spam": boolean,
                "quote": number,
                "chainName": string,
                "logo_url": string,
                "quote_24h": number,
                "quote_24h_variation": number,
                "quote_rate": number,
                "quote_rate_24h": number,
                "quote_rate_24h_variation": number,
                "native_token": true,
                "defi": boolean
            }
        ],
        "gnosis-mainnet": [
            {
                "balance": string,
                "contract_address": string,
                "contract_decimals": number,
                "contract_name": string,
                "contract_ticker_symbol": string,
                "is_spam": boolean,
                "quote": number,
                "chainName": string,
                "logo_url": string,
                "quote_24h": number,
                "quote_24h_variation": number,
                "quote_rate": number,
                "quote_rate_24h": number,
                "quote_rate_24h_variation": number,
                "native_token": true,
                "defi": boolean
            }
        ],
        "matic-mainnet": [
            {
                "balance": string,
                "contract_address": string,
                "contract_decimals": number,
                "contract_name": string,
                "contract_ticker_symbol": string,
                "is_spam": boolean,
                "quote": number,
                "chainName": string,
                "logo_url": string,
                "quote_24h": number,
                "quote_24h_variation": number,
                "quote_rate": number,
                "quote_rate_24h": number,
                "quote_rate_24h_variation": number,
                "native_token": true,
                "defi": boolean
            }
        ],
        "optimism-mainnet": [
            {
                "balance": string,
                "contract_address": string,
                "contract_decimals": number,
                "contract_name": string,
                "contract_ticker_symbol": string,
                "is_spam": boolean,
                "quote": number,
                "chainName": string,
                "logo_url": string,
                "quote_24h": number,
                "quote_24h_variation": number,
                "quote_rate": number,
                "quote_rate_24h": number,
                "quote_rate_24h_variation": number,
                "native_token": true,
                "defi": boolean
            }
        ],
        "solana-mainnet": [
            {
                "balance": string,
                "contract_address": string,
                "contract_decimals": number,
                "contract_name": string,
                "contract_ticker_symbol": string,
                "is_spam": boolean,
                "quote": number,
                "chainName": string,
                "logo_url": string,
                "quote_24h": number,
                "quote_24h_variation": number,
                "quote_rate": number,
                "quote_rate_24h": number,
                "quote_rate_24h_variation": number,
                "native_token": true,
                "defi": boolean
            }
        ]
    },
    "kyc": {
        "status": string
    },
    "smartgaz": number,
    "solana_rent": number
}

GET /portfolio-indexor/token/id/:id

Retrieve token prices for generating a price chart.

Headers

Name	Value
Content-Type	application/json
x-join-key	api_token

Params (Query)

Name	Type	Description
currency	string (optional) default: USD	target currency
days	string (optional) default: max	data up to number of days ago; ex: 1, 7, 30; 365, max

Response

200

{
  "prices": [
    [
      number, // Unix date
      number // price
    ],
    [
      1711843200000,
      69702.3087473573
    ]
  ],
  "market_caps": [
    [
      number, // Unix date
      number // market cap
    ],
    [
      1711929600000,
      1401370211582.37
    ]
  ],
  "total_volumes": [
    [
      number, // Unix date
      number // volume
    ],
    [
      1711929600000,
      19723005998.215
    ]
  ]
}

Create a new user

GET /portfolio-indexor/token/address/:network/:address

Retrieve token prices for generating a price chart based on network and address provided

Headers

Name	Value
Content-Type	application/json
x-join-key	api_token

Params (Query)

Name	Type	Description
currency	string (optional) default: USD	target currency
days	string (optional) default: max	data up to number of days ago; ex: 1, 7, 30; 365, max

Response

200

{
  "prices": [
    [
      number, // Unix date
      number // price
    ],
    [
      1711843200000,
      69702.3087473573
    ]
  ],
  "market_caps": [
    [
      number, // Unix date
      number // market cap
    ],
    [
      1711929600000,
      1401370211582.37
    ]
  ],
  "total_volumes": [
    [
      number, // Unix date
      number // volume
    ],
    [
      1711929600000,
      19723005998.215
    ]
  ]
}

400

GET /portfolio-indexor/nft

Get all nft of logged user

Headers

Name	Value
Content-Type	application/json
x-join-key	api_token

Response

200

{
    "arbitrum-mainnet": [
        {
            "tokenId": string,
            "contract": {
                "isSpam": boolean?,
                "spamClassifications": [string]
            },
            "image": {
                "cachedUrl": string,
                "thumbnailUrl": string,
                "pngUrl": string,
                "contentType": string,
                "size": number,
                "originalUrl": string,
            }
        }
    ],
    "base-mainnet": [
        {
            "tokenId": string,
            "contract": {
                "isSpam": boolean?,
                "spamClassifications": [string]
            },
            "image": {
                "cachedUrl": string,
                "thumbnailUrl": string,
                "pngUrl": string,
                "contentType": string,
                "size": number,
                "originalUrl": string,
            }
        }
    ],
    "eth-mainnet": [
        {
            "tokenId": string,
            "contract": {
                "isSpam": boolean?,
                "spamClassifications": [string]
            },
            "image": {
                "cachedUrl": string,
                "thumbnailUrl": string,
                "pngUrl": string,
                "contentType": string,
                "size": number,
                "originalUrl": string,
            }
        }
    ],
    "gnosis-mainnet": [
        {
            "tokenId": string,
            "contract": {
                "isSpam": boolean?,
                "spamClassifications": [string]
            },
            "image": {
                "cachedUrl": string,
                "thumbnailUrl": string,
                "pngUrl": string,
                "contentType": string,
                "size": number,
                "originalUrl": string,
            }
        }
    ],
    "matic-mainnet": [
        {
            "tokenId": string,
            "contract": {
                "isSpam": boolean?,
                "spamClassifications": [string]
            },
            "image": {
                "cachedUrl": string,
                "thumbnailUrl": string,
                "pngUrl": string,
                "contentType": string,
                "size": number,
                "originalUrl": string,
            }
        }
    ],
    "optimism-mainnet": [
        {
            "tokenId": string,
            "contract": {
                "isSpam": boolean?,
                "spamClassifications": [string]
            },
            "image": {
                "cachedUrl": string,
                "thumbnailUrl": string,
                "pngUrl": string,
                "contentType": string,
                "size": number,
                "originalUrl": string,
            }
        }
    ]
}

400