Market

Get orders

get

Get paginated list of orders for a specific listing

Path parameters
listingIdstring · uuidRequired

Listing UUID identifier, global in scope of TSS

Example: 6b7ccbb6-e2fc-4617-80a5-5e10114370a5
Query parameters
modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible values:
orderanyOptional

Array of fields and directions to order. Supported fields: createdAt, id, accountAddress, type, side, status, amount, filledAmount, price, placedAt, cancelledAt, expiresAt

Responses
200

Successfully retrieved a list of items.

application/json
get
/market/listings/{listingId}/orders
200

Successfully retrieved a list of items.

Place order

post

Place an order on a listed asset pair

Path parameters
listingIdstring · uuidRequired

Listing UUID identifier, global in scope of TSS

Example: 6b7ccbb6-e2fc-4617-80a5-5e10114370a5
Body
accountAddressstring · xrp-addressRequired

Investment account address that is placing the order

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

Type of the order execution

string · enumOptional

Type of the order execution

Possible values:
sideall ofRequired

Side of the order indicating buy or sell

string · enumOptional

Side of the order indicating buy or sell

Possible values:
amountinteger · int64 · min: 1Required

Amount of the base asset to trade

priceinteger · int64 · min: 1Optional

Price per unit of the base asset. Required for limit orders

expiresAtstring · date-timeOptional

Optional expiration date of the order, defaults to 30 days from creation if not provided

Example: 2026-01-10T08:55:12.883Z
Responses
post
/market/listings/{listingId}/orders
201

Placed order

Get order

get

Get specific order by its ID for a specific listing

Path parameters
listingIdstring · uuidRequired

Listing UUID identifier, global in scope of TSS

Example: 6b7ccbb6-e2fc-4617-80a5-5e10114370a5
orderIdstring · uuidRequired

Order UUID identifier, global in scope of TSS

Example: 1f37a856-1f74-4b8a-9505-9b547f315419
Responses
200

Retrieved order

application/json
get
/market/listings/{listingId}/orders/{orderId}
200

Retrieved order

Cancel order

patch

Cancel an open order on a listed pair

Path parameters
listingIdstring · uuidRequired

Listing UUID identifier, global in scope of TSS

Example: 6b7ccbb6-e2fc-4617-80a5-5e10114370a5
orderIdstring · uuidRequired

Order UUID identifier, global in scope of TSS

Example: 5f7f3b9f-a8ad-4d27-b256-b192231b2451
Body
statusall ofRequired

New status of the order

Example: cancelled
string · enumOptional

Status of the order lifecycle:

  • open: Order is active and not yet fully filled or cancelled
  • filled: Order has been fully filled/executed
  • rejected: Order could not be executed
  • cancelled: Order has been cancelled by the user or system
  • expired: Order has reached its expiration time without being fully filled
Possible values:
Responses
200

Updated order

application/json
patch
/market/listings/{listingId}/orders/{orderId}
200

Updated order

Get market

get

Get market details and current status

Responses
200

Market details

application/json
get
/market
200

Market details

Get market halts

get

Get all market halts

Query parameters
modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible values:
sizenumber · min: 1OptionalDefault: 10Example: 10
pagenumber · min: 1OptionalDefault: 1Example: 1
Responses
200

Successfully retrieved a list of items.

application/json
get
/market/halts
200

Successfully retrieved a list of items.

Get listings

get

Get paginated list of market listings

Query parameters
modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible values:
orderanyOptional

Array of fields and directions to order. Supported fields: status, initiatedAt, listedAt, delistingInitiatedAt, createdAt, updatedAt

Responses
200

Successfully retrieved a list of items.

application/json
get
/market/listings
200

Successfully retrieved a list of items.

Get trades

get

Get paginated list of trades for a market listing

Path parameters
listingIdstring · uuidRequired

Listing UUID identifier, global in scope of TSS

Example: 6b7ccbb6-e2fc-4617-80a5-5e10114370a5
Query parameters
modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible values:
orderanyOptional

Array of fields and directions to order. Supported fields: createdAt, sellAccountAddress, buyAccountAddress, amount, price, totalPrice, executedAt, executionOrder

Responses
200

Successfully retrieved a list of items.

application/json
get
/market/listing/{listingId}/trades
200

Successfully retrieved a list of items.

Get trade

get

Get a single trade by its ID for a market listing

Path parameters
listingIdstring · uuidRequired

Listing UUID identifier, global in scope of TSS

Example: 6b7ccbb6-e2fc-4617-80a5-5e10114370a5
tradeIdstring · uuidRequired

Trade UUID identifier, global in scope of TSS

Example: 9b17c64e-069d-4f4f-9ed9-9ffd34e2df6f
Responses
200

Trade

application/json
get
/market/listing/{listingId}/trades/{tradeId}
200

Trade

Last updated