Links
🛠

Installation

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

Getting Started

Requirements

Installation

npm
yarn
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