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

get

Path parameters

fqGnstringRequired

Fully Qualified Game Name

Example: com.studio.game

qCnstringRequired

Qualified Collection Name

Example: armor01

Responses

200

OK

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

405

Method Not Allowed

*/*

409

Conflict

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /users/{fqGn}/{qCn}/ HTTP/1.1
Host: game-api.openvessel.io
Accept: */*

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

Lookup all users who own the token

All users who own a given token

get

Path parameters

fqGnstringRequired

Fully Qualified Game Name

Example: com.studio.game

qCnstringRequired

Qualified Collection Name

Example: armor01

qTnstringRequired

Qualified Token Name

Example: shield

Responses

200

OK

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

405

Method Not Allowed

*/*

409

Conflict

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /users/{fqGn}/{qCn}/{qTn} HTTP/1.1
Host: game-api.openvessel.io
Accept: */*

{
  "response": [
    {
      "address": "text",
      "amount": 1
    }
  ]
}

User Token Lookup

Lookup all tokens in the game by the user

List of all tokens for selected user

get

Path parameters

addressstringRequired

Filter by blockchain address of the given user

Example: 0xcafe000102030405060708090a0b0c0d0e0fbeefPattern: ^0x[a-fA-F0-9]{40}$

fqGnstringRequired

Fully Qualified Game Name

Example: com.studio.game

Responses

200

OK

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

405

Method Not Allowed

*/*

409

Conflict

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /user/{address}/tokens/{fqGn}/ HTTP/1.1
Host: game-api.openvessel.io
Accept: */*

{
  "response": [
    {
      "fqTn": "text",
      "totalSupply": 1,
      "amount": 1
    }
  ]
}

Lookup all tokens in the collection by the user

List of all tokens for selected user

get

Path parameters

addressstringRequired

Filter by blockchain address of the given user

Example: 0xcafe000102030405060708090a0b0c0d0e0fbeefPattern: ^0x[a-fA-F0-9]{40}$

fqGnstringRequired

Fully Qualified Game Name

Example: com.studio.game

qCnstringRequired

Qualified Collection Name

Example: armor01

Responses

200

OK

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

405

Method Not Allowed

*/*

409

Conflict

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /user/{address}/tokens/{fqGn}/{qCn}/ HTTP/1.1
Host: game-api.openvessel.io
Accept: */*

{
  "response": [
    {
      "fqTn": "text",
      "totalSupply": 1,
      "amount": 1
    }
  ]
}

Lookup the details about the user token

Details about user token

get

Path parameters

addressstringRequired

Filter by blockchain address of the given user

Example: 0xcafe000102030405060708090a0b0c0d0e0fbeefPattern: ^0x[a-fA-F0-9]{40}$

fqGnstringRequired

Fully Qualified Game Name

Example: com.studio.game

qCnstringRequired

Qualified Collection Name

Example: armor01

qTnstringRequired

Qualified Token Name

Example: token

Responses

200

OK

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

405

Method Not Allowed

*/*

409

Conflict

*/*

429

Too Many Requests

*/*

500

Internal Server Error

*/*

get

HTTPcURLJavaScriptPython

GET /user/{address}/tokens/{fqGn}/{qCn}/{qTn} HTTP/1.1
Host: game-api.openvessel.io
Accept: */*

{
  "response": {
    "fqTn": "text",
    "totalSupply": 1,
    "amount": 1
  }
}

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