LogoLogo
Landing PageMarketplaceDeveloper PortalDeveloper Discord
  • 👋Welcome to Altura
  • Getting started
    • 🚀Altura NFTs
    • 🛍️The Altura Marketplace
    • 🪅Minting & Importing NFTs
    • 👔Users & Authentication
    • 🔑Altura Guard
  • 💻Developer Portal
    • 🧰The Developer Wallet
  • 🌐REST API
    • 🎴Get Your API Key
    • 🔧Methods
      • 🛡️Authenticate User
      • 👤Get User
      • 👥Get Users
      • 🖼️Get a User's Items
      • 🖼️Get Item
      • 🌈Get Items
      • 👾Get an Item's Holders
      • 📜Get an Item's History
      • 💠Transfer ERC1155
      • 💠Transfer ERC721
      • 💠Bulk Transfer ERC1155
      • 🔮Update an Item's Properties
      • ✍️Update an Item's data
      • 🧬Bulk Update an Item's Properties
      • 🪄Update an Item's Image
      • 📸Add a New Image
      • 🪟Mint Additional Supply
      • 📁Get Collection
      • 🗂️Get Collections
      • 🪄Update Collection
      • 🪙Transfer ERC20
      • ☑️Verify item Ownership
      • 🪙Check User's ERC20 Balance
      • 💰Check User's Balance
  • 🔆JavaScript SDK
    • 🛠️Installation
    • 🔧Methods
      • 🛡️Authenticate User
      • 👤Get User
      • 👥Get Users
      • 🖼️Get User's Items
      • 🖼️Get Item
      • 🌈Get Items
      • 👾Get an Item's Holders
      • 📜Get an Item's History
      • 💠Transfer ERC1155
      • 💠Transfer ERC721
      • 💠Bulk Transfer ERC1155
      • 🪟Mint Additional Supply
      • 🔮Update Property
      • 🪄Update Primary Image
      • 🆕Add a New Image
      • 📁Get Collection
      • 🗂️Get Collections
      • 🪄Update Collection
      • 🪙Transfer ERC20
    • 🎛️Schemas
    • ⌨️Connector API
  • 🕹️Unity SDK
    • 🛠️Installation
    • 🔧Methods
      • 🛡️Authenticate User
      • 👤Get User
      • 👥Get Users
      • 🖼️Get User's Items
      • 🖼️Get Item
      • 🌈Get Items
      • 👾Get an Item Holders
      • 📜Get an Item's History
      • 💠Transfer ERC1155
      • 💠Transfer ERC721
      • 💠Bulk Transfer ERC1155
      • 🪟Mint Additional Supply
      • 🔮Update Property
      • 🪄Update Primary Image
      • 📁Get Collection
      • 🗂️Get Collections
      • 🪄Update Collection
      • 🪙Transfer ERC20
    • 🎛️Schema
  • More
    • 🏷️White Label Marketplaces
    • 🛒List Your Game on the Altura Marketplace
    • ☑️Get Your Collection Verified
    • 🎁Create a Loot Box
  • 🎮Unreal SDK (ALPHA)
    • 🛠️Installation (Alpha)
    • 🛡️Authenticate User
    • 👤Get User
    • 👥Get Users
    • 🖼️Get Item
    • 🌈Get Items
    • 👾Get an Item's Holders
    • 📜Get an Item's History
    • 📁Get Collection
    • 📂Get Collections
    • 🪙Get User ERC20 balance
Powered by GitBook
On this page
  • Usage in your script
  • Parameters

Was this helpful?

  1. JavaScript SDK
  2. Methods

Get 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 User's Items

Last updated 2 years ago

Was this helpful?

🔆
🔧
👥