Nft API

Endpoint	Method	Description
resource:getNftsByAddress	websocket	Get nfts by address
resource:getNftsByAddressAsync	websocket	Get nfts by address async
resource:createNftByUrl	websocket	Create nft resource by url
resource:createNftByToken	websocket	Create nft resource by token
user:addNftWallet	websocket	Add nft wallet
user:deleteNftWallet	websocket	Delete nft wallet
user:getNftWalletsNoBalance	websocket	Get nft wallets no balance
user:getNftWallets	websocket	Get nft wallets
user:nftWalletAdded	websocketEvent	Nft wallet added event
user:nftWalletDeleted	websocketEvent	Nft wallet deleted event
resource:nftsByAddress	websocketEvent	Wallet nfts event
user:nftWallets	websocketEvent	User nft wallets event

Get nfts by address

Method: websocket

Endpoint: resource:getNftsByAddress

Request:

{
    "data": {
        "walletAddress": string
        "searchQuery": string
        "offset": int
        "size": int
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "data": {
        "nfts": [{
            "contractAddress": string
            "url": string
            "urlType": string  // json/image
            "tokenId": string
            "title": string
            "description": string
        }]
        "hasMore": bool
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get nfts by address async

Method: websocket

Endpoint: resource:getNftsByAddressAsync

Request:

{
    "data": {
        "walletAddress": string
        "searchQuery": string
        "offset": int
        "size": int
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "error": { "status": bool, "code": int, "message": string }
}

Create nft resource by url

Method: websocket

Endpoint: resource:createNftByUrl

Request:

{
    "data": {
        "url": string
        "thumbnailUrl": string
        "title": string
        "description": string
        "parent": string  // mark that resource belongs to directory
        "roomId": string  // mark that resource belongs to room
        "contributeToRoom": string  // mark that resource belongs to room sorting table
        "addToSortingTable": bool  // mark that resource belongs to user sorting table
        "belonging": string  // use custom belonging (like 'userAIGeneration:{userId}')
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "data": {
        "resource": { resource structure }
    }
    "error": { "status": bool, "code": int, "message": string }
}

Create nft resource by token

Method: websocket

Endpoint: resource:createNftByToken

Request:

{
    "data": {
        "contractAddress": string
        "tokenId": string
        "parent": string  // mark that resource belongs to directory
        "roomId": string  // mark that resource belongs to room
        "contributeToRoom": string  // mark that resource belongs to room sorting table
        "addToSortingTable": bool  // mark that resource belongs to user sorting table
        "belonging": string  // use custom belonging (like 'userAIGeneration:{userId}')
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "data": {
        "resource": { resource structure }
    }
    "error": { "status": bool, "code": int, "message": string }
}

Add nft wallet

Method: websocket

Endpoint: user:addNftWallet

Request:

{
    "data": {
        "address": string
        "walletType": string
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "error": { "status": bool, "code": int, "message": string }
}

Delete nft wallet

Method: websocket

Endpoint: user:deleteNftWallet

Request:

{
    "data": {
        "address": string
        "walletType": string
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "error": { "status": bool, "code": int, "message": string }
}

Get nft wallets no balance

Method: websocket

Endpoint: user:getNftWalletsNoBalance

Description: Returns nft wallets without balance.

Request:

{ empty }

Response:

{
    "data": {
        "wallets": [{
            "address": string
            "walletType": string
        }]
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get nft wallets

Method: websocket

Endpoint: user:getNftWallets

Description: Returns nft wallets with balance.

Request:

{ empty }

Response:

{
    "data": {
        "wallets": [{
            "address": string
            "walletType": string
            "amountOfNfts": int
            "amountOfRoomis": float
        }]
    }
    "error": { "status": bool, "code": int, "message": string }
}

Nft wallet added event

Event: user:nftWalletAdded

Data:

{
    "data": {
        "wallet": {
            "address": string
            "walletType": string
        }
    }
    "error": { "status": bool, "code": int, "message": string }
}

Nft wallet deleted event

Event: user:nftWalletDeleted

Data:

{
    "data": {
        "wallet": {
            "address": string
            "walletType": string
        }
    }
    "error": { "status": bool, "code": int, "message": string }
}

Wallet nfts event

Event: resource:nftsByAddress

Description: Event sends information about nfts in a wallet. Triggers by getNftsByAddressAsync endpoint.

Data:

{
    "data": {
        "request": {
            "walletAddress": string
            "searchQuery": string
            "offset": int
            "size": int
        }
        "response": {
            "nfts": [{
                "contractAddress": string
                "url": string
                "urlType": string  // json/image
                "tokenId": string
                "title": string
                "description": string
            }]
            "hasMore": bool
        }
    }
    "error": { "status": bool, "code": int, "message": string }
}

User nft wallets event

Event: user:nftWallets

Description: Event sends information about user nft wallets. Triggers on socket connection.

Data:

{
    "data": {
        "wallets": [{
            "address": string
            "walletType": string
            "amountOfNfts": int
            "amountOfRoomis": float
        }]
    }
    "error": { "status": bool, "code": int, "message": string }
}

Models

Resource

{
    "id": string
    "created": timestamp
    "updated": timestamp
    "title": string
    "description": string
    "location": string
    "date": string
    "category": string
    "linkId": string  // id of resource link is pointing to
    "linkType": string  // global/local
    "encryptionVersion": string  // encryption version, like 'verus.v1'
    "encryptionEpoch": int  // epoch defines key bundle that was used for encryption
    "encryptionEpk": string  // ephemeral public key that should be used to decrypt cypher data
    "belonging": string  // determines resource location in the system in a way 'belongingType:belongingPath(networkId)'
    "status": string  // pending/processing/ready/failed
    "metadata": {
        "fileName": string
        "fileSize": int
        "fileDate": timestamp
        "behaviourType": string
        "contentType": string
        "convertedFrom": string
        "link": string
        "origin": { resource origin structure }
        "geolocation": { geolocation structure }
        "dimensions": { dimensions structure }
    }
    "thumbnail": string
    "fromTemplate": bool
    "totalReactions": int  // amount of users who reacted to the resource
    "data": {
        "audio": { resource data audio structure }
        "video": { resource data video structure }
        "amazon": { resource data amazon structure }
        "imdb": { resource data imdb structure }
        "youtube": { resource data youtube structure }
        "pinterest": { resource data pinterest structure }
        "pixabay": { resource data pixabay structure }
        "facebook": { resource data facebook structure }
        "remoteUrl": { resource data remote url structure }
        "liveStream": { live stream data structure }
        "aiGeneration": { ai generation data structure }
        "thumbnailUrl": string
        "downloadUrl": string
        "directory": { resource data directory structure }
        "channel": { channel data structure }
        "googleDrive": { google drive structure }
    }
    "customParams": map[string]{ custom structure }  // client defined parameters
    "actions": [{ programmatic action with children structure }]  // custom programmatic actions from users
}

Resource Origin

{
    "type": string
    "device": string
    "deviceName": string
    "path": string
}

Geolocation

{
    "latitude": float
    "longitude": float
}

Dimensions

{
    "width": int
    "height": int
    "orientation": int
}

Resource Data Audio

{
    "title": string
    "artist": string
    "album": string
    "genre": string
    "duration": int
    "durationFloat": float
}

Resource Data Video

{
    "duration": int
    "durationFloat": float
    "hasAlphaChannel": bool  // true, if video generated from gif with transparent pixels
    "alphaChannel": string  // alpha channel video resource (if generated from gif)
}

Resource Data Amazon

{
    "asin": string
    "summary": string
    "author": [ string ]
    "manufacturer": string
    "title": string
    "publicationDate": string
    "url": string
}

Resource Data Imdb

{
    "Actors": string
    "Genre": string
    "Ratings": [{
        "Source": string
        "Value": string
    }]
    "Released": string
    "Runtime": string
    "Website": string
    "Year": string
    "Trailers": [ string ]
    "imdbID": string
}

Resource Data Youtube

{
    "videoId": string
    "formatId": string
}

Resource Data Pinterest

{
    "pin": string
    "url": string
}

Resource Data Pixabay

{
    "id": string
    "pageUrl": string
}

Resource Data Facebook

{
    "id": string
}

Resource Data Remote Url

{
    "url": string
    "urlType": string
    "favicon": string
    "title": string
}

Live Stream Data

{
    "streamId": string
    "assetId": string
    "playbackUrl": string
    "masterUrl": string
}

AI Generation Data

{
    "generationModel": string  // the model used for image generation [dall-e-3]
    "prompt": string  // a text description of the desired image
    "revisedPrompt": string  // the prompt that was used to generate the image, if there was any revision to the prompt
    "url": string  // the URL of the generated image
}

Resource Data Directory

{
    "innerContentType": string
    "innerContentCount": int
}

Channel Data

{
    "communityId": string
    "channelId": string
    "subChannelId": string
    "messageId": string
}

Google Drive

{
    "fileId": string
    "name": string
    "mimeType": string
}

Programmatic Action with children

{
    "localId": string  // local action id, operated by client side only
    "eventName": string
    "actionName": string
    "actionData": {
        "usedPropId": string
        "usedRoomId": string
        "usedNetworkId": string
        "usedStorylineId": string
        "usedQuestionId": int
        "usedQuestionnaireId": int
        "usedSegmentId": string
        "usedPlacementAreaId": string
        "usedRoomPoint": string
        "animationData": map[string]{ custom structure }
    }
    "childActions": [{ programmatic action structure }]
}

Programmatic Action

{
    "localId": string  // local action id, operated by client side only
    "eventName": string
    "actionName": string
    "actionData": {
        "usedPropId": string
        "usedRoomId": string
        "usedNetworkId": string
        "usedStorylineId": string
        "usedQuestionId": int
        "usedQuestionnaireId": int
        "usedSegmentId": string
        "usedPlacementAreaId": string
        "usedRoomPoint": string
        "animationData": map[string]{ custom structure }
    }
}