VipeIO SDK v1.0.2

The VipeIO SDK is a library that provides access to the VipeIO platform for interacting with NFTs and digital avatars. This documentation will guide you through installation, configuration, and usage of the SDK.

Installation

To install the VipeIO SDK, you can use npm or yarn:

npm install @vipeio/sdk

or

yarn add @vipeio/sdk

Configuration

Before using the SDK, you need to configure it with your API Key and other relevant options:

import { Vipe } from '@vipeio/sdk';

const vipeSdk = new Vipe({ apiKey: 'YOUR_API_KEY', avatarsPerPage: 24 });

Basic Usage

Get Open Avatars

You can retrieve a list of open avatars using the getOpenSourceAvatars method:

vipeSdk.getOpenSourceAvatars()
  .then((avatars) => {
    console.log('Open avatars:', avatars);
  })
  .catch((error) => {
    console.error('Error fetching open avatars:', error);
  });

Select an Avatar

To allow users to select an avatar, you can open an avatar selector:

vipeSdk.openAvatarSelector((avatar, vrmUrl) => {
  console.log('Selected Avatar:', avatar);
  console.log('VRM URL:', vrmUrl);
});

Available Methods

getAvatar(network, contractAddress, tokenId)

Get an avatar by network, contract address, and token ID.

getAvatars(filter)

Retrieve a list of avatars based on a specific filter.

getOwnedAvatars(walletAddress)

Get avatars owned by a wallet address.

getOpenSourceAvatars(options)

Fetch open source avatars.

getAvatarsByCollection(options)

Get avatars by collection.

getCollections(filter)

Retrieve a list of NFT collections.

getCollection(collectionName)

Get a specific collection by its name.

Types and Enumerations

The SDK utilizes various types and enumerations that can be helpful in your implementation:

• NFT: Describes a Non-Fungible Token (NFT) with its properties.
• NFTCollection: Defines an NFT collection with its details.
• NFTFilter: Provides filtering options for NFT queries.
• Pagination: Contains constants related to pagination.

Contribution

We welcome contributions! If you'd like to enhance this library, fork it and submit a pull request.

Support

If you need assistance or have any questions, feel free to contact us at [email protected].

License

This project is licensed under the MIT License