Wallet Balance

This API endpoint allows clients to check if a specific Non-Fungible Token (NFT) is present within a wallet. This can be useful for scenarios like token gating, where access to specific resources or features is controlled based on token ownership.

Endpoint Details

Description
Data

API Name

HTTP Method

GET

URL

/v1/wallet/nft/balance

Headers

Key
Value

Content-Type

application/json

x-api-key

API_KEY

Query Parameters

Parameter
Type
Description

contractId

string, required

Identifier for the contract, formatted as contract_<UUID>

nftTokenId

string, required

Identifier for the NFT.

User can be identified by one of the parameter:

Parameter
Type
Description

walletAddress

string, optional

Address

walletId

string, optional

Wallet ID (wallet_UUID)

email

string, optional

Wallet email

phone

string, optional

Wallet phone, format: "+!2223334444"

Examples

curl -X GET "https://sandbox.api.labs.zelus.io/v1/wallet/nft/balance?contractId=contract_63b848e9-b316-48a3-adfd-065403ab88ae&nftTokenId=1&email=email@example.com" \
     -H "Content-Type: application/json" \
     -H "x-api-key: YOUR_API_KEY"

Last updated