Orders

Deprecated

get

Retrieve a list of active orders.

Query parameters

accountAddressstring · xrp-addressOptional

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

bondIdstring · uuidOptional

Unique UUID of an entity

Example: a4920401-7a59-421f-ae43-3a16459eb4a7

Responses

200

Successfully retrieved a list of items.

application/json

get

/orders

HTTPcURLJavaScriptPython

GET /orders HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "created_at": "2026-03-22T12:30:18.126Z",
      "updated_at": "2026-03-22T12:30:18.126Z",
      "id": "619599ef-ebaf-41f3-87b7-9c62e1d09584",
      "account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "buy_token_id": "19e4a97c-6fc5-4d38-a8db-7bd96ecff954",
      "buy_amount": 1,
      "buy_remaining_amount": 1,
      "sell_token_id": "4830f778-7d10-41e5-8369-8779724ebba2",
      "sell_amount": 2,
      "sell_remaining_amount": 2,
      "type": "buy",
      "status": "active",
      "ratio": 2,
      "expires_at": "2024-12-31T00:00:00.000Z"
    }
  ]
}

Deprecated

post

Create a new order. Example: buy/sell a bond with a currency type token.

Body

application/json

currencyIdstring · uuidRequired

Unique UUID of the currency in scope of this gateway

Example: 548dd95d-9d5f-4752-83d0-d2ad47319790

pricenumberRequired

Total price of the currency

Example: 2

bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: b0f68ae3-0a43-4d2a-9677-58fce7f2bd44

amountnumberRequired

Total amount of the bond

Example: 1

typestring · enumRequired

Order Type

Possible values:

expirationstring · date-timeOptional

Expiration date

Example: 2024-12-31T00:00:00.000Z

accountAddressstring · xrp-addressRequired

Account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

Responses

201

Successfully created an order.

application/json

post

/orders

HTTPcURLJavaScriptPython

POST /orders HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "currencyId": "548dd95d-9d5f-4752-83d0-d2ad47319790",
  "price": 2,
  "bondId": "b0f68ae3-0a43-4d2a-9677-58fce7f2bd44",
  "amount": 1,
  "type": "buy",
  "expiration": "2024-12-31T00:00:00.000Z",
  "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"
}

201

Successfully created an order.

{
  "created_at": "2026-03-22T12:30:18.126Z",
  "updated_at": "2026-03-22T12:30:18.126Z",
  "id": "619599ef-ebaf-41f3-87b7-9c62e1d09584",
  "account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "buy_token_id": "19e4a97c-6fc5-4d38-a8db-7bd96ecff954",
  "buy_amount": 1,
  "buy_remaining_amount": 1,
  "sell_token_id": "4830f778-7d10-41e5-8369-8779724ebba2",
  "sell_amount": 2,
  "sell_remaining_amount": 2,
  "type": "buy",
  "status": "active",
  "ratio": 2,
  "expires_at": "2024-12-31T00:00:00.000Z"
}

Deprecated

get

Retrieve full specific order information.

Path parameters

orderIdstring · uuidRequired

Order UUID identifier, global in scope of TSS

Example: 5f7f3b9f-a8ad-4d27-b256-b192231b2451

Responses

200

Successfully received an order.

application/json

created_atstring · date-timeRequired

Created date

updated_atstring · date-timeRequired

Updated date

idstring · uuidRequired

Unique identifier for the order in scope of this gateway

Example: 619599ef-ebaf-41f3-87b7-9c62e1d09584

account_addressstring · xrp-addressRequired

Address of the account that places the order

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

buy_token_idstring · uuidRequired

Unique identifier for the token being bought in the order in scope of this gateway

Example: 19e4a97c-6fc5-4d38-a8db-7bd96ecff954

buy_amountnumberRequired

Total amount of the token being bought

Example: 1

buy_remaining_amountnumberRequired

Remaining amount of the token being bought

Example: 1

sell_token_idstring · uuidRequired

Unique identifier for the token being sold in the order in scope of this gateway

Example: 4830f778-7d10-41e5-8369-8779724ebba2

sell_amountnumberRequired

Total amount of the token being sold

Example: 2

sell_remaining_amountnumberRequired

Remaining amount of the token being sold

Example: 2

typestring · enumRequired

Order Type

Possible values:

statusstring · enumRequired

Status of the order

Possible values:

rationumberRequired

Ratio of the order

Example: 2

expires_atstring · date-time · nullableOptional

Expiration date of the order.

Example: 2024-12-31T00:00:00.000Z

get

/orders/{orderId}

HTTPcURLJavaScriptPython

GET /orders/{orderId} HTTP/1.1
Accept: */*

200

Successfully received an order.

{
  "created_at": "2026-03-22T12:30:18.126Z",
  "updated_at": "2026-03-22T12:30:18.126Z",
  "id": "619599ef-ebaf-41f3-87b7-9c62e1d09584",
  "account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "buy_token_id": "19e4a97c-6fc5-4d38-a8db-7bd96ecff954",
  "buy_amount": 1,
  "buy_remaining_amount": 1,
  "sell_token_id": "4830f778-7d10-41e5-8369-8779724ebba2",
  "sell_amount": 2,
  "sell_remaining_amount": 2,
  "type": "buy",
  "status": "active",
  "ratio": 2,
  "expires_at": "2024-12-31T00:00:00.000Z"
}

Deprecated

put

Update an existing order. Example: buy/sell a bond with a currency type token.

Path parameters

orderIdstring · uuidRequired

Order UUID identifier, global in scope of TSS

Example: 5f7f3b9f-a8ad-4d27-b256-b192231b2451

Body

application/json

currencyIdstring · uuidRequired

Unique UUID of the currency in scope of this gateway

Example: 548dd95d-9d5f-4752-83d0-d2ad47319790

pricenumberRequired

Total price of the currency

Example: 2

bondIdstring · uuidRequired

Unique UUID of the bond in scope of this gateway

Example: b0f68ae3-0a43-4d2a-9677-58fce7f2bd44

amountnumberRequired

Total amount of the bond

Example: 1

typestring · enumRequired

Order Type

Possible values:

expirationstring · date-timeOptional

Expiration date

Example: 2024-12-31T00:00:00.000Z

Responses

201

Successfully updated an order.

application/json

put

/orders/{orderId}

HTTPcURLJavaScriptPython

PUT /orders/{orderId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "currencyId": "548dd95d-9d5f-4752-83d0-d2ad47319790",
  "price": 2,
  "bondId": "b0f68ae3-0a43-4d2a-9677-58fce7f2bd44",
  "amount": 1,
  "type": "buy",
  "expiration": "2024-12-31T00:00:00.000Z"
}

201

Successfully updated an order.

{
  "created_at": "2026-03-22T12:30:18.126Z",
  "updated_at": "2026-03-22T12:30:18.126Z",
  "id": "619599ef-ebaf-41f3-87b7-9c62e1d09584",
  "account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "buy_token_id": "19e4a97c-6fc5-4d38-a8db-7bd96ecff954",
  "buy_amount": 1,
  "buy_remaining_amount": 1,
  "sell_token_id": "4830f778-7d10-41e5-8369-8779724ebba2",
  "sell_amount": 2,
  "sell_remaining_amount": 2,
  "type": "buy",
  "status": "active",
  "ratio": 2,
  "expires_at": "2024-12-31T00:00:00.000Z"
}

Deprecated

patch

Cancel the order by id parameter.

Path parameters

orderIdstring · uuidRequired

Order UUID identifier, global in scope of TSS

Example: 5f7f3b9f-a8ad-4d27-b256-b192231b2451

Responses

200

The order was cancelled.

No content

patch

/orders/{orderId}

HTTPcURLJavaScriptPython

PATCH /orders/{orderId} HTTP/1.1
Accept: */*

200

The order was cancelled.

No content