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
  • Getting Started
  • Requirements
  • Installation
  • Importing
  • Features

Was this helpful?

  1. JavaScript SDK

Installation

PreviousCheck User's BalanceNextMethods

Last updated 2 years ago

Was this helpful?

Using our JS/TS SDK, you can interact with Altura's services, such as authenticating users using , fetching user and NFT data, and transferring, minting, and updating NFTs.

Getting Started

Requirements

Installation

npm install --save @altura/altura-js
yarn add @altura/altura-js

That's it! You have successfully installed the Altura SDK.

Importing

To use the Altura SDK in your code, you need to import as follows.

const { Altura } = require("@altura/altura-js")

const altura = new Altura(API_KEY); // your API Key

Features

Altura Object

Method
Description

AuthenticateUser()

Use this method to authenticate user with Altura Guard. On success, true is returned.

GetUser()

Use this method to get user information such as Name, Bio, social etc. etc. On success, the data is returned as JSON.

GetUsers()

Use this method to get information of multiple users at same time such as Name, Bio, social etc. etc. On success, the data is returned as JSON.

GetItem()

Use this method to get item metadata. On success, the data is returned as JSON.

GetItems()

Use this method to get metadata of multiple Items at same time. On success, the data is returned as JSON.

GetCollection()

Use this method to get Collection information. On success, the data is returned as JSON.

GetCollections()

Use this method to get information of multiple Collections at same time. On success, the data is returned as JSON.

TransferItem()

Transfers a single NFT from your developer wallet to another user

TransferItems()

Transfers several items of a particular collection from your developer wallet to a user

MintAdditionalSupply()

Mints additional supply of an existent NFT

User Object

Method
Description

GetUserItems()

Use this method to get items of specific user. On success, the data is returned as JSON.

Item Object

Method
Description

GetHolders()

Returns an item's holders and their balances

GetHistory()

Returns the Transaction history of an item

UpdateProperty()

Updates the value of an item's property

UpdatePrimaryImage()

Updates an item's primary image

🔆
🛠️
Altura Guard
Node.js
Learn how to get your API key