API Reference

Get wallet NFTs by blockchain and address

gethttps://api.circle.com/v1/w3s/buidl/wallets/{blockchain}/{address}/nfts

  • Reference
  • Playground

Retrieve the NFTs of a wallet by applicable blockchain and address.

Header parameters
X-Request-Id
string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Path parameters
address
string
Required

Filter by given address.

blockchain
string
Required

Filter by given blockchain.

Query parameters
standard
string

Filter by token standard.

name
string

Filter by token name.

tokenAddress
string

Filter by token address.

pageBefore
uuid

A collection ID value used for pagination.

It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageAfter.

pageAfter
uuid

A collection ID value used for pagination.

It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageBefore.

pageSize
integer
1 to 50
Default is 10

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If avoided, the collection will determine the page size itself.

Response
RequestChoose a language
ResponseChoose an example
1{
2  "data": {
3    "nfts": [
4      {
5        "nftTokenId": "2",
6        "metadata": "ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/1",
7        "amount": "6.62607015",
8        "token": {
9          "name": "",
10          "standard": "ERC20",
11          "blockchain": "MATIC-AMOY",
12          "decimals": 0,
13          "isNative": false,
14          "symbol": "",
15          "tokenAddress": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242"
16        },
17        "updateDate": "2023-01-01T12:04:05Z"
18      }
19    ]
20  }
21}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.