GET
/
liquidation_addresses
Get all Liquidation Addresses
curl --request GET \
  --url https://api.bridge.xyz/v0/liquidation_addresses \
  --header 'Api-Key: <api-key>'
{
  "count": 123,
  "data": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "external_account_id": "<string>",
      "prefunded_account_id": "<string>",
      "destination_wire_message": "<string>",
      "destination_sepa_reference": "<string>",
      "destination_spei_reference": "<string>",
      "destination_ach_reference": "<string>",
      "destination_payment_rail": "ach",
      "destination_currency": "dai",
      "address": "<string>",
      "destination_address": "<string>",
      "destination_blockchain_memo": "<string>",
      "return_address": "<string>",
      "state": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Api-Key
string
header
required

Query Parameters

​
limit
integer

The number of items to return (default of 10, max of 100)

​
starting_after
string

This is a liquidation address id. If this is specified, the next page that starts with a liquidation address right AFTER the specified liquidation address id on the liquidation address timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that liquidation address older than the specified liquidation address id will be returned (shouldn't be set if ending_before is set)

​
ending_before
string

This is a liquidation address id. If this is specified, the previous page that ends with a liquidation address right BEFORE the specified liquidation address id on the liquidation address timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that liquidation address newer than the specified liquidation address id will be returned (shouldn't be set if starting_after is set)

Response

200
application/json

List of Liquidation Addresses (the returned list is empty if none found)

The response is of type object.