Skip to main content
GET
/
v1
/
swaps
List
curl --request GET \
  --url https://{defaultHost}/v1/swaps \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/swaps"
  },
  "data": [
    {
      "id": "261709ba-fe56-47a2-bd61-2ac27e21bb1c",
      "object": "swap",
      "archived": false,
      "archived_at": null,
      "description": "Swap this price for another",
      "metadata": {},
      "price": "7695dd89-80fc-4b53-9bde-23d91073224e",
      "swap_price": "95c58ffc-fadd-4ffc-b1d1-dc2a71144457",
      "discarded_at": null,
      "created_at": 1780925659,
      "updated_at": 1780925659
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
archived
boolean

Only return objects that are archived or not archived.

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
page
integer

The page of items you want returned.

​
price_ids[]
string[]

Only return objects that belong to the given prices.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.