{
  "opencollection": "1.0.0",
  "info": {
    "name": "Backpack Exchange Account Capital API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Capital",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Convert a dust balance.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.backpack.exchange/api/v1/account/convertDust",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-SIGNATURE",
                "value": ""
              },
              {
                "name": "X-TIMESTAMP",
                "value": ""
              },
              {
                "name": "X-WINDOW",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Converts a dust balance to USDC. The balance (including lend) must be\nless than the minimum quantity tradable on the spot order book.\n\n**Instruction:** `convertDust`"
        },
        {
          "info": {
            "name": "Get balances.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.backpack.exchange/api/v1/capital",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-SIGNATURE",
                "value": ""
              },
              {
                "name": "X-TIMESTAMP",
                "value": ""
              },
              {
                "name": "X-WINDOW",
                "value": ""
              }
            ]
          },
          "docs": "Retrieves account balances and the state of the balances (locked or\navailable).\n\nLocked assets are those that are currently in an open order.\n\n**Instruction:** `balanceQuery`"
        },
        {
          "info": {
            "name": "Get collateral.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.backpack.exchange/api/v1/capital/collateral",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-SIGNATURE",
                "value": ""
              },
              {
                "name": "X-TIMESTAMP",
                "value": ""
              },
              {
                "name": "X-WINDOW",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "subaccountId",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves collateral information for an account.\n\n**Instruction:** `collateralQuery`"
        },
        {
          "info": {
            "name": "Get deposits.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.backpack.exchange/wapi/v1/capital/deposits",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-SIGNATURE",
                "value": ""
              },
              {
                "name": "X-TIMESTAMP",
                "value": ""
              },
              {
                "name": "X-WINDOW",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Filter to minimum time (milliseconds)."
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "Filter to maximum time (milliseconds)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number to return. Default `100`, maximum `1000`."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset. Default `0`."
              },
              {
                "name": "excludePlatform",
                "value": "",
                "type": "query",
                "description": "Exclude platform deposits originating from the exchange."
              }
            ]
          },
          "docs": "Retrieves deposit history.\n\n**Instruction:** `depositQueryAll`"
        },
        {
          "info": {
            "name": "Get deposit address.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.backpack.exchange/wapi/v1/capital/deposit/address",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-SIGNATURE",
                "value": ""
              },
              {
                "name": "X-TIMESTAMP",
                "value": ""
              },
              {
                "name": "X-WINDOW",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "blockchain",
                "value": "",
                "type": "query",
                "description": "Blockchain symbol to get a deposit address for."
              }
            ]
          },
          "docs": "Retrieves the user specific deposit address if the user were to deposit\non the specified blockchain.\n\n**Instruction:** `depositAddressQuery`"
        },
        {
          "info": {
            "name": "Get withdrawals.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.backpack.exchange/wapi/v1/capital/withdrawals",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-SIGNATURE",
                "value": ""
              },
              {
                "name": "X-TIMESTAMP",
                "value": ""
              },
              {
                "name": "X-WINDOW",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Filter by withdrawal ID."
              },
              {
                "name": "clientId",
                "value": "",
                "type": "query",
                "description": "Filter by client ID."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Filter to minimum time (milliseconds)."
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "Filter to maximum time (milliseconds)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number to return. Default `100`, maximum `1000`."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset. Default `0`."
              }
            ]
          },
          "docs": "Retrieves withdrawal history.\n\n**Instruction:** `withdrawalQueryAll`"
        },
        {
          "info": {
            "name": "Request withdrawal.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.backpack.exchange/wapi/v1/capital/withdrawals",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-TIMESTAMP",
                "value": ""
              },
              {
                "name": "X-WINDOW",
                "value": ""
              },
              {
                "name": "X-SIGNATURE",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Requests a withdrawal from the exchange.\n\nThe `twoFactorToken` field is required if the withdrawal address is not\nan address that is configured in the address book to not require\n2FA.\n\nTo configure a 2FA exempt address, please [add an\naddress](https://backpack.exchange/settings/address-book) to the address book\nand toggle the `Two Factor Authentication Required` option.\n\n**Instruction:** `withdraw`"
        },
        {
          "info": {
            "name": "Get dust conversion history.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.backpack.exchange/wapi/v1/history/dust",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-SIGNATURE",
                "value": ""
              },
              {
                "name": "X-TIMESTAMP",
                "value": ""
              },
              {
                "name": "X-WINDOW",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Filter to a given dust conversion id."
              },
              {
                "name": "symbol",
                "value": "",
                "type": "query",
                "description": "Filter to the given symbol."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number to return. Default `100`, maximum `1000`."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset. Default `0`."
              },
              {
                "name": "sortDirection",
                "value": "",
                "type": "query",
                "description": "Sort direction."
              }
            ]
          },
          "docs": "Retrieves the dust conversion history for the user.\n\n**Instruction:** `dustHistoryQueryAll`"
        },
        {
          "info": {
            "name": "Get settlement history.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.backpack.exchange/wapi/v1/history/settlement",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "X-SIGNATURE",
                "value": ""
              },
              {
                "name": "X-TIMESTAMP",
                "value": ""
              },
              {
                "name": "X-WINDOW",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number to return. Default `100`, maximum `1000`."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination. Default `0`."
              },
              {
                "name": "source",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortDirection",
                "value": "",
                "type": "query",
                "description": "Sort direction."
              }
            ]
          },
          "docs": "History of settlement operations for the account.\n\n**Instruction:** `settlementHistoryQueryAll`"
        }
      ]
    }
  ],
  "bundled": true
}