Players

Create a player for the title_id

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

x-idempotency-keystring · max: 64Required

A unique identifier for the request. If the request is repeated with the same idempotency key, the response will be the same as the first request. Recommend using a UUID or ULID

Responses

201

Success

application/json

post

/v1/players

HTTPcURLJavaScriptPython

POST /v1/players HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000
x-idempotency-key: text
Accept: */*

201

Success

{
  "id": "9779f02d-5193-4ab1-ae15-f18e091f38e1"
}

Get a player

get

Retrieve a single player by their id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

playerIdstringRequired

Header parameters

x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

Responses

200

Player

application/json

404

Player not found

application/json

get

/v1/players/{playerId}

HTTPcURLJavaScriptPython

GET /v1/players/{playerId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

{
  "id": "9779f02d-5193-4ab1-ae15-f18e091f38e1"
}

Link a player to a registered Mythical account

post

Player linking allows a player to be connected to a Mythical account and wallet. This allows players to progress and acquire on-chain assets and then link those to a Mythical account for marketplace trading. Linking a player is a one time operation that cannot be reversed. Only one player (per environment) can be linked to a Mythical account.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

playerIdstringRequired

The identifier of the player to be linked.

Header parameters

x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

x-idempotency-keystring · max: 64Required

A unique identifier for the request. If the request is repeated with the same idempotency key, the response will be the same as the first request. Recommend using a UUID or ULID

Body

application/json

registeredAccountJwtstringRequired

bearer token for the registered Mythical account

Responses

204

Player linked

401

Unauthorized

application/json

post

/v1/players/{playerId}/link

HTTPcURLJavaScriptPython

POST /v1/players/{playerId}/link HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000
x-idempotency-key: text
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "registeredAccountJwt": "jwt"
}

No content

Get player inventory

get

Retrieves a list of items owned by a given player.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

playerIdstringRequired

Header parameters

x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

Responses

200

Success

application/json

get

/v1/players/{playerId}/items

HTTPcURLJavaScriptPython

GET /v1/players/{playerId}/items HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

200

Success

[
  {
    "id": "text",
    "itemTypeId": "text",
    "ownerPlayerId": "text",
    "tokenId": 1,
    "state": "pending",
    "metadataUrl": "http://url.com/1",
    "metadata": {
      "name": "text",
      "description": "text",
      "image": "text",
      "attributes": [
        {
          "type": "attributeName",
          "value": "attrValue",
          "displayType": "number, boolean, string",
          "maxValue": 255
        }
      ]
    },
    "tags": [
      "text"
    ]
  }
]