Mythical Platform
Mythical Platform
  • The Mythical Platform API
  • Quick start
    • Authenticate
    • Create a guest player
    • Create an item type
    • Grant an item to a player
    • Update item metadata
    • Use webhooks for real time messages
    • Buy a listed item
  • API Reference
    • Players
    • Item Types
    • Items
    • Marketplace
      • Listings
      • Offers
      • Quick trade
      • Transaction history
      • Exchange rate
      • Check status of transaction
    • Webhook management
    • System
Powered by GitBook
On this page
  1. API Reference

Players

PreviousBuy a listed itemNextItem Types

Last updated 5 months ago

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
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
application/json
objectOptionalExample: {"id":"9779f02d-5193-4ab1-ae15-f18e091f38e1","type":"guest"}
post
POST /v1/players HTTP/1.1
Host: 
Authorization: Bearer JWT
x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000
x-idempotency-key: text
Accept: */*
201

Success

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

Get a player

get

Retrieve a single player by their id.

Authorizations
Path parameters
playerIdstringRequired
Header parameters
x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

Responses
application/json
objectOptionalExample: {"id":"9779f02d-5193-4ab1-ae15-f18e091f38e1","type":"guest"}
application/json
get
GET /v1/players/{playerId} HTTP/1.1
Host: 
Authorization: Bearer JWT
x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

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

Get player inventory

get

Retrieves a list of items owned by a given player.

Authorizations
Path parameters
playerIdstringRequired
Header parameters
x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

Responses
application/json
object[]Optional
get
GET /v1/players/{playerId}/items HTTP/1.1
Host: 
Authorization: Bearer JWT
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"
    ]
  }
]
  • POSTCreate a player for the title_id
  • GETGet a player
  • POSTLink a guest player to a registered player
  • GETGet player inventory

Link a guest player to a registered player

post

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.

Authorizations
Path parameters
playerIdstringRequired

The identifier of the guest player to be merged.

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
registeredAccountJwtstringRequired

bearer token for the registered mythical player

Responses
application/json
objectOptionalExample: {"id":"9779f02d-5193-4ab1-ae15-f18e091f38e1","type":"guest"}
application/json
post
POST /v1/players/{playerId}/link HTTP/1.1
Host: 
Authorization: Bearer JWT
x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000
x-idempotency-key: text
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "registeredAccountJwt": "jwt"
}
{
  "id": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e",
  "type": "registered",
  "mergedFrom": "b915c482-1170-4dc7-819e-8ebf83569bc4",
  "mergedAt": "2021-01-01T00:00:00Z"
}