Listings

Search listings

Retrieve a list of marketplace listings. Supports filtering, sorting, and pagination.

post

/v1/listings/search

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

Body

filterobject

sortobject

paginationobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/listings/search' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "filter": {
      "filterProp": "filterByValue"
    },
    "sort": {
      "sortProp": 1
    },
    "pagination": {
      "offset": 0,
      "limit": 100
    }
  }'

200

200

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

Listings and other data

Purchase a listing

Purchase the specified listing 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 listing has not changed.

post

/v1/listings/{id}/purchase

Authorizations

Path parameters

idstringrequired

UUID of the listing to purchase

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

playerIdstring · uuid

versionnumber

Example: 1

mythToUSDnumber

Example: 0.33

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/listings/{id}/purchase' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "playerId": "123e4567-e89b-12d3-a456-426614174000",
    "version": 1,
    "mythToUSD": 0.33
  }'

200

200

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

Response with traceId.