Offers

Get offers on a players items

For each provided item belonging to the player, will return the best offer which has been placed in the Mythical Marketplace.

POST/v1/players/{playerId}/offers

Path parameters

playerId*string (uuid)

UUID of the player to find offers for

Header parameters

Body

application/json

A list of items from the players inventory for which to retrieve the best offers on.

itemsarray of string (uuid)

Response

200

Offers and other data

Body

application/json

mythToUsdnumber

This MYTH-USD rate should be stored and then passed to the API when accepting an offer. This enables the platform to ensure the MYTH-USD rate has not changed significantly since when the price was quoted, protecting the game and players from unwanted slippage.

Example: 0.33

offersarray of Offer (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "mythToUsd": 0.33,
  "offers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "priceUSD": 0,
      "feeUSD": 0,
      "priceMYTH": 0,
      "feeMYTH": 0,
      "version": 0,
      "item": {
        "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
            }
          ]
        }
      }
    }
  ]
}

Accept an offer

Accept the specified offer from the Mythical Marketplace on behalf of the given player. Will only succeed if the provided mythToUsd rate has not deviated too far from when the price was quoted, and the version of the offer has not changed.

POST/v1/offers/{id}/accept

Path parameters

id*string

UUID of the offer to accept

Header parameters

Body

application/json

playerIdstring (uuid)

versionnumber

Example: 1

mythToUSDnumber

Example: 0.33

Response

200

Response with traceId.

Body

application/json

traceIdstring

A unique identifier for tracing the request

Example: "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e"

Request

JavaScriptCurlPython

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

Response

200

{
  "traceId": "f4e5d3a4-2a9b-4d9f-bc5a-73b3f0c47b5e"
}