Sign in

v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB
Liquidation Addresses

Get all Liquidation Addresses for a customer

Get Liquidation Addresses

get/customers/{customerID}/liquidation_addresses

Path parameters

customerIDstring required

A UUID that uniquely identifies a resource

Query parameters

limitinteger

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

starting_afterstring

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_beforestring

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

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

countinteger required

total number of items in data

Example response

{
  "data": [
    {
      "custom_developer_fee_percent": "0.1",
      "global_developer_fee_percent": {
        "percent": "0.2"
      }
    }
  ]
}