Listings

Search listings

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

POST/v1/listings/search

Header parameters

Body

application/json

Defines the structure of a search request. Allows for filtering, sorting, and pagination of results when querying a list of items. The filter property specifies the criteria used to filter the data, sort defines the order in which the results should be returned, and pagination controls the number of results returned and the starting point within the dataset.

filterobject

sortobject

paginationobject

Response

200

Listings and other data

Body

application/json

mythToUsdnumber

This MYTH-USD rate should be stored and then passed to the API when purchasing a listing. 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

listingsarray of Listing (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/listings/search', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filter": {
        "filterProp": "filterByValue"
      },
      "sort": {
        "sortProp": 1
      },
      "pagination": {
        "offset": 0,
        "limit": 100
      }
    }),
});
const data = await response.json();

Response

200

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

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

Path parameters

id*string

UUID of the listing to purchase

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/listings/{id}/purchase', {
    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"
}