Get Balance by Nft Item

This service returns balance informations for specified Nft item.

Get Balance by Nft Item

GET {{server-url}}/balances/nft-items/:nftItemId

It returns Nft balance object

Path Parameters

NameTypeDescription

nftItemId*

Number

Represents Nft item's identifier

Headers

NameTypeDescription

Authorization*

String

UUID formatted access token

PROJECT-ID*

String

UUID formatted projectId information

{
    // Response
}

Example Response Body

{
    "data": [
        {
            "projectId": "b2e5ab50-f3d5-43ed-8761-eeba5913a72c",
            "nftItem": {
                "id": 176,
                "name": "r/place - 1",
                "description": "Reddit r/place 2022 Edition - 1",
                "url": "https://stagingnftgift.s3.eu-west-1.amazonaws.com/1649243914981",
                "totalSupply": 1,
                "contractType": "ERC721",
                "attributes": [],
                "categories": []
            },
            "address": "0x",
            "onChainBalance": 13,
            "offChainBalance": 0,
            "totalBalance": 13
        }
    ],
    "message": null,
    "code": 0,
    "error": false
}

Response Fields

KeyTypeDescription

projectId

String

Represents UUID formatted project identifier

nftItem

Object

Represents Nft item informations

address

String

Represents user's wallet address

onChainBalance

Number

Represents user's balance on the blockchain

offChainBalance

Number

Represents user's balance on the project session (off-chain)

totalBalance

Number

Represents sum of onChainBalance and offChainBalance

Last updated