LogoLogo
Developer DashboardMarketplaceDeveloper Discord
  • Getting Started
    • 👋Welcome to Altura
    • ➕Creating a Project
    • â›―Blockchains & Gas Fees
    • 🖞ïļMinting and Importing NFTs
      • Minting Individual NFTs
      • Importing Collections
      • Bulk Mint NFTs
      • Lazy Mint (Primary Sales)
    • 🔗Linking Your Collections
    • ðŸ’ģThe Developer Wallet
    • 🧠Smart NFTs
    • 🎁Lootboxes
    • 🔑Getting Your API Key
    • ðŸŽŪIntegrating Altura
    • ðŸ‘ĨAuthenticating Users
      • Altura Guard (Legacy)
      • Altura Guard II
        • Integration
        • REST API Demo
  • Altura Intelligence
    • 🧑‍ðŸĶēNPC Engine
      • ðŸĪĩNPC Engine +
    • 🌎World Engine
    • ðŸ’ģPlay Wallet
    • 💁Concierge
  • Marketplace
    • 🛍ïļThe Altura Marketplace
    • ðŸŽŊListing Your Game on the Altura Marketplace
    • ✅Getting Your Collections Verified
    • ðŸŽĻCreate Your Own White-Label Marketplace
  • 🌐API Reference
    • Get Endpoints
      • Verify a User's Altura Guard Code
      • Get User
      • Get Many Users
      • Get a User's Items
      • Get Item
      • Get Items
      • Get an Item's Holders
      • Get an Item's History
      • Get Collection
      • Get Collections
      • Get a User's Item Balance
      • Get a User's ERC20 Balance
      • Get a User's Native Token Balance
      • Get a User's Domain Names (Space ID)
      • Get a User From Domain Name (Space ID)
    • Developer Wallet Endpoints
      • Transfer ERC1155
      • Bulk Transfer ERC1155
      • Mint New ERC1155 NFT
      • Mint Additional Supply of ERC1155
      • Transfer ERC721
      • Transfer ERC20
      • Consume an Item (ERC1155)
    • Smart NFT Endpoints
      • Update an Item's Property
      • Add New Properties
      • Remove Properties
      • Bulk Update an Item's Properties
      • Switch an Item's Primary Image
      • Add a New Image
      • Update an Item's Name & Description
      • Update a Collection's Metadata
    • Altura Guard II
      • Connect to user wallet
      • Revoke Connection
      • Check Connection
      • Transaction Requests
        • Polling Transaction Response
        • Submitting a signature request
        • Submitting a native transaction request
        • Submitting a contract transaction request
  • ⚙ïļUnity SDK Reference
    • Installation
    • Get Methods
      • Verify a User's Altura Guard Code
      • Get User
      • Get Users
      • Get Item
      • Get Items
      • Get an Item's Holders
      • Get an Item's History
      • Get Collection
      • Get Collections
      • Get a User's Item Balance
      • Get a User's ERC20 Balance
      • Get a User's Native Token Balance
    • Schemas
  • ⚙ïļJS SDK Reference
    • Installation
    • Get Methods
      • Verify a User's Altura Guard Code
      • Get User
      • Get Many Users
      • Get a User's Items
      • Get Item
      • Get Items
      • Get an Item's Holders
      • Get an Item's History
      • Get Collection
      • Get Collections
      • Get a User's Item Balance
      • Get a User's ERC20 Balance
      • Get a User's Native Token Balance
    • Developer Wallet Methods
      • Transfer ERC1155
      • Bulk Transfer ERC1155
      • Mint Additional Supply of ERC1155
      • Transfer ERC721
      • Transfer ERC20
      • Consume an Item (ERC1155)
    • Smart NFT Endpoints
      • Update an Item's Property
      • Add new Properties
      • Remove Properties
      • Bulk Update an Item's Properties
      • Switch an Item's Primary Image
      • Add a New Image
      • Update an Item's Name & Description
      • Update a Collections Metadata
    • Altura Guard II
      • Connect to a user's wallet
      • Revoke Connection
      • Check Connection
      • Transaction Requests
        • Submitting a signature request
        • Submitting a native transaction request
        • Submitting a contract transaction request
    • Connect to Web3 Wallet
    • Schemas
Powered by GitBook
On this page
  • User Schema
  • Items Schema
  • Collection Schema
  • Event Schema
  1. JS SDK Reference

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;
}
PreviousConnect to Web3 Wallet

Last updated 2 years ago

⚙ïļ