Quick trade

Last updated 5 months ago

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

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

listingsstring · uuid[]required

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.

offersstring · uuid[]required

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/quick-trade' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "listings": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "offers": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

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

Quick trade

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

Authorizations

Path parameters

idstringrequired

UUID of the quick trade to cancel

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

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/quick-trade/{id}/cancel' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000'

200

No body

Success

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

Authorizations

Path parameters

idstringrequired

UUID of the quick trade to execute

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/quick-trade/{id}/execute' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000'

200

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

Response with traceId.