LogoLogo
Developer DashboardMarketplaceDeveloper Discord
  • Getting Started
    • 👋Welcome to Altura
    • ➕Creating a Project
    • â›―Blockchains & Gas Fees
    • 🖞ïļMinting and Importing NFTs
      • Minting Individual NFTs
      • Importing Collections
      • Bulk Mint NFTs
      • Lazy Mint (Primary Sales)
    • 🔗Linking Your Collections
    • ðŸ’ģThe Developer Wallet
    • 🧠Smart NFTs
    • 🎁Lootboxes
    • 🔑Getting Your API Key
    • ðŸŽŪIntegrating Altura
    • ðŸ‘ĨAuthenticating Users
      • Altura Guard (Legacy)
      • Altura Guard II
        • Integration
        • REST API Demo
  • Altura Intelligence
    • 🧑‍ðŸĶēNPC Engine
      • ðŸĪĩNPC Engine +
    • 🌎World Engine
    • ðŸ’ģPlay Wallet
    • 💁Concierge
  • Marketplace
    • 🛍ïļThe Altura Marketplace
    • ðŸŽŊListing Your Game on the Altura Marketplace
    • ✅Getting Your Collections Verified
    • ðŸŽĻCreate Your Own White-Label Marketplace
  • 🌐API Reference
    • Get Endpoints
      • Verify a User's Altura Guard Code
      • Get User
      • Get Many Users
      • Get a User's Items
      • Get Item
      • Get Items
      • Get an Item's Holders
      • Get an Item's History
      • Get Collection
      • Get Collections
      • Get a User's Item Balance
      • Get a User's ERC20 Balance
      • Get a User's Native Token Balance
      • Get a User's Domain Names (Space ID)
      • Get a User From Domain Name (Space ID)
    • Developer Wallet Endpoints
      • Transfer ERC1155
      • Bulk Transfer ERC1155
      • Mint New ERC1155 NFT
      • Mint Additional Supply of ERC1155
      • Transfer ERC721
      • Transfer ERC20
      • Consume an Item (ERC1155)
    • Smart NFT Endpoints
      • Update an Item's Property
      • Add New Properties
      • Remove Properties
      • Bulk Update an Item's Properties
      • Switch an Item's Primary Image
      • Add a New Image
      • Update an Item's Name & Description
      • Update a Collection's Metadata
    • Altura Guard II
      • Connect to user wallet
      • Revoke Connection
      • Check Connection
      • Transaction Requests
        • Polling Transaction Response
        • Submitting a signature request
        • Submitting a native transaction request
        • Submitting a contract transaction request
  • ⚙ïļUnity SDK Reference
    • Installation
    • Get Methods
      • Verify a User's Altura Guard Code
      • Get User
      • Get Users
      • Get Item
      • Get Items
      • Get an Item's Holders
      • Get an Item's History
      • Get Collection
      • Get Collections
      • Get a User's Item Balance
      • Get a User's ERC20 Balance
      • Get a User's Native Token Balance
    • Schemas
  • ⚙ïļJS SDK Reference
    • Installation
    • Get Methods
      • Verify a User's Altura Guard Code
      • Get User
      • Get Many Users
      • Get a User's Items
      • Get Item
      • Get Items
      • Get an Item's Holders
      • Get an Item's History
      • Get Collection
      • Get Collections
      • Get a User's Item Balance
      • Get a User's ERC20 Balance
      • Get a User's Native Token Balance
    • Developer Wallet Methods
      • Transfer ERC1155
      • Bulk Transfer ERC1155
      • Mint Additional Supply of ERC1155
      • Transfer ERC721
      • Transfer ERC20
      • Consume an Item (ERC1155)
    • Smart NFT Endpoints
      • Update an Item's Property
      • Add new Properties
      • Remove Properties
      • Bulk Update an Item's Properties
      • Switch an Item's Primary Image
      • Add a New Image
      • Update an Item's Name & Description
      • Update a Collections Metadata
    • Altura Guard II
      • Connect to a user's wallet
      • Revoke Connection
      • Check Connection
      • Transaction Requests
        • Submitting a signature request
        • Submitting a native transaction request
        • Submitting a contract transaction request
    • Connect to Web3 Wallet
    • Schemas
Powered by GitBook
On this page
  • Usage in your script
  • Parameters
  1. JS SDK Reference
  2. Get Methods

Get Items

Use this method to get metadata of multiple Items at the same time.

Usage in your script

const response = await altura.getItems();

// customize options
const response = await altura.getItems({
  perPage: 20,
  page: 1,
  sortBy: 'name',
  sortDir: 'asc',
  slim: true,
});

// filter documents by any properties
const response = await altura.getItems(
  {}, // default options
  {
    collectionAddress: "0x78e99615063da7c12c247e6bc01240da00df77ae"
  } // fetching items with the specified collection address only
)

const items = response.items;
const itemCount = response.count;
const response: { items: IAlturaItem[], count: number } = await altura.getItems();

// customize options
const response: { items: IAlturaItem[], count: number } = await altura.getItems({
  perPage: 20,
  page: 1,
  sortBy: 'name',
  sortDir: 'asc',
  slim: true,
  stateOnly: true
});

// filter documents by any properties
const response: { items: IAlturaItem[], count: number } = await altura.getItems(
  {}, // default options
  {
    collectionAddress: "0x78e99615063da7c12c247e6bc01240da00df77ae"
  } // fetching items with the specified collection address only
)

const items = response.items;
const itemCount = response.count;

Parameters

Parameter
Type
Required
Description

perPage

number

Optional

The number of items to return

page

number

Optional

The offset for returned items. Calculated as (page - 1) * perPage

sortBy

string

Optional

The field to sort the items by (any field in the item schema may be used)

sortDir

'asc' | 'desc'

Optional

Choose to sort in ascending (asc) or descending (desc) order

slim

boolean

Optional

Returns a more condensed version of the items. Limits the item schema to: name, properties, tokenId, collectionAddress, supply, maxSupply, image, imageUrl, imageIndex, and imageCount

PreviousGet ItemNextGet an Item's Holders

Last updated 2 years ago

⚙ïļ