Players

Create a player

Allows a player to be created without having gone through registration, enabling a frictionless first time user experience including asset ownership.

POST/v1/players

Header parameters

Response

200

Success

Body

application/json

idstring (uuid)

Unique identifier of the player

typeenum

...

guestregistered

mergedFromstring (uuid)

The oauthid of the guest player which was linked to this registered player. This will be null if this account has never been linked

mergedAtstring (date-time)

The date and time at which the guest player was linked.

Request

JavaScriptCurlPython

const response = await fetch('/v1/players', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Response

200

{
  "id": "9779f02d-5193-4ab1-ae15-f18e091f38e1",
  "type": "guest",
  "mergedFrom": null,
  "mergedAt": null
}

Get a player

Retrieve a single player by their id.

GET/v1/players/{playerId}

Path parameters

playerId*string

Header parameters

Response

200

Player

Body

application/json

idstring (uuid)

Unique identifier of the player

typeenum

...

guestregistered

mergedFromstring (uuid)

The oauthid of the guest player which was linked to this registered player. This will be null if this account has never been linked

mergedAtstring (date-time)

The date and time at which the guest player was linked.

Request

JavaScriptCurlPython

const response = await fetch('/v1/players/{playerId}', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Response

200

{
  "id": "9779f02d-5193-4ab1-ae15-f18e091f38e1",
  "type": "guest",
  "mergedFrom": null,
  "mergedAt": null
}

Link a guest player to a registered player

Enables player linking functionality that's typical in mobile games where guest players who've earned progress and potentially even purchased assets want to centralize their assets on a registered player. Linking a guest player to a registered player will bulk transfer all assets from the guest player's wallet to the registered player's wallet. The mergedFrom field is set on the guest player for traceability. If a registered player already existed, the registered player record will be marked deleted and the mergedAt field updated. The guest player will also receive the mergedAt timestamp and will continue to function normally. A player can only be involved in a merge once.

POST/v1/players/{playerId}/link

Path parameters

playerId*string (string)

The identifier of the guest player to be merged.

Header parameters

Body

application/json

The JSON web token of the registered player which the guest will be linked to.

registeredAccountJwt*string (string)

bearer token for the registered mythical player

Response

200

Success

Request

JavaScriptCurlPython

const response = await fetch('/v1/players/{playerId}/link', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "registeredAccountJwt": "jwt"
    }),
});
const data = await response.json();

Get player inventory

Retrieves a list of items owned by a given player.

GET/v1/players/{playerId}/items

Path parameters

playerId*string (uuid)

Header parameters

Response

200

Success

Body

application/json

idstring (uuid)

Unique identifier of the item

itemTypeIdstring (uuid)

Unique identifier of the item

ownerPlayerIdstring (uuid)

The id of the player who owns the item

tokenIdinteger

The on-chain unique identifier of the item within its given collection. The token id of the item is displayed in the Mythical Marketplace.

Example: 1

stateenum

The current state of the item on chain

Example: "pending"

pendingfailed

metadataUrlstring

The location where the public metadata json is stored

Example: "http://url.com/1"

metadataItemMetadata (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/players/{playerId}/items', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "itemTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "ownerPlayerId": "123e4567-e89b-12d3-a456-426614174000",
    "tokenId": 1,
    "state": "pending",
    "metadataUrl": "http://url.com/1",
    "metadata": {
      "name": "text",
      "description": "text",
      "image": "text",
      "attributes": [
        {
          "type": "string",
          "value": "attrValue",
          "displayType": "number, boolean, string",
          "maxValue": 255
        }
      ]
    }
  }
]