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

Name	Type	Description
address*	String	The user's address

Query Parameters

Name	Type	Description
perPage	Integer	The number of items to return (default: 24)
page	Integer	The offset for returned items. Calculated as (page - 1) * perPage (default: 1)
sortBy	String	The field to sort the items by (any field in the item model may be used) (default: mintDate)
sortDir	String	Choose to sort in ascending (asc) or descending (desc) order (default: desc)
includeListed	Boolean	If the user's listed NFTs should be included (listed NFTs are still owned by the user, however on the blockchain they are held by a marketplace smart contract) (default: true)
slim	Boolean	Returns a more condensed version of the items. Limits the item fields to: name, properties, tokenId, collectionAddress, supply, maxSupply, image, imageUrl, imageIndex, and imageCount (default: false)

200: OK

{
  "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
}

500: Internal Server Error

{
    // Response
}

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