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

Authorizations

Header parameters

Authorizationstring · Bearer {bearerToken}required

Bearer token to be passed for Authorization. Can be retrieved from v1/auth/token

x-mythical-environment-idstring · uuidrequired

Identifier for the environment that this request should interact with

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/players' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000'

200

200

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

Success

Get a player

Retrieve a single player by their id.

get

/v1/players/{playerId}

Authorizations

Path parameters

playerIdstringrequired

Header parameters

Authorizationstring · Bearer {bearerToken}required

Bearer token to be passed for Authorization. Can be retrieved from v1/auth/token

x-mythical-environment-idstring · uuidrequired

Identifier for the environment that this request should interact with

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/players/{playerId}' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000'

200

200

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

Player

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

Authorizations

Path parameters

playerIdstring · stringrequired

The identifier of the guest player to be merged.

Header parameters

Authorizationstring · Bearer {bearerToken}required

Bearer token to be passed for Authorization. Can be retrieved from v1/auth/token

x-mythical-environment-idstring · uuidrequired

Identifier for the environment that this request should interact with

Body

registeredAccountJwtstring · stringrequired

bearer token for the registered mythical player

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/players/{playerId}/link' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "registeredAccountJwt": "jwt"
  }'

200

200

No body

Success

Get player inventory

Retrieves a list of items owned by a given player.

get

/v1/players/{playerId}/items

Authorizations

Path parameters

playerIdstring · uuidrequired

Header parameters

Authorizationstring · Bearer {bearerToken}required

Bearer token to be passed for Authorization. Can be retrieved from v1/auth/token

x-mythical-environment-idstring · uuidrequired

Identifier for the environment that this request should interact with

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/players/{playerId}/items' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000'

200

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
        }
      ]
    }
  }
]

Success