đŸ–ŧī¸Get a User's Items

Get a user's items

Returns an array of items

GET https://api.alturanft.com/api/v2/user/items/:address

You can add additional query parameters to filter documents by any property. i.e. ?name=Majd

Path Parameters

Query Parameters

{
  "items": [
    {
      "collectionAddress": "0xdb0047cb1dfc44696f6e9868ef6bb40000280b05",
      "tokenId": 10,
      "name": "Altura Penguins #10 - Istanbul",
      "properties": [
        {
          "_id": "6135582d8cadffa18b81424c",
          "name": "Location",
          "value": "Istanbul, Turkey",
          "static": true
        }
      ],
      "imageUrl": "https://altura-marketplace-1.s3.us-east-2.amazonaws.com/56-0xdb0047cb1dfc44696f6e9868ef6bb40000280b05-10_4c4fe564-c3cd-4251-b1af-2080f4601b2d.gif",
      "description": "Altura Penguins are the first set of Smart NFTs to roam the blockchain. Each Penguin is located in a different city across the globe. The background of the NFT will dynamically change to fit the time of day in the Penguin's location. There are 20 unique Penguins with a supply of 100 each.",
      "imageIndex": 2
    }
  ],
  "count": 1
}
Example: get a user's items for a particular collection

/api/v2/user/items/0xcaf45074fc329692995d812aeb099070c7fdee2b?collectionAddress=0xdb0047cb1dfc44696f6e9868ef6bb40000280b05&slim=true&page=1

Response

{
  "items": [
    {
      "name": "Altura Penguins #10 - Istanbul",
      "properties": [
        {
          "_id": "6135582d8cadffa18b81424c",
          "name": "Location",
          "value": "Istanbul, Turkey",
          "static": true
        }
      ],
      "tokenId": 10,
      "collectionAddress": "0xdb0047cb1dfc44696f6e9868ef6bb40000280b05",
      "supply": 100,
      "maxSupply": 100,
      "image": "https://ipfs.io/ipfs/QmSySyaASFux5ACyobHQKoDGkmSu5MLBd2opvyfyuVETt1",
      "imageUrl": "https://altura-marketplace-1.s3.us-east-2.amazonaws.com/56-0xdb0047cb1dfc44696f6e9868ef6bb40000280b05-10_4c4fe564-c3cd-4251-b1af-2080f4601b2d.gif",
      "imageIndex": 2,
      "imageCount": 4,
      "userBalance": 1
    }
  ],
  "count": 1
}

The user's balance for each item is returned as userBalance.

If includeListed=true, userBalance will be the sum of the user's balance and their listings of that item

Last updated