Liquidation Addresses

Get all Liquidation Addresses

Changed on

Get Liquidation Addresses

get/liquidation_addresses

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/liquidation_addresses
  • Auth
    API key in header Api-Key

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": [
    {
      "supported_currencies": {
        "ethereum": [
          "usdc",
          "eurc"
        ],
        "polygon": [
          "usdc"
        ]
      },
      "custom_developer_fee_percent": "0.1",
      "global_developer_fee_percent": {
        "percent": "0.2"
      }
    }
  ]
}

Changes

    • warning

      added the new all_supported enum value to the // response property for the response status

    • warning

      added the new linea enum value to the // response property for the response status

    • warning

      added the new linea enum value to the // response property for the response status

    • warning

      added the new ousd enum value to the // response property for the response status

    • warning

      added the new path_usd enum value to the // response property for the response status

    • warning

      added the new usdl_linea enum value to the // response property for the response status

    • warning

      added the new usdl_linea enum value to the // response property for the response status

    • warning

      added the new xdc enum value to the // response property for the response status

    • warning

      added the new xdc enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status