Skip to main content
GET
Your swap orders.

Authorizations

X-API-Key
string
header
required

Your API key from the Studio Dashboard

Query Parameters

page
integer
default:1

Page number, 1-indexed.

Required range: x >= 1
page_size
integer
default:50

Items per page. Default 50, max 100.

Required range: 1 <= x <= 100
order_id
string

Filter by exact public id (swpo_xxxxxxx).

offer_id
integer
of_account_id
integer

Match orders where this OF account appears on either side.

role
enum<string>

offer = orders placed against your offers; order = orders you placed.

Available options:
offer,
order
status
enum<string>
Available options:
waiting,
accepted,
rejected,
completed,
cancelled
from
string<date>

Lower bound on the resource date (YYYY-MM-DD, UTC, inclusive).

to
string<date>

Upper bound on the resource date (YYYY-MM-DD, UTC, inclusive).

sort
enum<string>
default:created_at_desc

Sort order.

  • created_at_desc: newest orders first (default).
  • created_at_asc: oldest orders first.
  • completed_at_desc: most recently completed first. NULL completed_at (still running / not completed) always sorts to the bottom regardless of direction.
  • completed_at_asc: earliest completed first. NULL completed_at always at the bottom.
Available options:
created_at_desc,
created_at_asc,
completed_at_desc,
completed_at_asc

Response

Paged list of swap orders.

success
boolean
data
object[]
pagination
object

Page-based pagination, returned by every list endpoint that isn't a cursor feed.