{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bridge API Keys Liquidation Addresses API",
    "version": "1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Api-Key",
      "value": "{{Api-Key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Liquidation Addresses",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all Liquidation Addresses for a customer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/liquidation_addresses",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of items to return (min 1, default 10, max 100)"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "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)"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "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)"
              }
            ]
          },
          "docs": "Get Liquidation Addresses"
        },
        {
          "info": {
            "name": "Create a Liquidation Address",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/liquidation_addresses",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Liquidation Address"
        },
        {
          "info": {
            "name": "Get all Liquidation Addresses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/liquidation_addresses",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of items to return (min 1, default 10, max 100)"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "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)"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "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)"
              }
            ]
          },
          "docs": "Get Liquidation Addresses"
        },
        {
          "info": {
            "name": "Get a Liquidation Address",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/liquidation_addresses/:liquidationAddressID",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "liquidationAddressID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a Liquidation Address for the specified Liquidation Address ID"
        },
        {
          "info": {
            "name": "Update a Liquidation Address",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/liquidation_addresses/:liquidationAddressID",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "liquidationAddressID",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a Liquidation Address for the specified liquidation address ID. Note that `external_account_id` and `custom_developer_fee_percent` can be updated independently and are not both required."
        },
        {
          "info": {
            "name": "Get drain history of a Liquidation Address",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/liquidation_addresses/:liquidationAddressID/drains",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "liquidationAddressID",
                "value": "",
                "type": "path"
              },
              {
                "name": "tx_hash",
                "value": "",
                "type": "query",
                "description": "The hash of the transaction"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of items to return (min 1, default 10, max 100)"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "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)"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "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)"
              },
              {
                "name": "updated_after_ms",
                "value": "",
                "type": "query",
                "description": "This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned"
              },
              {
                "name": "updated_before_ms",
                "value": "",
                "type": "query",
                "description": "This is a unix timestamp in milliseconds. If this is specified, objects updated BEFORE the specified timestamp will be returned"
              },
              {
                "name": "drain_id",
                "value": "",
                "type": "query",
                "description": "If specified, results will be filtered to the given drain id only"
              }
            ]
          },
          "docs": "Get drain history of a Liquidation Address"
        },
        {
          "info": {
            "name": "Execute a pending USDT trade on a drain",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/liquidation_addresses/:liquidationAddressID/drains/:drainID/execute",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "liquidationAddressID",
                "value": "",
                "type": "path"
              },
              {
                "name": "drainID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Force-executes a stuck USDT-to-USD trade at the current market rate. The drain must have a pending trade (i.e. appear in `GET /liquidation_addresses/drains/pending`).\n\nAfter execution, the drain will continue processing normally with the executed market rate.\n"
        },
        {
          "info": {
            "name": "Get the balance of a Liquidation Address (deprecated)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/customers/:customerID/liquidation_addresses/:liquidationAddressID/balances",
            "params": [
              {
                "name": "customerID",
                "value": "",
                "type": "path"
              },
              {
                "name": "liquidationAddressID",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get the balance of a Liquidation Address. Note that most Liquidation Addresses no longer hold a balance. To check recent activity on a Liquidation Address, use the `/customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains` endpoint."
        },
        {
          "info": {
            "name": "Liquidation Address Activity Across All Customers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/liquidation_addresses/drains",
            "params": [
              {
                "name": "tx_hash",
                "value": "",
                "type": "query",
                "description": "The hash of the transaction"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of items to return (min 1, default 10, max 100)"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "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)"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "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)"
              },
              {
                "name": "updated_after_ms",
                "value": "",
                "type": "query",
                "description": "This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned"
              },
              {
                "name": "updated_before_ms",
                "value": "",
                "type": "query",
                "description": "This is a unix timestamp in milliseconds. If this is specified, objects updated BEFORE the specified timestamp will be returned"
              },
              {
                "name": "drain_id",
                "value": "",
                "type": "query",
                "description": "If specified, results will be filtered to the given drain id only"
              }
            ]
          },
          "docs": "History of activity across all customers and Liquidation Addresses"
        },
        {
          "info": {
            "name": "List drains with pending USDT trades",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bridge.xyz/v0/liquidation_addresses/drains/pending",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of items to return (min 1, default 10, max 100)"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "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)"
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "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)"
              },
              {
                "name": "updated_after_ms",
                "value": "",
                "type": "query",
                "description": "This is a unix timestamp in milliseconds. If this is specified, objects updated AFTER the specified timestamp will be returned"
              },
              {
                "name": "updated_before_ms",
                "value": "",
                "type": "query",
                "description": "This is a unix timestamp in milliseconds. If this is specified, objects updated BEFORE the specified timestamp will be returned"
              }
            ]
          },
          "docs": "Returns drains that have a stuck USDT-to-USD trade awaiting execution. Results are sorted by creation time (newest first) and paginated.\n\nUse `POST /customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains/{drainID}/execute` to force-execute a pending trade at the current market rate.\n"
        }
      ]
    }
  ],
  "bundled": true
}