Quick trade

Create a quick trade

Creates a quick trade transaction based on the specified listings and offers, confirming that the quick trade can be executed. When the quick trade is created, the listings and offers are reserved for some time. The items are released when the quick trade is cancelled, executed, or expires.

POST/v1/quick-trade

Header parameters

Body

application/json

listings*array of string (uuid)

An array of listing ids which are being purchased as part of the quick trade. This adds to a currency deficit in the quick trade.

offers*array of string (uuid)

An array of offers which are being accepted as part of the quick trade. This adds to a currency surplus in the quick trade.

Response

200

Quick trade

Body

application/json

idstring (uuid)

Unique identifier for the quick trade quoted with the specified listings and offers.

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Cancel a quick trade

Cancelling a quick trade releases the offers and listings involved so that other users on the marketplace can interact with them. If a user prematurely leaves the quick trade flow, the quick trade should be cancelled.

POST/v1/quick-trade/{id}/cancel

Path parameters

id*string

UUID of the quick trade to cancel

Header parameters

Response

200

Success

Request

JavaScriptCurlPython

const response = await fetch('/v1/quick-trade/{id}/cancel', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Execute a quick trade

The offers and listings in the quick trade will be accepted and purchases on behalf of the user. The user will be charged/credited according to whether the quick trade creates a currency deficit/surplus.

POST/v1/quick-trade/{id}/execute

Path parameters

id*string

UUID of the quick trade to execute

Header parameters

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/quick-trade/{id}/execute', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Response

200

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