QAF NFT
  • Getting Started
  • 📚TERMS/DOMAINS
    • Network
    • Project
    • Contract
    • Category
    • Nft Item
    • Nft Item Attribute
    • Project Token
    • Marketplace Fees
    • Marketplace Token
    • Marketplace Items
  • ⚙️API REFERENCE
    • Postman Collection
    • Authentication
    • NFT API
      • List Networks
      • Create Project
      • Get Project Detail
      • Filter Projects
      • Deploy Contract
      • Get Contract Detail
      • Filter Contracts
      • Add Category
      • Update Category
      • Delete Category
      • Get Category Detail
      • Filter Categories
      • Create Nft Item
      • Batch Create Nft Item
      • Validate Metadata File
      • Mint Nft Items
      • Update Nft Item Metadata
      • Set Nft Item Category
      • Get Nft Item Detail
      • Filter Nft Items
      • Add Nft Item Attribute
      • Update Nft Item Attribute
      • Delete Nft Item Attribute
      • Get Nft Item Attribute Detail
      • Filter Nft Item Attributes
      • Get Balance by Nft Item and Address
      • Get Balance by Address
      • Get Balance by Nft Item
      • Filter Nft Item Transfers
      • Deploy Project Token
      • Get Project Token Detail
      • Init Project Token Transfer
      • Client Token Transfer
      • Init Project Token Allowance
      • Check Project Token Allowance
      • Filter Project Tokens
      • Get Project Token Balance by Symbol and Address
      • Get Project Token Balance by Address
      • Get Project Token Balance by Symbol
      • Update Marketplace Royalty Fee
      • Filter Marketplace Fees
      • Add Marketplace Token
      • Get Marketplace Token Detail
      • Init Marketplace Token Allowance
      • Check Marketplace Token Allowance
      • Filter Marketplace Tokens
      • Init List Nft Item on Marketplace
      • Init Buy Nft Item from Marketplace
      • Init Cancel Listing from Marketplace
      • Get Marketplace Item Detail
      • Filter Marketplace Items
      • Init Transfer Nft Item
      • Init Transfer Nft Item to Client
      • Transfer Nft Item from Client
      • Init Lock Nft Item
      • Init Nft Approval Permission
      • Check Nft Item Approval Permission
      • Create Project Session
      • Get Project Session Detail
      • Filter Project Sessions
      • Create Off Chain Transaction
      • Get Off Chain Transaction
      • Filter Off Chain Transactions
      • Upload File
    • Error Codes
    • FAQ
      • How can I implement listing Nft Item on marketplace service properly?
      • How can I implement buy Nft Item from marketplace service properly?
Powered by GitBook
On this page
  • Get Balance by Nft Item and Address
  • Example Response Body
  • Response Fields
  1. API REFERENCE
  2. NFT API

Get Balance by Nft Item and Address

This service returns balance informations for specified address and Nft item.

Get Balance by Nft Item and Address

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

It returns Nft balance object

Path Parameters

Name
Type
Description

address*

String

Represents wallet address

nftItemId*

Number

Represents Nft item's identifier

Headers

Name
Type
Description

Authorization*

String

UUID formatted access token

PROJECT-ID*

String

UUID formatted projectId information

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

PreviousFilter Nft Item AttributesNextGet Balance by Address

Last updated 2 years ago

⚙️