Get Balance by Address

This service returns balance informations for specified address.

Get Balance by Address

GET {{server-url}}/balances/:address

It returns list of Nft balance objects

Path Parameters

Name	Type	Description
address*	String	Represents wallet address

Headers

Name	Type	Description
Authorization*	String	UUID formatted access token
PROJECT-ID*	String	UUID formatted projectId information

200: OK

{
    // Response
}

401: Unauthorized

{
    // Response
}

403: Forbidden

{
    // Response
}

400: Bad Request

{
    // 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

Key	Type	Description
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