### Get Mark Prices JSON Response Example

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Example JSON response for the 'Get Mark Prices' endpoint, showing funding rate, index price, mark price, next funding timestamp, and symbol.

```json
[
  {
    "fundingRate": "string",
    "indexPrice": "string",
    "markPrice": "string",
    "nextFundingTimestamp": 0,
    "symbol": "string"
  }
]
```

--------------------------------

### Get K-lines JSON Response Example

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Example JSON response for the 'Get K-lines' endpoint, showing the structure of asks and bids, last update ID, and timestamp.

```json
{
  "asks": [
    [
      "21.9",
      "500.123"
    ],
    [
      "22.1",
      "2321.11"
    ]
  ],
  "bids": [
    [
      "20.12",
      "255.123"
    ],
    [
      "20.5",
      "499.555"
    ]
  ],
  "lastUpdateId": "1684026955123",
  "timestamp": 1684026955123
}
```

--------------------------------

### Get Borrow/Lend History - Request Example

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

This example shows how to retrieve borrow and lend history. It utilizes query parameters such as 'type', 'sources', 'positionId', 'symbol', 'limit', 'offset', and 'sortDirection' to filter and paginate the results. Essential headers include API key, signature, timestamp, and window.

```http
GET /wapi/v1/history/borrowLend?type=Borrow&symbol=BTC&limit=100&sortDirection=Desc HTTP/1.1
Host: api.backpack.exchange
X-API-KEY: YOUR_API_KEY
X-SIGNATURE: YOUR_SIGNATURE
X-TIMESTAMP: 1678886400000
X-WINDOW: 5000
```

--------------------------------

### Get Open Positions - Response Example

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

This is a sample JSON response for the 'Get open positions' endpoint. It details various attributes of a futures position, including entry price, mark price, PnL, and liquidation price. The structure provides a comprehensive overview of an account's open positions.

```json
[
  {
    "breakEvenPrice": "string",
    "entryPrice": "string",
    "estLiquidationPrice": "string",
    "imf": "string",
    "imfFunction": {
      "type": "sqrt",
      "base": "string",
      "factor": "string"
    },
    "markPrice": "string",
    "mmf": "string",
    "mmfFunction": {
      "type": "sqrt",
      "base": "string",
      "factor": "string"
    },
    "netCost": "string",
    "netQuantity": "string",
    "netExposureQuantity": "string",
    "netExposureNotional": "string",
    "pnlRealized": "string",
    "pnlUnrealized": "string",
    "cumulativeFundingPayment": "string",
    "subaccountId": 0,
    "symbol": "string",
    "userId": 0,
    "positionId": "string",
    "cumulativeInterest": "string"
  }
]
```

--------------------------------

### Get Funding Interval Rates JSON Response Example

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Example JSON response for the 'Get Funding Interval Rates' endpoint, including symbol, interval end timestamp, and funding rate.

```json
[
  {
    "symbol": "string",
    "intervalEndTimestamp": "string",
    "fundingRate": "string"
  }
]
```

--------------------------------

### Get Open Interest JSON Response Example

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Example JSON response for the 'Get Open Interest' endpoint, containing symbol, open interest, and timestamp.

```json
[
  {
    "symbol": "string",
    "openInterest": "string",
    "timestamp": 0
  }
]
```

--------------------------------

### Get Ticker - JSON Response Example

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Example JSON response for the 'Get ticker' endpoint, showing detailed market statistics for a single symbol over the last 24 hours. Includes price, volume, and trade data.

```json
{
  "symbol": "string",
  "baseSymbol": "BTC",
  "quoteSymbol": "BTC",
  "marketType": "SPOT",
  "filters": {
    "price": {
      "minPrice": "string",
      "maxPrice": "string",
      "tickSize": "string",
      "maxMultiplier": "string",
      "minMultiplier": "string",
      "maxImpactMultiplier": "string",
      "minImpactMultiplier": "string",
      "meanMarkPriceBand": {
        "maxMultiplier": "string",
        "minMultiplier": "string"
      },
      "meanPremiumBand": {
        "tolerancePct": "string"
      },
      "borrowEntryFeeMaxMultiplier": "string",
      "borrowEntryFeeMinMultiplier": "string"
    },
    "quantity": {
      "minQuantity": "string",
      "maxQuantity": "string",
      "stepSize": "string"
    }
  },
  "imfFunction": {
    "type": "sqrt",
    "base": "string",
    "factor": "string"
  },
  "mmfFunction": {
    "type": "sqrt",
    "base": "string",
    "factor": "string"
  },
  "fundingInterval": 0,
  "fundingRateUpperBound": "string",
  "fundingRateLowerBound": "string",
  "openInterestLimit": "string",
  "orderBookState": "Open",
  "createdAt": "string",
  "visible": true
}
```

--------------------------------

### Get Markets Response Sample (JSON)

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

This snippet displays a sample JSON response for the 'Get markets' endpoint, detailing supported markets with their trading parameters and funding information.

```json
[{
    "borrowInterestRate": "string",
    "borrowedQuantity": "string",
    "lendInterestRate": "string",
    "lentQuantity": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "utilization": "string"
}]
```

--------------------------------

### Get Tickers - JSON Response Example

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Example JSON response for the 'Get tickers' endpoint, returning an array of market symbols, each with summarized statistics for the last 24 hours. Includes price, volume, and trade data.

```json
[
  {
    "symbol": "string",
    "firstPrice": "string",
    "lastPrice": "string",
    "priceChange": "string",
    "priceChangePercent": "string",
    "high": "string",
    "low": "string",
    "volume": "string",
    "quoteVolume": "string",
    "trades": "string"
  }
]
```

--------------------------------

### Get Open Positions - Request Example

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

This snippet demonstrates how to request open positions for a futures account. It includes essential header parameters like API key, signature, and timestamp. The query parameter 'symbol' can be used to filter results.

```http
GET /api/v1/position?symbol=BTCUSDT HTTP/1.1
Host: api.backpack.exchange
X-API-KEY: YOUR_API_KEY
X-SIGNATURE: YOUR_SIGNATURE
X-TIMESTAMP: 1678886400000
X-WINDOW: 5000
```

--------------------------------

### Get Market Response Sample (JSON)

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

This snippet provides a sample JSON response for the 'Get market' endpoint, showcasing detailed information about a specific market, including its filters, funding rates, and creation timestamp.

```json
[{
    "symbol": "string",
    "baseSymbol": "BTC",
    "quoteSymbol": "BTC",
    "marketType": "SPOT",
    "filters": {
        "price": {
            "minPrice": "string",
            "maxPrice": "string",
            "tickSize": "string",
            "maxMultiplier": "string",
            "minMultiplier": "string",
            "maxImpactMultiplier": "string",
            "minImpactMultiplier": "string",
            "meanMarkPriceBand": {
                "maxMultiplier": "string",
                "minMultiplier": "string"
            },
            "meanPremiumBand": {
                "tolerancePct": "string"
            },
            "borrowEntryFeeMaxMultiplier": "string",
            "borrowEntryFeeMinMultiplier": "string"
        },
        "quantity": {
            "minQuantity": "string",
            "maxQuantity": "string",
            "stepSize": "string"
        }
    },
    "imfFunction": {
        "type": "sqrt",
        "base": "string",
        "factor": "string"
    },
    "mmfFunction": {
        "type": "sqrt",
        "base": "string",
        "factor": "string"
    },
    "fundingInterval": 0,
    "fundingRateUpperBound": "string",
    "fundingRateLowerBound": "string",
    "openInterestLimit": "string",
    "orderBookState": "Open",
    "createdAt": "string",
    "visible": true
}]
```

--------------------------------

### Cancel Order (URL Example)

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

A URL-formatted example for canceling an order on the BPX exchange. It includes the order ID, symbol, and a timestamp, demonstrating the parameters required for order cancellation.

```url
instruction=ordercancel&orderid=28&symbol=btc_usdt&timestamp=1614550000000&window=5000
```

--------------------------------

### Test WebSocket Subscription with wscat

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Provides a command-line example using 'wscat' to test subscribing to the 'depth.SOL_USDC' stream. It includes piping a subscription command and then allowing standard input for further interaction.

```bash
(sleep 1; echo '{"method":"SUBSCRIBE","params":["depth.SOL_USDC"]}\n'; cat) | wscat -c wss://ws.backpack.exchange
```

--------------------------------

### Fetch K-Line Data (URL Example)

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

URL structure for fetching K-line (candlestick) data for a given symbol and interval. This is crucial for technical analysis and backtesting trading strategies.

```url
kline.<interval>.<symbol
```

--------------------------------

### Get K-lines Response Structure

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Defines the structure of a successful response for the 'Get K-lines' endpoint, detailing fields like start, end, open, high, low, close, volume, quoteVolume, and trades.

```json
[
  {
    "start": "string",
    "end": "string",
    "open": "string",
    "high": "string",
    "low": "string",
    "close": "string",
    "volume": "string",
    "quoteVolume": "string",
    "trades": "string"
  }
]
```

--------------------------------

### API Request Signing Process

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Explains the general process of signing API requests. This involves creating a signing string from request parameters or body, potentially prefixing it with an instruction type, and then signing it with a private key.

```text
Sign the message using the private key of the ED25519 keypair corresponding to the public key in the X-API-Key header.
Base64 encode the signature and submit it in the X-Signature header.
```

--------------------------------

### Open Order Response Sample (JSON)

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Provides a sample JSON response for retrieving an open order. It includes details like order ID, creation timestamp, executed quantities, cancellation reasons, strategy type, status, side, symbol, and client-specific settings.

```json
[  {
    "id": "string",
    "createdAt": "string",
    "executedQuantity": "string",
    "executedQuoteQuantity": "string",
    "cancelReason": "Expired",
    "strategyType": "Scheduled",
    "quantity": "string",
    "selfTradePrevention": "RejectTaker",
    "status": "Running",
    "side": "Bid",
    "symbol": "string",
    "timeInForce": "GTC",
    "clientStrategyId": 0,
    "duration": 0,
    "interval": 0,
    "randomizedIntervalQuantity": true,
    "slippageTolerance": "string",
    "slippageToleranceType": "TickSize"
  }
]
```

--------------------------------

### Get K-lines Endpoint

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Fetches K-lines for a specified market symbol with optional start and end times and price type. The API returns data in JSON format.

```http
get/api/v1/klines
```

--------------------------------

### Execute Order Response Sample (JSON)

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

A sample JSON response for executing an order. This structure includes various order details such as type, ID, timestamps, quantities, status, trading parameters, and strategy configurations.

```json
{
  "orderType": "Market",
  "id": "string",
  "clientId": 0,
  "createdAt": 0,
  "executedQuantity": "string",
  "executedQuoteQuantity": "string",
  "quantity": "string",
  "quoteQuantity": "string",
  "reduceOnly": true,
  "timeInForce": "GTC",
  "selfTradePrevention": "RejectTaker",
  "side": "Bid",
  "status": "Cancelled",
  "stopLossTriggerPrice": "string",
  "stopLossLimitPrice": "string",
  "stopLossTriggerBy": "string",
  "symbol": "string",
  "takeProfitTriggerPrice": "string",
  "takeProfitLimitPrice": "string",
  "takeProfitTriggerBy": "string",
  "triggerBy": "string",
  "triggerPrice": "string",
  "triggerQuantity": "string",
  "triggeredAt": 0,
  "relatedOrderId": "string",
  "strategyId": "string",
  "slippageTolerance": "string",
  "slippageToleranceType": "TickSize"
}
```

--------------------------------

### Get K-lines (OpenAPI)

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Retrieves K-Lines for a market symbol with specified interval, start time, and optional end time and price type. Requires symbol, interval, and startTime.

```OpenAPI
{
  "get": {
    "tags": [
      "Markets"
    ],
    "summary": "Get K-lines.",
    "description": "Get K-Lines for the given market symbol, optionally providing a\n`startTime` and `endTime`. If no `endTime` is provided, the current time\nwill be used.\n\nThe `priceType` parameter can be used to specify the price type of the\nkline. If not provided, the default is `LastPrice`.",
    "parameters": [
      {
        "name": "symbol",
        "schema": {
          "type": "string"
        },
        "in": "query",
        "description": "Market symbol for the kline query, e.g. SOL_USDC.",
        "required": true,
        "deprecated": false,
        "explode": true
      },
      {
        "name": "interval",
        "schema": {
          "$ref": "#/components/schemas/KlineInterval"
        },
        "in": "query",
        "required": true,
        "deprecated": false,
        "explode": true
      },
      {
        "name": "startTime",
        "schema": {
          "type": "integer",
          "format": "int64"
        },
        "in": "query",
        "description": "UTC timestamp in seconds.",
        "required": true,
        "deprecated": false,
        "explode": true
      },
      {
        "name": "endTime",
        "schema": {
          "type": "integer",
          "format": "int64"
        },
        "in": "query",
        "description": "UTC timestamp in seconds. Set to the current time if not provided.",
        "required": false,
        "deprecated": false,
        "explode": true
      },
      {
        "name": "priceType",
        "schema": {
          "$ref": "#/components/schemas/KlinePriceType"
        },
        "in": "query",
        "description": "The price type of the K-line.",
        "required": false,
        "deprecated": false,
        "explode": true
      }
    ],
    "responses": {
      "200": {
        "description": "Success.",
        "content": {
          "application/json; charset=utf-8": {
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/Kline"
              }
            }
          }
        }
      },
      "400": {
        "description": "Bad request.",
        "content": {
          "application/json; charset=utf-8": {
            "schema": {
              "$ref": "#/components/schemas/ApiErrorResponse"
            }
          }
        }
      },
      "500": {
        "description": "Internal server error.",
        "content": {
          "application/json; charset=utf-8": {
            "schema": {
              "$ref": "#/components/schemas/ApiErrorResponse"
            }
          }
        }
      }
    },
    "operationId": "get_klines"
  }
}
```

--------------------------------

### POST /order

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Executes a single order by submitting it to the matching engine. Requires authentication headers and an order payload.

```APIDOC
## POST /order

### Description
Submits an order to the matching engine for execution.

### Method
POST

### Endpoint
/order

### Parameters
#### Header Parameters
- **X-API-KEY** (string) - Required - API key
- **X-SIGNATURE** (string) - Required - Signature of the request
- **X-TIMESTAMP** (integer) - Required - Timestamp of the request in milliseconds
- **X-WINDOW** (integer) - Optional - Time the request is valid for in milliseconds (default `5000`, maximum `60000`)
- **X-BROKER-ID** (integer) - Optional - Broker ID of the order
- **X-Broker-Id** (integer) - Optional - Broker ID of the order

#### Request Body
- **orderExecutePayload** (object) - Required - Payload containing order details.

### Request Example
```json
{
  "example": "orderExecutePayload"
}
```

### Response
#### Success Response (200)
- **orderType** (object) - Order executed.

#### Error Response (400)
- **apiErrorResponse** (object) - Bad request.

#### Error Response (500)
- **apiErrorResponse** (object) - Internal server error.

#### Error Response (503)
- **apiErrorResponse** (object) - System under maintenance.
```

--------------------------------

### Get Interest History - JSON Response Sample

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Example JSON response for retrieving interest history. This includes details about borrow and lend events, position IDs, quantities, and timestamps.

```json
[  {
    "eventType": "Borrow",
    "positionId": "string",
    "positionQuantity": "string",
    "quantity": "string",
    "source": "AdlProvider",
    "symbol": "string",
    "timestamp": "string",
    "spotMarginOrderId": "string"
  }
]
```

--------------------------------

### Get Interest History Response Sample - Payment Details

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Example JSON response snippet for interest payment details, including payment type, interest rate, interval, market symbol, and timestamp.

```json
[  {
    "paymentType": "EntryFee",
    "interestRate": "string",
    "interval": 0,
    "marketSymbol": "string",
    "positionId": "string",
    "quantity": "string",
    "symbol": "BTC",
    "timestamp": "string"
  }
]
```

--------------------------------

### Execute Limit Order (Python)

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Example of executing a limit order on the BPX exchange using Python. This involves specifying order type, price, quantity, symbol, and a timestamp. It demonstrates how to construct the order execution request.

```python
instruction=orderexecute&ordertype=limit&price=141&quantity=12&side=bid&symbol=sol_usdc_perp&instruction=orderexecute&ordertype=limit&price=140&quantity=11&side=bid&symbol=sol_usdc_perp&timestamp=1750793021519&window=5000
```

--------------------------------

### Test WebSocket Subscription (Shell)

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

A command-line example using `wscat` to connect to the Backpack Exchange WebSocket API and subscribe to the 'depth.SOL_USDC' stream. It includes a `sleep` command to ensure the subscription message is sent after connection.

```shell
(sleep 1; \
    echo '{"method":"SUBSCRIBE","params":["depth.SOL_USDC"]}';\
    cat) |\ 
    wscat -c wss://ws.backpack.exchange
```

--------------------------------

### Get Borrow Position History - JSON Response Sample

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Example JSON response for retrieving borrow and lend position history. Includes details like position ID, quantity, symbol, interest, and side.

```json
[  {
    "positionId": "string",
    "quantity": "string",
    "symbol": "string",
    "source": "AdlProvider",
    "cumulativeInterest": "string",
    "avgInterestRate": "string",
    "side": "Borrow",
    "createdAt": "string"
  }
]
```

--------------------------------

### GET /wapi/v1/history/settlement

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Get settlement history. History of settlement operations for the account.

```APIDOC
## GET /wapi/v1/history/settlement

### Description
Get settlement history. History of settlement operations for the account.

### Method
GET

### Endpoint
/wapi/v1/history/settlement

### Parameters
#### Header Parameters
- **X-API-KEY** (string) - Optional - API key.
- **X-SIGNATURE** (string) - Optional - Signature of the request.
- **X-TIMESTAMP** (int64) - Optional - Timestamp of the request in milliseconds.
- **X-WINDOW** (uint64) - Optional - Time the request is valid for in milliseconds (default `5000`, maximum `60000`).

#### Query Parameters
- **limit** (uint64) - Optional - Maximum number to return. Default `100`, maximum `1000`.
- **offset** (uint64) - Optional - Offset for pagination. Default `0`.
- **source** (SettlementSourceFilter) - Optional - Filter by settlement source.
- **sortDirection** (SortDirection) - Optional - Sort direction.

### Response
#### Success Response (200)
- **ACCESS-CONTROL-EXPOSE-HEADERS** (string) - Indicates which headers are accessible.
- **X-PAGE-COUNT** (uint64) - The total number of pages available.
- **X-CURRENT-PAGE** (uint64) - The current page number.
- **X-PAGE-SIZE** (uint64) - The number of items per page.
- **X-TOTAL** (uint64) - The total number of items available.

#### Response Example
```json
[
  {
    "id": "settle_123",
    "status": "completed",
    "amount": "100.00",
    "currency": "USD",
    "timestamp": 1678886400000
  }
]
```
```

--------------------------------

### Batch Order Execution Signing

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Illustrates the signing procedure for batch order executions. Each order in the batch is processed individually, parameters are sorted alphabetically, and then combined with the 'orderExecute' instruction, timestamp, and window.

```APIDOC
## POST /orders

### Description
This endpoint allows for the execution of multiple orders in a single batch request.

### Method
POST

### Endpoint
/orders

### Parameters
#### Request Body
- **Array of Orders** (array) - Required - Each object in the array represents an order with the following fields:
  - **symbol** (string) - Required - The trading symbol (e.g., SOL_USDC_PERP).
  - **side** (string) - Required - The side of the order ('Bid' or 'Ask').
  - **orderType** (string) - Required - The type of order (e.g., 'Limit').
  - **price** (string) - Required - The price for the order.
  - **quantity** (string) - Required - The quantity of the asset to trade.

### Request Example
```json
[
    {
        "symbol": "SOL_USDC_PERP",
        "side": "Bid",
        "orderType": "Limit",
        "price": "141",
        "quantity": "12"
    },
    {
        "symbol": "SOL_USDC_PERP",
        "side": "Bid",
        "orderType": "Limit",
        "price": "140",
        "quantity": "11"
    }
]
```

### Signing Process
For batch orders, each order's parameters are sorted alphabetically and converted to a query string. The `instruction=orderExecute` is prefixed to each. These are then concatenated with `&`, followed by the final timestamp and window. The signing string is:

`instruction=orderExecute&orderType=Limit&price=141&quantity=12&side=Bid&symbol=SOL_USDC_PERP&instruction=orderExecute&orderType=Limit&price=140&quantity=11&side=Bid&symbol=SOL_USDC_PERP&timestamp=1750793021519&window=5000`

### Response
#### Success Response (200)
- **results** (array) - An array containing the results for each executed order.

#### Response Example
```json
{
  "results": [
    {
      "orderId": "12345"
    },
    {
      "orderId": "67890"
    }
  ]
}
```
```

--------------------------------

### Get Deposits Endpoint

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Information about the get deposits endpoint, including optional timestamp filters.

```APIDOC
## GET /api/v1/deposits

### Description
Retrieves a list of user deposits. This endpoint now supports optional `from` and `to` timestamp filters.

### Method
GET

### Endpoint
/api/v1/deposits

### Parameters
#### Query Parameters
- **from** (integer) - Optional - Unix timestamp in milliseconds to filter deposits from.
- **to** (integer) - Optional - Unix timestamp in milliseconds to filter deposits until.
```

--------------------------------

### Signing String for Batch Order Execution

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Creates the signing string for a batch of order executions. Each order's parameters are ordered alphabetically, converted to a query string, prefixed with 'orderExecute', concatenated, and appended with timestamp and window.

```text
instruction=orderExecute&orderType=Limit&price=141&quantity=12&side=Bid&symbol=SOL_USDC_PERP&instruction=orderExecute&orderType=Limit&price=140&quantity=11&side=Bid&symbol=SOL_USDC_PERP&timestamp=1750793021519&window=5000
```

--------------------------------

### Get Withdrawals Endpoint

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Information about the get withdrawals endpoint, including optional timestamp filters.

```APIDOC
## GET /api/v1/withdrawals

### Description
Retrieves a list of user withdrawals. This endpoint now supports optional `from` and `to` timestamp filters.

### Method
GET

### Endpoint
/api/v1/withdrawals

### Parameters
#### Query Parameters
- **from** (integer) - Optional - Unix timestamp in milliseconds to filter withdrawals from.
- **to** (integer) - Optional - Unix timestamp in milliseconds to filter withdrawals until.
```

--------------------------------

### GET /api/v1/market

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Retrieves information about all available trading markets. This endpoint is useful for getting a comprehensive list of trading pairs and their specifications.

```APIDOC
## GET /api/v1/market

### Description
Retrieves information about all available trading markets. This endpoint is useful for getting a comprehensive list of trading pairs and their specifications.

### Method
GET

### Endpoint
/api/v1/market

### Parameters
#### Query Parameters
- **symbol** (string) - Optional - Filter by a specific market symbol.

### Response
#### Success Response (200)
- **market_list** (array) - A list of market objects, including trading pair, price, volume, and other relevant data.

### Response Example
{
  "market_list": [
    {
      "symbol": "BTC-USDC",
      "last_price": "30000.00",
      "volume_24h": "10000000.00",
      "open_price": "29500.00"
    }
  ]
}
```

--------------------------------

### POST /api/v1/order

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Submits an order to the matching engine for execution. Requires API key, signature, and timestamp in headers.

```APIDOC
## POST /api/v1/order

### Description
Submits an order to the matching engine for execution.

### Method
POST

### Endpoint
/api/v1/order

### Parameters
#### Header Parameters
- **X-API-KEY** (string) - Required - API key
- **X-SIGNATURE** (string) - Required - Signature of the request
- **X-TIMESTAMP** (integer) - Required - Timestamp of the request in milliseconds
- **X-WINDOW** (integer) - Optional - Time the request is valid for in milliseconds (default `5000`, maximum `60000`)
- **X-BROKER-ID** (integer) - Optional - Broker ID of the order
- **X-Broker-Id** (integer) - Optional - Broker ID of the order (duplicate, consider using one)

### Request Body
(Note: The request body structure is not explicitly defined in the provided text, but typically includes order details like symbol, side, quantity, type, etc. The response example provides fields that might be part of a request.)

### Response
#### Success Response (200)
- **orderType** (string) - The type of the order (e.g., Market, Limit).
- **id** (string) - The unique identifier for the order.
- **clientId** (integer) - The client-defined ID for the order.
- **createdAt** (integer) - The timestamp when the order was created.
- **executedQuantity** (string) - The quantity of the asset that has been executed.
- **executedQuoteQuantity** (string) - The quote quantity that has been executed.
- **quantity** (string) - The total quantity of the asset to be traded.
- **quoteQuantity** (string) - The total quote quantity for the order.
- **reduceOnly** (boolean) - Indicates if the order is reduce-only.
- **timeInForce** (string) - The time in force for the order (e.g., GTC).
- **selfTradePrevention** (string) - The self-trade prevention policy.
- **side** (string) - The side of the order (Bid or Ask).
- **status** (string) - The current status of the order.
- **stopLossTriggerPrice** (string) - The trigger price for a stop-loss order.
- **stopLossLimitPrice** (string) - The limit price for a stop-loss order.
- **stopLossTriggerBy** (string) - The condition that triggers the stop-loss.
- **symbol** (string) - The market symbol for the order.
- **takeProfitTriggerPrice** (string) - The trigger price for a take-profit order.
- **takeProfitLimitPrice** (string) - The limit price for a take-profit order.
- **takeProfitTriggerBy** (string) - The condition that triggers the take-profit.
- **triggerBy** (string) - The condition that triggers the order.
- **triggerPrice** (string) - The price that triggers the order.
- **triggerQuantity** (string) - The quantity related to the trigger.
- **triggeredAt** (integer) - The timestamp when the order was triggered.
- **relatedOrderId** (string) - The ID of a related order.
- **strategyId** (string) - The ID of the strategy associated with the order.
- **slippageTolerance** (string) - The acceptable slippage tolerance.
- **slippageToleranceType** (string) - The type of slippage tolerance.

#### Response Example
```json
{
  "orderType": "Market",
  "id": "string",
  "clientId": 0,
  "createdAt": 0,
  "executedQuantity": "string",
  "executedQuoteQuantity": "string",
  "quantity": "string",
  "quoteQuantity": "string",
  "reduceOnly": true,
  "timeInForce": "GTC",
  "selfTradePrevention": "RejectTaker",
  "side": "Bid",
  "status": "Cancelled",
  "stopLossTriggerPrice": "string",
  "stopLossLimitPrice": "string",
  "stopLossTriggerBy": "string",
  "symbol": "string",
  "takeProfitTriggerPrice": "string",
  "takeProfitLimitPrice": "string",
  "takeProfitTriggerBy": "string",
  "triggerBy": "string",
  "triggerPrice": "string",
  "triggerQuantity": "string",
  "triggeredAt": 0,
  "relatedOrderId": "string",
  "strategyId": "string",
  "slippageTolerance": "string",
  "slippageToleranceType": "TickSize"
}
```
```

--------------------------------

### GET /market

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Retrieves details for a specific market on the Backpack Exchange.  Specify the market ID to get detailed information about that market.

```APIDOC
## GET /market

### Description
Retrieves details for a specific market.

### Method
GET

### Endpoint
/market

### Parameters
#### Query Parameters
- **market_id** (string) - Required - The ID of the market to retrieve.

### Request Example
None

### Response
#### Success Response (200)
- **market** (object) - Market object containing details.

#### Response Example
{
  "market_id": "BTC_USDC",
  "base_currency": "BTC",
  "quote_currency": "USDC",
  "tick_size": 0.01,
  "lot_size": 0.0001
}

```

--------------------------------

### Account Settings API

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

This API allows for the retrieval and update of account settings, including auto-borrow, auto-lend, auto-repay, and leverage limits.

```APIDOC
## GET /api/v1/account/settings

### Description
Retrieves the current account settings.

### Method
GET

### Endpoint
/api/v1/account/settings

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **autoBorrowSettlements** (boolean) - If true, then tries to borrow during collateral reconciliation.
- **autoLend** (boolean) - Determines if the account should automatically lend.
- **autoRepayBorrows** (boolean) - Determines if the account should automatically repay borrows with available balance.
- **leverageLimit** (string) - Determines the maximum leverage allowed for the main account or subaccount.

#### Response Example
{
  "autoBorrowSettlements": true,
  "autoLend": false,
  "autoRepayBorrows": true,
  "leverageLimit": "10.0"
}

## PUT /api/v1/account/settings

### Description
Updates the account settings.

### Method
PUT

### Endpoint
/api/v1/account/settings

### Parameters
#### Request Body
- **autoBorrowSettlements** (boolean) - Optional. If true, then tries to borrow during collateral reconciliation.
- **autoLend** (boolean) - Optional. Determines if the account should automatically lend.
- **autoRepayBorrows** (boolean) - Optional. Determines if the account should automatically repay borrows with available balance.
- **leverageLimit** (string) - Optional. Determines the maximum leverage allowed for the main account or subaccount.

### Request Example
{
  "autoBorrowSettlements": false,
  "autoLend": true,
  "leverageLimit": "5.0"
}

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
{
  "message": "Account settings updated successfully."
}
```

--------------------------------

### Get Withdrawals Endpoint - API Path

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

This snippet shows the API path for retrieving withdrawal history. It is a GET request to the '/wapi/v1/capital/withdrawals' endpoint.

```text
get/wapi/v1/capital/withdrawals
```

--------------------------------

### POST /api/v1/strategy

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Submits a strategy to the engine for processing. Requires API key, signature, and timestamp in headers.

```APIDOC
## POST /api/v1/strategy

### Description
Submits a strategy to the engine for processing.

**Instruction:** `strategyCreate`

### Method
POST

### Endpoint
/api/v1/strategy

### Parameters
#### Header Parameters
- **X-API-KEY** (string) - Required - API key
- **X-SIGNATURE** (string) - Required - Signature of the request
- **X-TIMESTAMP** (integer) - Required - Timestamp of the request in milliseconds
- **X-WINDOW** (integer) - Optional - Time the request is valid for in milliseconds (default `5000`, maximum `60000`)
- **X-Broker-Id** (integer) - Optional - Broker ID

#### Request Body
- **StrategyCreatePayload** (object) - Required - Payload for creating a strategy.

### Request Example
```json
{
  "symbol": "BTC-USD",
  "strategyType": "limit",
  "side": "buy",
  "quantity": 0.001,
  "price": 50000
}
```

### Response
#### Success Response (200)
- **StrategyType** (object) - Strategy created successfully.

#### Error Responses
- **400** - Bad request.
- **500** - Internal server error.
- **503** - System under maintenance.

### Response Example (200 OK)
```json
{
  "strategyType": {
    "id": "857333759116174336",
    "clientStrategyId": 123,
    "symbol": "BTC-USD",
    "status": "active",
    "createdAt": "2023-01-01T10:00:00Z",
    "updatedAt": "2023-01-01T10:05:00Z"
  }
}
```
```

--------------------------------

### Get Deposits Endpoint - API Path

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

This snippet shows the API path for retrieving deposit history. It is a GET request to the '/wapi/v1/capital/deposits' endpoint.

```text
get/wapi/v1/capital/deposits
```

--------------------------------

### GET /api/v1/account/limits/borrow

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Get max borrow quantity. Retrieves the maximum quantity an account can borrow for a given asset based on existing exposure and margin requirements.

```APIDOC
## GET /api/v1/account/limits/borrow

### Description
Get max borrow quantity. Retrieves the maximum quantity an account can borrow for a given asset based on existing exposure and margin requirements.

### Method
GET

### Endpoint
/api/v1/account/limits/borrow

### Parameters
#### Header Parameters
- **X-API-KEY** (string) - Optional - API key
- **X-SIGNATURE** (string) - Optional - Signature of the request
- **X-TIMESTAMP** (integer) - Optional - Timestamp of the request in milliseconds
- **X-WINDOW** (integer) - Optional - Time the request is valid for in milliseconds (default `5000`, maximum `60000`)

#### Query Parameters
- **symbol** (string) - Optional - Trading pair symbol (e.g., BTC-PERPETUAL)

### Response
#### Success Response (200)
- Description: Success.

#### Error Responses
- **400**: Bad request.
- **401**: Unauthorized.
- **500**: Internal server error.
- **503**: System under maintenance.
```

--------------------------------

### POST /orderExecute

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Executes an order for the authenticated user.  This endpoint allows users to place buy or sell orders on the exchange.

```APIDOC
## POST /orderExecute

### Description
Executes an order for the authenticated user.

### Method
POST

### Endpoint
/orderExecute

### Parameters
#### Request Body
- **market_id** (string) - Required - The ID of the market to trade on.
- **side** (string) - Required - The side of the order (buy or sell).
- **type** (string) - Required - The type of the order (limit or market).
- **quantity** (number) - Required - The quantity of the order.
- **price** (number) - Optional - The price of the order (required for limit orders).

### Request Example
{
  "market_id": "BTC_USDC",
  "side": "buy",
  "type": "limit",
  "quantity": 0.01,
  "price": 29000.00
}

### Response
#### Success Response (200)
- **order_id** (string) - The ID of the executed order.

#### Response Example
{
  "order_id": "67890"
}

```

--------------------------------

### GET /wapi/v1/history/strategies

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Get strategy history. Retrieves the strategy history for the user. This returns strategies that are no longer active as they have either been completed, cancelled by the user or cancelled by the system.

```APIDOC
## GET /wapi/v1/history/strategies

### Description
Get strategy history. Retrieves the strategy history for the user. This returns strategies that are no longer active as they have either been completed, cancelled by the user or cancelled by the system.

### Method
GET

### Endpoint
/wapi/v1/history/strategies

### Parameters
#### Header Parameters
- **X-API-KEY** (string) - Optional - API key.
- **X-SIGNATURE** (string) - Optional - Signature of the request.
- **X-TIMESTAMP** (int64) - Optional - Timestamp of the request in milliseconds.
- **X-WINDOW** (uint64) - Optional - Time the request is valid for in milliseconds (default `5000`, maximum `60000`).

### Response
#### Success Response (200)
- **ACCESS-CONTROL-EXPOSE-HEADERS** (string) - Indicates which headers are accessible.
- **X-PAGE-COUNT** (uint64) - The total number of pages available.
- **X-CURRENT-PAGE** (uint64) - The current page number.
- **X-PAGE-SIZE** (uint64) - The number of items per page.
- **X-TOTAL** (uint64) - The total number of items available.

#### Response Example
```json
[
  {
    "id": "strat_abc",
    "name": "Trend Following",
    "status": "completed",
    "startTime": 1678886400000,
    "endTime": 1678972800000
  }
]
```
```

--------------------------------

### Get Deposit Address Endpoint - API Path

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

This snippet shows the API path for retrieving a user's deposit address. It is a GET request to the '/wapi/v1/capital/deposit/address' endpoint.

```text
get/wapi/v1/capital/deposit/address
```

--------------------------------

### GET /markets

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

Retrieves a list of all available markets. Funding rate bounds are now included in the market data.

```APIDOC
## GET /markets

### Description
Retrieves a list of all available trading markets. As of 2025-04-08, this endpoint includes funding rate lower and upper bounds for each market.

### Method
GET

### Endpoint
/markets

### Parameters
No parameters required.

### Request Example
```
GET /markets
```

### Response
#### Success Response (200)
- **markets** (array) - An array of market objects, each containing details like symbol, price, volume, and funding rate bounds.
  - **symbol** (string) - The trading symbol.
  - **price** (string) - The current price.
  - **volume** (string) - The trading volume.
  - **fundingRateLowerBound** (string) - The lower bound for the funding rate.
  - **fundingRateUpperBound** (string) - The upper bound for the funding rate.

#### Response Example
```json
{
  "markets": [
    {
      "symbol": "BTC_USDT",
      "price": "42000.00",
      "volume": "1000000.00",
      "fundingRateLowerBound": "-0.0001",
      "fundingRateUpperBound": "0.0001"
    }
  ]
}
```
```

--------------------------------

### GET /deposits - Optional from and to Timestamps

Source: https://github.com/backpack-exchange/bpx-openapi/blob/master/docs/index.html

The `get deposits` endpoint now supports optional `from` and `to` timestamp parameters. This allows users to filter deposit history within a specific date range.

```APIDOC
## GET /deposits

### Description
Retrieves deposit history. This endpoint now accepts optional `from` and `to` timestamp parameters to filter deposits within a specified time period.

### Method
GET

### Endpoint
`/deposits`

### Query Parameters
- **from** (integer) - Optional - Unix timestamp in milliseconds for the start of the period.
- **to** (integer) - Optional - Unix timestamp in milliseconds for the end of the period.

### Response Example (Filtered Deposits)
```json
{
  "deposits": [
    {
      "depositId": "dp456",
      "currency": "BTC",
      "amount": "0.5",
      "address": "btc_address...",
      "status": "completed",
      "timestamp": "1678886400000"
    }
  ]
}
```
```