🛠️Installation

Using our Unity SDK, you are able to interact with Altura services such as authenticating users using Altura Guard, get Users information and items, get items and collection information and transfer or mint new items.

Getting Started

Requirements

Unity Editor

AlturaSDK versions	Supported Unity versions	Supported Platforms
1.0.5	2020.3, 2021.3, 2022.1	Windows, MacOS, Android

AlturaSDK versions

Supported Unity versions

Supported Platforms

1.0.5

2020.3, 2021.3, 2022.1

Windows, MacOS, Android

Installation

To install Altura Unity SDK, open Unity's Package Manager and click the '+' in the top left corner and select 'Add package from git URL' as shown below:

https://github.com/alturanft/Unity-SDK.git

After you added Altura SDK to Unity, additional packages needs to be installed to do this go to Altura NFT and then click on the 'Install Dependencies' as shown below:

You have successfully installed the Altura SDK, now the last step is to set up your API Key.

Here you can learn about how to get your Altura API key.

Importing

To use Altura SDK in your script, you need to import it like:

using AlturaNFT;

Features

Altura Object

Using Altura object, you are able to allow your users to login easily with Altura Guard, get fast and reliable NFT, User and Collection data also you are able to transfer and mint items!

Method Description

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

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

Using user object, you are able to get all user's items!

Method	Description
GetUserItems()	Use this method to get items of specific user. On success, the data is returned as JSON.

Method

Description

GetUserItems()

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

Item Object

Using item object, you are able to get fully data of an item such as all Holders, and History of the item. You are also able to change properties and the primary image of the item.