Users

How to use the API to get information about users and their tokens

* is a required field

User Lookup

Lookup all users who own the token in the collection

List of all users who own tokens of the selected collection

GEThttps://game-api.openvessel.io/users/{fqGn}/{qCn}/

Path parameters

fqGn*string

Fully Qualified Game Name

qCn*string

Qualified Collection Name

Response

200400401403404405409429500

OK

Body

*/*

response*array of UserAddressResponse (object)

Request

JavaScriptCurl

const response = await fetch('https://game-api.openvessel.io/users/{fqGn}/{qCn}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "response": [
    {
      "address": "text"
    }
  ]
}

Lookup all users who own the token

All users who own a given token

GEThttps://game-api.openvessel.io/users/{fqGn}/{qCn}/{qTn}

Path parameters

fqGn*string

Fully Qualified Game Name

qCn*string

Qualified Collection Name

qTn*string

Qualified Token Name

Response

200400401403404405409429500

OK

Body

*/*

response*array of UserTokenAmountResponse (object)

Request

JavaScriptCurl

const response = await fetch('https://game-api.openvessel.io/users/{fqGn}/{qCn}/{qTn}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "response": [
    {
      "address": "text"
    }
  ]
}

User Token Lookup

Lookup all tokens in the game by the user

List of all tokens for selected user

GEThttps://game-api.openvessel.io/user/{address}/tokens/{fqGn}/

Path parameters

address*string

Filter by blockchain address of the given user

fqGn*string

Fully Qualified Game Name

Response

200400401403404405409429500

OK

Body

*/*

response*array of UserTokenInfoResponse (object)

Request

JavaScriptCurl

const response = await fetch('https://game-api.openvessel.io/user/{address}/tokens/{fqGn}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "response": [
    {
      "fqTn": "text"
    }
  ]
}

Lookup all tokens in the collection by the user

List of all tokens for selected user

GEThttps://game-api.openvessel.io/user/{address}/tokens/{fqGn}/{qCn}/

Path parameters

address*string

Filter by blockchain address of the given user

fqGn*string

Fully Qualified Game Name

qCn*string

Qualified Collection Name

Response

200400401403404405409429500

OK

Body

*/*

response*array of UserTokenInfoResponse (object)

Request

JavaScriptCurl

const response = await fetch('https://game-api.openvessel.io/user/{address}/tokens/{fqGn}/{qCn}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "response": [
    {
      "fqTn": "text"
    }
  ]
}

Lookup the details about the user token

Details about user token

GEThttps://game-api.openvessel.io/user/{address}/tokens/{fqGn}/{qCn}/{qTn}

Path parameters

address*string

Filter by blockchain address of the given user

fqGn*string

Fully Qualified Game Name

qCn*string

Qualified Collection Name

qTn*string

Qualified Token Name

Response

200400401403404405409429500

OK

Body

*/*

response*UserTokenInfoResponse (object)

Request

JavaScriptCurl

const response = await fetch('https://game-api.openvessel.io/user/{address}/tokens/{fqGn}/{qCn}/{qTn}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "response": {
    "fqTn": "text"
  }
}

Token Object

Name	Type	Description
fqTn	string	Fully qualified token name
totalSupply	number	Total number of minted tokens
amount	number	Number of tokens user owns