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
  • User Schema
  • Items Schema
  • Collection Schema
  • Event Schema

Was this helpful?

  1. JavaScript SDK

Schemas

User Schema

export type TAlturaUser = {
  address: string;
  name: string;
  bio?: string;
  profilePic?: string;
  socialLink?: string;
  profilePicUrl?: string;
};

Items Schema

export type TAlturaItem = {
  name: string;
  description: string;
  properties: {
    name: string;
    value: string;
    static: boolean;
  }[];
  chainId: number;
  royalty: number;
  creatorAddress: string;
  mintDate: string;
  stackable: boolean;
  supply: number;
  maxSupply: number;
  image: string;
  imageHash: string;
  imageUrl: string;
  fileType: string;
  isVideo: boolean;
  otherImageVisibility: string;
  holders: number;
  listers: number;
  likes: number;
  views: number;
  isListed: boolean;
  mostRecentListing: string;
  cheapestListingPrice: number;
  cheapestListingCurrency: string;
  cheapestListingUSD: number;
  nsfw: boolean;
  isVerified: boolean;
  hasUnlockableContent: boolean;
  imageIndex: number;
  imageCount: number;
  totalListings: number;
};

Collection Schema

export type TAlturaCollection = {
  address: string;
  name: string;
  description?: string;
  genre?: string;
  image?: string;
  imageHash?: string;
  ownerAddress: string;
  slug: string;
  uri: string;
  website?: string;
  holders: number;
  volume_1d?: number;
  volume_1w?: number;
  volume_30d?: number;
  volume_all?: number;
  imageUrl?: string;
  chainId: number;
  mintDate: string;
};

Event Schema

export interface IAlturaEvent {
  id: string;
  amount: string;
  blockNumber: number;
  chainId: number;
  event: string;
  from: string;
  itemCollection: string;
  itemRef: string;
  timestamp: number;
  to: string;
  tokenId: number;
  transactionHash: string;
}
PreviousTransfer ERC20NextConnector API

Last updated 2 years ago

Was this helpful?

🔆
🎛️