GET
/
customers
/
{customerID}
/
liquidation_addresses
/
{liquidationAddressID}
/
drains
Get drain history of a Liquidation Address
curl --request GET \
  --url https://api.bridge.xyz/v0/customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains \
  --header 'Api-Key: <api-key>'
{
  "count": 1,
  "data": [
    {
      "id": "la_123",
      "amount": "100.25",
      "customer_id": "cust_123",
      "liquidation_address_id": "la_456",
      "currency": "usdc",
      "state": "funds_received",
      "created_at": "2020-01-01T00:00:00.000Z",
      "updated_at": "2020-01-01T00:00:00.000Z",
      "deposit_tx_hash": "0xc13d7905be5c989378a945487cd2a1193627ae606009e28e296d48ddaec66162",
      "destination": {
        "payment_rail": "ethereum",
        "currency": "usdt",
        "to_address": "0xb794f5ea0ba39494ce839613fffba74279579268"
      },
      "destination_tx_hash": "0xdeadbeef",
      "receipt": {
        "initial_amount": "100.25",
        "developer_fee": "0.2",
        "subtotal_amount": "100.05",
        "exchange_rate": "1.000000",
        "converted_amount": "100.05",
        "outgoing_amount": "100.05",
        "destination_currency": "usd",
        "url": "https://dashboard.bridge.xyz/transaction/00000000-0000-0000-0000-000000000000/receipt/00000000-0000-0000-0000-000000000000"
      }
    }
  ]
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
customerID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42
​
liquidationAddressID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Query Parameters

​
limit
integer

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

​
starting_after
string

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

​
ending_before
string

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

​
updated_after_ms
integer

This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned

​
updated_before_ms
integer

This is a unix timestamp in milliseconds. If this is specified, objects updated BEFORE the specified timestamp will be returned

Response

200
application/json

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

The response is of type object.