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 Many Users

Use this method to get multiple users' metadata simultaneously, such as the name, bio, social link, etc.

Usage in your script

const response = await altura.getUsers();

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

// filter documents by any properties
const response = await altura.getUsers(
  {}, // default options
  {
    name: 'AlturaNFT'
  } //fetching users with name AlturaNFT
)

const users = response.users;
const userCount = response.count;
const response: { users: IAlturaUser[], count: number } = await altura.getUsers();

// customize options
const options = {
  perPage: 20,
  page: 1,
  sortBy: 'name',
  sortDir: 'asc'
}
const response: { users: IAlturaUser[], count: number } = await altura.getUsers(options);

// filter documents by any properties
const response: {users: IAlturaUser[], count: number} = await altura.getUsers(
  {}, // default options
  {
    name: 'AlturaNFT'
  } //fetching users with name AlturaNFT
)

const users = response.users;
const userCount = response.count;

Parameters

Parameter
Type
Required
Description

perPage

String

Yes

Amount of users per page.

page

String

Yes

Amount of pages

sortBy

String

Yes

The field to sort the users by (any field in the user schema may be used)

sortDir

String

Yes

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

PreviousGet UserNextGet a User's Items

Last updated 2 years ago

⚙ïļ