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
  • Get multiple users at once
  • Returns an array of users

Was this helpful?

  1. REST API
  2. Methods

Get Users

Get multiple users at once

Returns an array of users

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

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

Query Parameters

Name
Type
Description

page

Integer

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

(default: 1)

perPage

Integer

The number of users to return

(default: 24)

sortBy

String

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

(default: name)

sortDir

String

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

default: desc

{  
  "users": [
    {
      "address": "0xb13fbf9f1433539c2c7a299c0a49611a143a975c",
      "name": "NFT-Louvre",
      "bio": "The finest NFTs in the space.",
      "profilePic": "https://ipfs.io/ipfs/QmfZuvamA14VFxSUEfrwDLeLVzwntugNuJTs5H1hKXW7YG",
      "socialLink": "",
      "profilePicUrl": "https://altura-marketplace-1.s3.us-east-2.amazonaws.com/0xb13fbf9f1433539c2c7a299c0a49611a143a975c_089a054c-70ac-4ef1-a5c2-7ef8701e60f5.png"
    },
    {
      "address": "0xd4c100a4b5de2c845d413c225154bc5992518a82",
      "name": "NoName",
      "bio": "",
      "profilePic": "https://ipfs.io/ipfs/QmfZfA8o1kKSehW3NmDN2CxW4QKk9ddnKG3CKWxhf3WBvc",
      "socialLink": "",
      "profilePicUrl": "https://altura-marketplace-1.s3.us-east-2.amazonaws.com/0xd4c100a4b5de2c845d413c225154bc5992518a82_456b0b8e-a84f-435d-8a32-39b8b753016a.png"
    },
    {
      "address": "0xaf150c106f2d31b6619ab2b39b476dbfe341f1a0",
      "name": "Torrvull",
      "bio": "",
      "profilePic": "https://ipfs.io/ipfs/QmfZJ28STGSYupvhBovTKEoMDFBGKTQ25N9NUX8PBxzk9T",
      "socialLink": "",
      "profilePicUrl": "https://altura-marketplace-1.s3.us-east-2.amazonaws.com/0xaf150c106f2d31b6619ab2b39b476dbfe341f1a0_a1397475-13a7-4c3d-a2b3-cec902561745.png"
    }
  }
{
    // Response
}
Example: get a user by username

/api/v2/user?name=AlturaNFT

Response

{
  "users": [
    {
      "address": "0xcaf45074fc329692995d812aeb099070c7fdee2b",
      "name": "AlturaNFT",
      "bio": "Altura is a smart contract platform that allows game developers to mint, distribute and transact Smart NFTs representing in-game items. Smart NFTs are NFTs with dynamic properties that can change based on certain conditions.",
      "profilePic": "https://ipfs.io/ipfs/QmTGgo2JveLMM9ftuqvDQtpcY8HqwewinFLQ54i4eb8H3Y",
      "socialLink": "https://www.alturanft.com/",
      "profilePicUrl": "https://altura-marketplace-1.s3.us-east-2.amazonaws.com/0xcaf45074fc329692995d812aeb099070c7fdee2b_126b90b1-92c0-417b-b119-b67e4141d30d.png"
    }
  ],
  "count": 1
}
PreviousGet UserNextGet a User's Items

Last updated 2 years ago

Was this helpful?

🌐
🔧
👥