Games

* is a required field

Make sure to use your X-Auth-Token when making a POST request. Your X-Auth-Token is the private key associated to your ERC-20 wallet.

Create Game

Create a new game

Create a new game with images url

POSThttps://game-api.openvessel.io/games/manage/create

Header parameters

Body

application/json

fqGn*string

Fully Qualified Game Name

owner*string

Owner address

displayName*string

Display name

displayInDiscoveryboolean

The flag that controls display in the Discovery

gameTypestring

The type of the game

description*string

Game description

appInfoSet*array of AppInfoRequest (object)

Set of app info

beneficiariesobject

Map of game beneficiaries: address => weight

imageUrl*string

Main image

backgroundImageUrl*string

Background image

Response

200400401403404405409429500

OK

Body

*/*

responseManageResponseGameDetailsResponse (object)

Request

JavaScriptCurl

const response = await fetch('https://game-api.openvessel.io/games/manage/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "appInfoSet": [
        {}
      ],
      "backgroundImageUrl": "Game background image",
      "description": "Super Game for everyone and everywhere",
      "displayName": "Super Game",
      "fqGn": "com.studio.game",
      "imageUrl": "Game image",
      "owner": "0xcafe000102030405060708090a0b0c0d0e0fbeef"
    }),
});
const data = await response.json();

Response

{
  "response": {
    "txHash": "text",
    "description": "text",
    "details": {
      "fqGn": "text",
      "displayName": "text",
      "displayInDiscovery": false,
      "description": "text",
      "contractAddress": "text",
      "owner": "text",
      "imageUrl": "text",
      "backgroundImageUrl": "text",
      "appInfoList": [
        {
          "packageName": "text",
          "publicKey": "text",
          "platform": "iOS"
        }
      ]
    }
  }
}

Create a new game multipart

Create a new game with images upload

POSThttps://game-api.openvessel.io/games/manage/create-multipart

Header parameters

Body

multipart/form-dataapplication/json

data*CreateGameRequest (object)

image*string (binary)

backgroundImage*string (binary)

Response

200400401403404405409429500

OK

Body

*/*

responseManageResponseGameDetailsResponse (object)

Request

JavaScriptCurl

const response = await fetch('https://game-api.openvessel.io/games/manage/create-multipart', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "backgroundImage": "binary",
      "data": {
        "appInfoSet": [
          {}
        ],
        "description": "Super Game for everyone and everywhere",
        "displayName": "Super Game",
        "fqGn": "com.studio.game",
        "owner": "0xcafe000102030405060708090a0b0c0d0e0fbeef"
      },
      "image": "binary"
    }),
});
const data = await response.json();

Response

{
  "response": {
    "txHash": "text",
    "description": "text",
    "details": {
      "fqGn": "text",
      "displayName": "text",
      "displayInDiscovery": false,
      "description": "text",
      "contractAddress": "text",
      "owner": "text",
      "imageUrl": "text",
      "backgroundImageUrl": "text",
      "appInfoList": [
        {
          "packageName": "text",
          "publicKey": "text",
          "platform": "iOS"
        }
      ]
    }
  }
}

create vs create-multipart

You need to upload the image somewhere and post the URL when you use /games/manage/create API. Once it is created, we store image data in our DB.

On the other hand, you can post the image binary directly to us if you use /game/manage/create-multipart API.

Game Metadata

Update game metadata

Update metadata

POSThttps://game-api.openvessel.io/collections/manage/{fqCn}/update-metadata

Path parameters

fqCn*string

Fully Qualified Collection Name

Header parameters

Body

application/json

displayNamestring

New display name

descriptionstring

New description

imageUrlstring

New image URL

Response

200400401403404405409429500

OK

Request

JavaScriptCurl

const response = await fetch('https://game-api.openvessel.io/collections/manage/{fqCn}/update-metadata', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Update game metadata multipart

Update metadata with image upload

POSThttps://game-api.openvessel.io/games/manage/{fqGn}/update-metadata-multipart

Path parameters

fqGn*string

Fully Qualified Game Name

Header parameters

Body

multipart/form-dataapplication/json

data*UpdateGameMetadataRequest (object)

image*string (binary)

backgroundImage*string (binary)

Response

200400401403404405409429500

OK

Request

JavaScriptCurl

const response = await fetch('https://game-api.openvessel.io/games/manage/{fqGn}/update-metadata-multipart', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "backgroundImage": "binary",
      "data": {},
      "image": "binary"
    }),
});
const data = await response.json();

Game Lookup

Lookup the game by fqGn

You can get the game details by fqGn.

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

Path parameters

fqGn*string

Response

200400401403404405409429500

OK

Body

*/*

responseGameDetailsResponse (object)

Request

JavaScriptCurl

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

Response

{
  "response": {
    "fqGn": "text",
    "displayName": "text",
    "displayInDiscovery": false,
    "description": "text",
    "contractAddress": "text",
    "owner": "text",
    "imageUrl": "text",
    "backgroundImageUrl": "text",
    "appInfoList": [
      {
        "packageName": "text",
        "publicKey": "text",
        "platform": "iOS"
      }
    ]
  }
}

Lookup the game by platform and package name

You can get the game details by platform and package name.

GEThttps://game-api.openvessel.io/games/{platform}/{packageName}

Path parameters

platform*string

packageName*string

Response

200400401403404405409429500

OK

Body

*/*

responseGameDetailsResponse (object)

Request

JavaScriptCurl

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

Response

{
  "response": {
    "fqGn": "text",
    "displayName": "text",
    "displayInDiscovery": false,
    "description": "text",
    "contractAddress": "text",
    "owner": "text",
    "imageUrl": "text",
    "backgroundImageUrl": "text",
    "appInfoList": [
      {
        "packageName": "text",
        "publicKey": "text",
        "platform": "iOS"
      }
    ]
  }
}