Bybit

https://github.com/suenot/bybit-docs-markdown
Admin
This project provides comprehensive documentation for the Bybit API v5, covering REST and WebSocket...
Tokens:59,095
Snippets:408
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Implementation Example (Python)

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/websocket/public/trade.md

Example of initializing a WebSocket connection and subscribing to the trade stream using the pybit library.

```python
from pybit.unified_trading import WebSocket
from time import sleep

def process_trade(message):
    """Process trade messages"""
    if message["type"] == "snapshot":
        for trade in message["data"]:
            print(f"""
                Trade Details:
                Symbol: {trade['s']}
                Price: {trade['p']}
                Size: {trade['v']}
                Side: {trade['S']}
                Time: {trade['T']}
                ID: {trade['i']}
            """)

# Initialize WebSocket connection
ws = WebSocket(
    testnet=True,
    channel_type="linear",
)

# Subscribe to trade stream
ws.trade_stream(
    symbol="BTCUSDT",
    callback=process_trade
)

# Keep connection alive
while True:
    sleep(1)
```

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

### Install Bybit Node.js SDK

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/nodejs.md

Use npm to install the official SDK package.

```bash
npm install --save bybit-api
```

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

### Go SDK Installation

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/go.md

Add the SDK to your go.mod file.

```go
require github.com/bybit-exchange/bybit.go.api latest
```

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

### Install pybit SDK

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/python.md

Use pip to install the pybit library. Requires Python 3.9.1 or higher.

```bash
pip install pybit
```

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

### Retrieve Options Positions via HTTP Request

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/options/account/positions.md

Example of a GET request to fetch options positions with authentication headers.

```http
GET /v5/option/position/list?category=option&baseCoin=BTC HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672132480085
X-BAPI-RECV-WINDOW: 5000
```

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

### Install Bybit C# SDK

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/csharp.md

Methods to add the bybit.net.api package to your .NET project.

```bash
dotnet add package bybit.net.api
```

```powershell
NuGet\Install-Package bybit.net.api
```

```xml
<PackageReference Include="bybit.net.api"/>
```

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

### Get Instruments Info Response

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/options/market.md

Example JSON response containing instrument details such as strike price, leverage filters, and lot size limits.

```json
{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "category": "option",
        "list": [
            {
                "symbol": "BTC-30DEC22-18000-C",
                "optionsType": "Call",
                "status": "Trading",
                "baseCoin": "BTC",
                "quoteCoin": "USD",
                "settleCoin": "USDC",
                "launchTime": "1672214400000",
                "deliveryTime": "1672387200000",
                "expiryPrice": "16500",
                "strikePrice": "18000",
                "leverageFilter": {
                    "minLeverage": "1",
                    "maxLeverage": "10",
                    "leverageStep": "0.1"
                },
                "priceFilter": {
                    "minPrice": "0.1",
                    "maxPrice": "10000",
                    "tickSize": "0.1"
                },
                "lotSizeFilter": {
                    "maxOrderQty": "200",
                    "minOrderQty": "0.01",
                    "qtyStep": "0.01"
                }
            }
        ]
    }
}
```

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

### HTTP Request for Transaction Log

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/account/transaction-log.md

Example of a GET request to retrieve transaction logs for a Unified account with spot category and USDT currency.

```http
GET /v5/account/transaction-log?accountType=UNIFIED&category=spot&currency=USDT HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672132480085
X-BAPI-RECV-WINDOW: 5000
```

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

### HTTP Request for Position List

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/derivatives/account/position-info.md

Example of a GET request to retrieve position data for a specific symbol.

```http
GET /v5/position/list?category=linear&symbol=BTCUSDT HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672132480085
X-BAPI-RECV-WINDOW: 5000
```

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

### Install Bybit Java SDK

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/java.md

Add the dependency to your project using Maven or Gradle.

```xml
<dependency>
    <groupId>io.github.wuhewuhe</groupId>
    <artifactId>bybit-java-api</artifactId>
    <version>1.2.8</version>
</dependency>
```

```groovy
implementation group: 'io.github.wuhewuhe', name: 'bybit-java-api', version: '1.2.8'
```

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

### Response Example

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/trade/cancel-order.md

Example JSON response returned by the API upon a successful cancellation request.

```json
{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "orderId": "1523347543495541248",
        "orderLinkId": "spot-test-cancel"
    }
}
```

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

### HTTP Request for Wallet Balance

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/account/wallet-balance.md

Example of a GET request to retrieve wallet balance for a UNIFIED account filtered by USDT.

```http
GET /v5/account/wallet-balance?accountType=UNIFIED&coin=USDT HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672132480085
X-BAPI-RECV-WINDOW: 5000
```

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

### GET /v5/market/instruments-info

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/copy-trading/api-endpoints.md

Get the list of symbols that support copy trading.

```APIDOC
## GET /v5/market/instruments-info

### Description
Get the list of symbols that support copy trading.

### Method
GET

### Endpoint
/v5/market/instruments-info

### Parameters
#### Query Parameters
- **category** (string) - Required - Product type. Use `linear`
- **symbol** (string) - Optional - Symbol name, e.g., `BTCUSDT`

### Response
#### Success Response (200)
- **list** (array) - List of symbols
- **list.symbol** (string) - Symbol name
- **list.copyTrading** (string) - Whether copy trading is supported. `1`: supported, `0`: not supported
```

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

### Example Response

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/websocket/public/trade.md

A sample JSON response received from the trade stream.

```json
{
    "topic": "publicTrade.BTCUSDT",
    "type": "snapshot",
    "ts": 1672304486868,
    "data": [
        {
            "T": 1672304486865,
            "s": "BTCUSDT",
            "S": "Buy",
            "v": "0.001",
            "p": "16578.50",
            "L": "PlusTick",
            "i": "20f43950-d8dd-5b31-9112-a178eb6023af",
            "BT": false
        }
    ]
}
```

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

### API Response Example

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/trade/get-order.md

Sample JSON structure returned by the order query endpoint.

```json
{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "list": [
            {
                "orderId": "1321003749386327552",
                "orderLinkId": "spot-test-order",
                "symbol": "BTCUSDT",
                "price": "35000",
                "qty": "0.001",
                "side": "Buy",
                "isLeverage": "0",
                "orderStatus": "New",
                "cancelType": "UNKNOWN",
                "rejectReason": "EC_NoError",
                "avgPrice": "",
                "leavesQty": "0.001",
                "leavesValue": "35",
                "cumExecQty": "0",
                "cumExecValue": "0",
                "cumExecFee": "0",
                "timeInForce": "GTC",
                "orderType": "LIMIT",
                "stopOrderType": "UNKNOWN",
                "orderIv": "",
                "triggerPrice": "",
                "takeProfit": "",
                "stopLoss": "",
                "tpTriggerBy": "",
                "slTriggerBy": "",
                "createTime": "1672506400000",
                "updateTime": "1672506400000"
            }
        ]
    }
}
```

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

### Query Order History with Python

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/trade/order-history.md

Demonstrates how to authenticate and send a GET request to the order history endpoint.

```python
import requests
import time
import hashlib
import hmac

# Authentication
api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"
timestamp = str(int(time.time() * 1000))
recv_window = "5000"

# Request parameters
params = {
    "category": "spot",
    "symbol": "BTCUSDT",
    "limit": 50,
    "orderStatus": "Filled"
}

# Generate signature
param_str = timestamp + api_key + recv_window + str(params)
signature = hmac.new(
    bytes(api_secret, "utf-8"),
    param_str.encode("utf-8"),
    hashlib.sha256
).hexdigest()

# Headers
headers = {
    "X-BAPI-API-KEY": api_key,
    "X-BAPI-SIGN": signature,
    "X-BAPI-TIMESTAMP": timestamp,
    "X-BAPI-RECV-WINDOW": recv_window,
    "Content-Type": "application/json"
}

# Send request
response = requests.get(
    "https://api-testnet.bybit.com/v5/order/history",
    headers=headers,
    params=params
)

print(response.json())
```

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

### GET /v5/market/instruments-info

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/options/market.md

Retrieves detailed information about available options instruments.

```APIDOC
## GET /v5/market/instruments-info

### Description
Get detailed information about available options instruments.

### Method
GET

### Endpoint
/v5/market/instruments-info

### Parameters
#### Query Parameters
- **category** (string) - Required - Must be "option"
- **symbol** (string) - Optional - Symbol name
- **baseCoin** (string) - Optional - Base coin. Default: BTC
- **limit** (integer) - Optional - Limit for data size. [1, 1000]. Default: 500
- **cursor** (string) - Optional - Cursor for pagination

### Response
#### Success Response (200)
- **retCode** (integer) - Status code
- **retMsg** (string) - Status message
- **result** (object) - Instrument information list

#### Response Example
{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "category": "option",
        "list": [
            {
                "symbol": "BTC-30DEC22-18000-C",
                "optionsType": "Call",
                "status": "Trading",
                "baseCoin": "BTC",
                "quoteCoin": "USD",
                "settleCoin": "USDC",
                "launchTime": "1672214400000",
                "deliveryTime": "1672387200000",
                "expiryPrice": "16500",
                "strikePrice": "18000",
                "leverageFilter": {
                    "minLeverage": "1",
                    "maxLeverage": "10",
                    "leverageStep": "0.1"
                },
                "priceFilter": {
                    "minPrice": "0.1",
                    "maxPrice": "10000",
                    "tickSize": "0.1"
                },
                "lotSizeFilter": {
                    "maxOrderQty": "200",
                    "minOrderQty": "0.01",
                    "qtyStep": "0.01"
                }
            }
        ]
    }
}
```

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

### Set Leverage HTTP Request

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/derivatives/account/set-leverage.md

Example of a POST request to set leverage for a specific symbol.

```http
POST /v5/position/set-leverage HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672132480085
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json

{
    "category": "linear",
    "symbol": "BTCUSDT",
    "buyLeverage": "10",
    "sellLeverage": "10"
}
```

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

### Order Update Stream Example

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/copy-trading/websocket.md

Conceptual structure of an order update message received from the stream.

```json
{
    "topic": "order.linear",
    "type": "snapshot", // or "delta"
    "ts": 1672304486868,
    "data": [
         {
            "symbol": "BTCUSDT",
            "category": "linear",
            "orderId": "1234567890",
            "side": "Buy",
            "orderType": "Limit",
            "price": "29000",
            "qty": "0.1",
            "orderStatus": "Filled",
            // ... other standard order fields
            "createTime": "1672132480085"
        }
    ]
}
```

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

### Get Copy Trading Symbols HTTP Request

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/copy-trading/api-endpoints.md

Example of a GET request to retrieve symbols that support copy trading.

```http
GET /v5/market/instruments-info?category=linear HTTP/1.1
Host: api.bybit.com
```

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

### Get Margin Info HTTP Request

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/margin/margin-info.md

Example of an HTTP GET request to retrieve margin trading data for a specific coin and VIP level.

```http
GET /v5/spot-cross-margin-trade/data?coin=BTC&vipLevel=VIP1 HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672132480085
X-BAPI-RECV-WINDOW: 5000
```

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

### Get Historical Volatility Response

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/options/market.md

Example JSON response for the historical volatility request.

```json
{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "category": "option",
        "list": [
            {
                "period": 7,
                "value": "0.7",
                "time": "1672764000000"
            }
        ]
    }
}
```

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

### Initialize Bybit HTTP Client

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/go.md

Configure the client for mainnet or testnet environments with optional timeout and debug settings.

```go
import "github.com/bybit-exchange/bybit.go.api"

// Create client for mainnet
client := bybit.NewBybitHttpClient(
    "YOUR_API_KEY",
    "YOUR_API_SECRET",
    bybit.WithBaseURL(bybit.MAINNET)
)

// For testnet
testnetClient := bybit.NewBybitHttpClient(
    "YOUR_API_KEY",
    "YOUR_API_SECRET",
    bybit.WithBaseURL(bybit.TESTNET)
)

// Optional: Configure client options
client.WithTimeout(5 * time.Second)  // Set request timeout
client.WithDebug(true)  // Enable debug logging
```

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

### Get Margin Info JSON Response

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/margin/margin-info.md

Example of the JSON response structure returned by the margin info endpoint.

```json
{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "vipCoinList": [
            {
                "list": [
                    {
                        "borrowable": true,
                        "collateralRatio": "0.95",
                        "coin": "BTC",
                        "hourlyBorrowRate": "0.000003964522",
                        "liquidationOrder": "2",
                        "marginCollateral": true,
                        "maxBorrowingAmount": "5"
                    }
                ],
                "vipLevel": "VIP1"
            }
        ]
    },
    "retExtInfo": {},
    "time": 1672132480085
}
```

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

### HTTP Request for Settlement History

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/options/account/settlement.md

Example of a GET request to retrieve settlement records for a specific option symbol.

```http
GET /v5/option/settlement?category=option&symbol=BTC-24MAR23-16000-P HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672132480085
X-BAPI-RECV-WINDOW: 5000
```

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

### Initialize Bybit REST Clients

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/csharp.md

Configure services for mainnet, testnet, or public market data access.

```csharp
// For mainnet
var tradeService = new BybitTradeService(
    apiKey: "YOUR_API_KEY",
    apiSecret: "YOUR_API_SECRET"
);

// For testnet
var testnetTradeService = new BybitTradeService(
    apiKey: "YOUR_API_KEY",
    apiSecret: "YOUR_API_SECRET",
    useTestnet: true
);

// For public endpoints only
var marketService = new BybitMarketDataService();
```

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

### Client Initialization

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/go.md

Initialize the Bybit HTTP client for either mainnet or testnet environments with optional configuration.

```APIDOC
## bybit.NewBybitHttpClient

### Description
Creates a new Bybit HTTP client instance for interacting with the API.

### Usage
```go
client := bybit.NewBybitHttpClient("YOUR_API_KEY", "YOUR_API_SECRET", bybit.WithBaseURL(bybit.MAINNET))
```
```

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

### Place a Limit Order in Python

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/trade/place-order.md

Demonstrates the full request lifecycle including authentication, signature generation, and order submission.

```python
import requests
import time
import hashlib
import hmac

# Authentication
api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"
timestamp = str(int(time.time() * 1000))
recv_window = "5000"

# Request parameters
params = {
    "category": "spot",
    "symbol": "BTCUSDT",
    "side": "Buy",
    "orderType": "Limit",
    "qty": "0.001",
    "price": "35000",
    "timeInForce": "GTC",
    "orderLinkId": "spot-test-limit"
}

# Generate signature
param_str = timestamp + api_key + recv_window + str(params)
signature = hmac.new(
    bytes(api_secret, "utf-8"),
    param_str.encode("utf-8"),
    hashlib.sha256
).hexdigest()

# Headers
headers = {
    "X-BAPI-API-KEY": api_key,
    "X-BAPI-SIGN": signature,
    "X-BAPI-TIMESTAMP": timestamp,
    "X-BAPI-RECV-WINDOW": recv_window,
    "Content-Type": "application/json"
}

# Send request
response = requests.post(
    "https://api-testnet.bybit.com/v5/order/create",
    headers=headers,
    json=params
)

print(response.json())
```

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

### Get Kline Response Structure

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/options/market.md

Example JSON response returned by the kline endpoint containing symbol, category, and list of kline data points.

```json
{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "symbol": "BTC-30DEC22-18000-C",
        "category": "option",
        "list": [
            [
                "1672502400000", // Start time
                "150.0",    // Open price
                "155.5",    // High price
                "148.0",    // Low price
                "152.5",    // Close price
                "100.0",    // Volume
                "15250.0"  // Turnover
            ]
        ]
    },
    "retExtInfo": {},
    "time": 1672764159969
}
```

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

### Initialize Bybit API Client

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/java.md

Configure the client for mainnet, testnet, or public-only access.

```java
// Create client for mainnet
var client = BybitApiClientFactory.newInstance(
    "YOUR_API_KEY",
    "YOUR_API_SECRET",
    BybitApiConfig.MAINNET_DOMAIN,
    true  // Enable debug mode
).newAsyncTradeRestClient();

// For testnet
var testnetClient = BybitApiClientFactory.newInstance(
    "YOUR_API_KEY",
    "YOUR_API_SECRET",
    BybitApiConfig.TESTNET_DOMAIN,
    true
).newAsyncTradeRestClient();

// For public endpoints only
var publicClient = BybitApiClientFactory.newInstance(
    BybitApiConfig.MAINNET_DOMAIN,
    true
).newMarketDataRestClient();
```

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

### GET /v5/market/kline

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/market.md

Get kline/candlestick data.

```APIDOC
## GET /v5/market/kline

### Description
Get kline/candlestick data.

### Method
GET

### Endpoint
/v5/market/kline

### Parameters
#### Query Parameters
- **category** (string) - Required - Must be "spot"
- **symbol** (string) - Required - Symbol name
- **interval** (string) - Required - Kline interval. 1,3,5,15,30,60,120,240,360,720,D,M,W
- **start** (integer) - Optional - Start timestamp (ms)
- **end** (integer) - Optional - End timestamp (ms)
- **limit** (integer) - Optional - Limit for data size. [1, 1000]. Default: 200

### Response
#### Success Response (200)
- **retCode** (integer) - Response code
- **retMsg** (string) - Response message
- **result** (object) - Response data
```

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

### Initialize REST API Client

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/nodejs.md

Configure the RestClientV5 for mainnet, testnet, or public-only access. Custom configurations like recv_window and time synchronization can be applied during instantiation.

```javascript
const { RestClientV5 } = require('bybit-api');

// Create client for mainnet
const client = new RestClientV5({
    key: 'YOUR_API_KEY',
    secret: 'YOUR_API_SECRET',
    testnet: false,
    recv_window: 5000,                // Optional: custom recv_window
    enable_time_sync: true,           // Optional: auto-sync time
    strict_param_validation: true,     // Optional: enable strict validation
    baseUrl: 'https://api.bybit.com'  // Optional: custom base URL
});

// For testnet
const testnetClient = new RestClientV5({
    key: 'YOUR_API_KEY',
    secret: 'YOUR_API_SECRET',
    testnet: true
});

// For public-only API calls, you can skip the key and secret
const publicClient = new RestClientV5({});
```

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

### GET /v5/market/recent-trade

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/market.md

Get recent trades data.

```APIDOC
## GET /v5/market/recent-trade

### Description
Get recent trades data.

### Method
GET

### Endpoint
/v5/market/recent-trade

### Parameters
#### Query Parameters
- **category** (string) - Required - Must be "spot"
- **symbol** (string) - Required - Symbol name
- **limit** (integer) - Optional - Limit for data size. [1, 1000]. Default: 25

### Response
#### Success Response (200)
- **retCode** (integer) - Response code
- **retMsg** (string) - Response message
- **result** (object) - Response data
```

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

### Configure Bybit Java Client Options

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/java.md

Defines the required fields for initializing the Bybit client and WebSocket connection settings.

```java
// Client factory options
private final String apiKey;        // Your API key
private final String secret;        // Your API secret
private final String baseUrl;       // API base URL
private final Boolean debugMode;    // Enable debug logging
private final String logOption;     // Logging options
private final Long recvWindow;      // Receive window
private final String referer;       // Referer header

// WebSocket client options
private final Integer pingInterval; // WebSocket ping interval
private final String maxAliveTime; // Max alive time for private channels (seconds/minutes)
```

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

### WebSocket Authentication and Subscription in Python

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/authentication.md

A complete example demonstrating signature generation, authentication, and subscription to private topics using the websocket-client library.

```python
import hmac
import time
import json
import websocket

def generate_ws_signature(api_key, api_secret):
    """
    Generate WebSocket authentication signature
    :param api_key: Your API key
    :param api_secret: Your API secret
    :return: Dict with authentication message
    """
    expires = int((time.time() + 1) * 1000)
    signature = hmac.new(
        bytes(api_secret, "utf-8"),
        bytes(f"GET/realtime{expires}", "utf-8"),
        hashlib.sha256
    ).hexdigest()
    
    return {
        "req_id": str(int(time.time() * 1000)),
        "op": "auth",
        "args": [api_key, expires, signature]
    }

def on_message(ws, message):
    print(f"Received: {message}")

def on_error(ws, error):
    print(f"Error: {error}")

def on_close(ws, close_status_code, close_msg):
    print("WebSocket connection closed")

def on_open(ws):
    print("WebSocket connection opened")
    # Authenticate
    auth_data = generate_ws_signature(api_key, api_secret)
    ws.send(json.dumps(auth_data))
    
    # Subscribe to private topics after successful authentication
    subscribe_msg = {
        "req_id": str(int(time.time() * 1000)),
        "op": "subscribe",
        "args": ["order", "position"]
    }
    ws.send(json.dumps(subscribe_msg))

# Create WebSocket connection
ws = websocket.WebSocketApp(
    url="wss://stream.bybit.com/v5/private",
    on_message=on_message,
    on_error=on_error,
    on_close=on_close,
    on_open=on_open
)

# Start WebSocket connection
ws.run_forever()
```

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

### GET /v5/market/orderbook

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/market.md

Get order book data.

```APIDOC
## GET /v5/market/orderbook

### Description
Get order book data.

### Method
GET

### Endpoint
/v5/market/orderbook

### Parameters
#### Query Parameters
- **category** (string) - Required - Must be "spot"
- **symbol** (string) - Required - Symbol name
- **limit** (integer) - Optional - Limit for data size. [1, 200]. Default: 25

### Response
#### Success Response (200)
- **retCode** (integer) - Response code
- **retMsg** (string) - Response message
- **result** (object) - Response data
```

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

### GET /v5/market/instruments-info

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/market.md

Get detailed information about available trading pairs.

```APIDOC
## GET /v5/market/instruments-info

### Description
Get detailed information about available trading pairs.

### Method
GET

### Endpoint
/v5/market/instruments-info

### Parameters
#### Query Parameters
- **category** (string) - Required - Must be "spot"
- **symbol** (string) - Optional - Symbol name, e.g., "BTCUSDT"
- **status** (string) - Optional - Default: "Trading"

### Response
#### Success Response (200)
- **retCode** (integer) - Response code
- **retMsg** (string) - Response message
- **result** (object) - Response data
```

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

### POST /v5/order/create

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/trade/place-order.md

Create a new spot trading order.

```APIDOC
## POST /v5/order/create

### Description
Create a new spot trading order.

### Method
POST

### Endpoint
/v5/order/create

### Parameters
#### Request Parameters
- **category** (string) - Required - Product type. For spot trading: `spot`
- **symbol** (string) - Required - Trading pair name, e.g., `BTCUSDT`
- **side** (string) - Required - Order side: `Buy` or `Sell`
- **orderType** (string) - Required - Order type: `Market` or `Limit`
- **qty** (string) - Required - Order quantity. For Market Buy orders, by default in quote currency
- **marketUnit** (string) - Optional - For Market orders only. Unit for qty: `baseCoin` or `quoteCoin`
- **price** (string) - Optional - Order price. Required for Limit orders
- **timeInForce** (string) - Optional - Time in force. Default: `GTC`. Options: `GTC`, `IOC`, `FOK`, `PostOnly`
- **orderLinkId** (string) - Optional - Custom order ID. Max 36 characters
- **isLeverage** (integer) - Optional - For margin trading: `0` (spot), `1` (margin)
- **orderFilter** (string) - Optional - Order filter: `Order` (default), `tpslOrder` (TP/SL), `StopOrder` (conditional)
- **triggerPrice** (string) - Optional - Trigger price for TP/SL and conditional orders
- **takeProfit** (string) - Optional - Take profit price. UTA only
- **stopLoss** (string) - Optional - Stop loss price. UTA only

### Response
#### Success Response (200)
- **orderId** (string) - Order ID
- **orderLinkId** (string) - Custom order ID
- **symbol** (string) - Trading pair name
- **createTime** (string) - Order creation timestamp
- **orderPrice** (string) - Order price
- **orderQty** (string) - Order quantity
- **orderType** (string) - Order type
- **side** (string) - Order side
- **status** (string) - Order status
- **timeInForce** (string) - Time in force
- **accountId** (string) - Account ID
- **execQty** (string) - Executed quantity
- **triggerPrice** (string) - Trigger price if applicable
```

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

### Initialize REST API Session

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/python.md

Create an HTTP session for either mainnet or testnet using your API credentials.

```python
from pybit.unified_trading import HTTP

# Create session for mainnet
session = HTTP(
    testnet=False,
    api_key="your_api_key",
    api_secret="your_api_secret"
)

# For testnet
testnet_session = HTTP(
    testnet=True,
    api_key="your_api_key",
    api_secret="your_api_secret"
)
```

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

### Options Account Info Response Structure

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/options/account/account-info.md

Example JSON response containing account-level metrics and base coin details.

```json
{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "unifiedMarginStatus": 3,
        "marginMode": "PORTFOLIO_MARGIN",
        "optionsEnabled": true,
        "totalEquity": "1000.00",
        "totalWalletBalance": "980.00",
        "totalUnrealizedProfit": "20.00",
        "totalPnl": "120.00",
        "totalMaintenanceMargin": "50.00",
        "totalInitialMargin": "100.00",
        "totalAvailableBalance": "880.00",
        "baseCoin": [
            {
                "coin": "BTC",
                "equity": "1.00",
                "usdValue": "40000.00",
                "walletBalance": "0.98",
                "unrealizedPnl": "0.02",
                "realizedPnl": "0.10",
                "cumRealisedPnl": "1.50",
                "marginBalance": "1.00",
                "availableBalance": "0.88",
                "marginRate": "0.1",
                "maintenanceMargin": "0.05",
                "initialMargin": "0.10"
            }
        ]
    },
    "retExtInfo": {},
    "time": 1672132480085
}
```

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

### Spot Order Response Example

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/trade/place-order.md

The standard JSON response structure returned after successfully placing a spot order.

```json
{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "orderId": "1321003749386327552",
        "orderLinkId": "spot-test-limit"
    }
}
```

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

### Retrieve Options Account Info via HTTP

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/options/account/account-info.md

Example request for fetching account information filtered by a specific base coin.

```http
GET /v5/account/info?baseCoin=BTC HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: XXXXX
X-BAPI-TIMESTAMP: 1672132480085
X-BAPI-RECV-WINDOW: 5000
```

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

### Get Risk Limit Info Endpoint

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/derivatives/market.md

HTTP GET request to retrieve risk limit information for derivatives contracts.

```http
GET /v5/market/risk-limit-info
```

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

### HTTP Session Initialization

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/python.md

Initializes the HTTP session for interacting with Bybit's mainnet or testnet environments.

```APIDOC
## HTTP Session Initialization

### Description
Creates a session object to authenticate and communicate with the Bybit API.

### Method
`pybit.unified_trading.HTTP`

### Parameters
- **testnet** (bool) - Required - Set to True for testnet, False for mainnet.
- **api_key** (string) - Optional - Your API key.
- **api_secret** (string) - Optional - Your API secret.
```

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

### Get Index Price Kline Endpoint

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/derivatives/market.md

HTTP GET request to retrieve historical index price kline data.

```http
GET /v5/market/index-price-kline
```

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

### Authentication Process in Python

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/websocket/connect.md

Demonstrates generating a signature and sending an authentication request via a WebSocket connection.

```python
import hmac
import json
import time
import websocket

api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"

# Generate expires timestamp
expires = int((time.time() + 1) * 1000)

# Generate signature
signature = str(hmac.new(
    bytes(api_secret, "utf-8"),
    bytes(f"GET/realtime{expires}", "utf-8"),
    digestmod="sha256"
).hexdigest())

# Create WebSocket connection
ws = websocket.WebSocketApp(
    url="YOUR_WEBSOCKET_URL",
    # ... other parameters ...
)

# Send authentication request
ws.send(
    json.dumps({
        "op": "auth",
        "args": [api_key, expires, signature]
    })
)
```

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

### Get Mark Price Kline Endpoint

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/derivatives/market.md

HTTP GET request to retrieve historical mark price kline data.

```http
GET /v5/market/mark-price-kline
```

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

### GET /v5/market/tickers

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/market.md

Get latest price snapshot, best bid/ask price, and trading volume in the last 24 hours.

```APIDOC
## GET /v5/market/tickers

### Description
Get latest price snapshot, best bid/ask price, and trading volume in the last 24 hours.

### Method
GET

### Endpoint
/v5/market/tickers

### Parameters
#### Query Parameters
- **category** (string) - Required - Must be "spot"
- **symbol** (string) - Optional - Symbol name, e.g., "BTCUSDT"

### Response
#### Success Response (200)
- **retCode** (integer) - Response code
- **retMsg** (string) - Response message
- **result** (object) - Response data
```

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

### Get Premium Index Price Kline Endpoint

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/derivatives/market.md

HTTP GET request to retrieve historical premium index price kline data.

```http
GET /v5/market/premium-index-price-kline
```

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

### Query Open Orders with Python

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/spot/trade/open-orders.md

Uses the requests library to authenticate and fetch open orders from the Bybit testnet.

```python
import requests
import time
import hashlib
import hmac

# Authentication
api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"
timestamp = str(int(time.time() * 1000))
recv_window = "5000"

# Request parameters
params = {
    "category": "spot",
    "symbol": "BTCUSDT",
    "limit": 50,
    "openOnly": 0
}

# Generate signature
param_str = timestamp + api_key + recv_window + str(params)
signature = hmac.new(
    bytes(api_secret, "utf-8"),
    param_str.encode("utf-8"),
    hashlib.sha256
).hexdigest()

# Headers
headers = {
    "X-BAPI-API-KEY": api_key,
    "X-BAPI-SIGN": signature,
    "X-BAPI-TIMESTAMP": timestamp,
    "X-BAPI-RECV-WINDOW": recv_window,
    "Content-Type": "application/json"
}

# Send request
response = requests.get(
    "https://api-testnet.bybit.com/v5/order/realtime",
    headers=headers,
    params=params
)

print(response.json())
```

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

### GET /v5/market/historical-volatility

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/options/market.md

Queries historical volatility data for options.

```APIDOC
## GET /v5/market/historical-volatility

### Description
Query option historical volatility.

### Method
GET

### Endpoint
/v5/market/historical-volatility

### Parameters
#### Query Parameters
- **category** (string) - Required - Must be "option"
- **baseCoin** (string) - Optional - Base coin. Default: BTC
- **quoteCoin** (string) - Optional - Quote coin. USD or USDT. Default: USD
- **period** (integer) - Optional - Period. Default: 7 days
- **startTime** (integer) - Optional - Start timestamp (ms)
- **endTime** (integer) - Optional - End timestamp (ms)

### Response
#### Success Response (200)
- **retCode** (integer) - Status code
- **retMsg** (string) - Status message
- **result** (object) - Historical volatility data list

#### Response Example
{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "category": "option",
        "list": [{
            "period": 7,
            "value": "0.7",
            "time": "1672764000000"
        }]
    }
}
```

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

### RestClientV5 Initialization

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/sdk/nodejs.md

Initializes the Bybit REST API client for mainnet, testnet, or public-only access.

```APIDOC
## Client Initialization

### Description
Initializes the `RestClientV5` client. You can provide API keys for authenticated requests or initialize without them for public-only data.

### Method
`new RestClientV5(options)`

### Parameters
- **key** (string) - Optional - API Key
- **secret** (string) - Optional - API Secret
- **testnet** (boolean) - Optional - Use testnet environment
- **recv_window** (number) - Optional - Custom receive window
- **enable_time_sync** (boolean) - Optional - Auto-sync time
- **strict_param_validation** (boolean) - Optional - Enable strict validation
- **baseUrl** (string) - Optional - Custom base URL
```

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

### POST /v5/order/create

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/copy-trading/api-endpoints.md

Place a copy trading order to follow a Master Trader's position.

```APIDOC
## POST /v5/order/create

### Description
Place a copy trading order to follow a Master Trader's position.

### Method
POST

### Endpoint
/v5/order/create

### Parameters
#### Request Body
- **category** (string) - Required - Product type. Use `linear`
- **symbol** (string) - Required - Symbol name, e.g., `BTCUSDT`
- **side** (string) - Required - Order side. `Buy`, `Sell`
- **orderType** (string) - Required - Order type. `Market`, `Limit`
- **qty** (string) - Required - Order quantity
- **price** (string) - Optional - Order price. Required for `Limit` orders
- **timeInForce** (string) - Required - Time in force. `GTC`, `IOC`, `FOK`, `PostOnly`
- **positionIdx** (integer) - Required - Position index. `0`: One-Way Mode, `1`: Buy side of Hedge Mode, `2`: Sell side of Hedge Mode
- **takeProfit** (string) - Optional - Take profit price
- **stopLoss** (string) - Optional - Stop loss price

### Response
#### Success Response (200)
- **orderId** (string) - Order ID
- **orderLinkId** (string) - Custom order ID
```

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

### GET /v5/market/delivery-price

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/derivatives/market.md

Retrieves the delivery price for options and futures contracts.

```APIDOC
## GET /v5/market/delivery-price

### Description
Get delivery price for options and futures.

### Method
GET

### Endpoint
/v5/market/delivery-price

### Parameters
#### Query Parameters
- **category** (string) - Required - linear for USDT/USDC Futures, inverse for Inverse Futures, option for Options
- **symbol** (string) - Optional - Symbol name
- **baseCoin** (string) - Optional - Base coin, e.g., BTC. For option category only
- **limit** (integer) - Optional - Limit for data size. Default: 50
- **cursor** (string) - Optional - Cursor for pagination

### Response
#### Success Response (200)
- **retCode** (integer) - Status code
- **retMsg** (string) - Status message
- **result** (object) - Response data

#### Response Example
{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "category": "linear",
        "nextPageCursor": "...",
        "list": [
            {
                "symbol": "BTCUSDT",
                "deliveryPrice": "16500.00",
                "deliveryTime": "1672387200000"
            }
        ]
    },
    "retExtInfo": {},
    "time": 1672764159969
}
```

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

### GET /v5/market/risk-limit-info

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/derivatives/market.md

Retrieves risk limit information for derivatives contracts.

```APIDOC
## GET /v5/market/risk-limit-info

### Description
Get risk limit information for derivatives contracts.

### Method
GET

### Endpoint
/v5/market/risk-limit-info

### Parameters
#### Query Parameters
- **category** (string) - Required - `linear` for USDT/USDC, `inverse` for Inverse
- **symbol** (string) - Required - Symbol name

### Response
#### Success Response (200)
- **retCode** (integer) - Response code
- **retMsg** (string) - Response message
- **result** (object) - Data result containing category and list of risk limit info

#### Response Example
{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "category": "linear",
        "list": [
            {
                "id": 1,
                "symbol": "BTCUSDT",
                "riskLimitValue": "2000000",
                "maintenanceMargin": "0.005",
                "initialMargin": "0.01",
                "isLowestRisk": 1,
                "maxLeverage": "100.00"
            }
        ]
    },
    "retExtInfo": {},
    "time": 1672764159969
}
```

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

### Subscribe to Wallet Updates in Python

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/websocket/private/wallet.md

Uses the pybit library to establish a WebSocket connection and process real-time wallet data, including account-wide equity and individual coin balances.

```python
from pybit.unified_trading import WebSocket
from time import sleep

def process_wallet_update(message):
    """Process wallet update messages"""
    data = message["data"]
    
    # Process account-wide information
    print(f"""
        Account Status:
        Total Equity: ${data['totalEquity']}
        Wallet Balance: ${data['totalWalletBalance']}
        Available Balance: ${data['totalAvailableBalance']}
        Unrealized PnL: ${data['totalPerpUPL']}
        Initial Margin Rate: {data['accountIMRate']}%
        Maintenance Margin Rate: {data['accountMMRate']}%
    """)

    # Process individual coins
    for coin in data["coin"]:
        process_coin_status(coin)

def process_coin_status(coin):
    """Process individual coin status"""
    print(f"""
        Coin: {coin['coin']}
        Balance: {coin['walletBalance']}
        USD Value: ${coin['usdValue']}
        Available to Withdraw: {coin['availableToWithdraw']}
        Borrowed: {coin['borrowAmount']}
        Unrealized PnL: {coin['unrealisedPnl']}
    """)

    # Monitor margin levels
    if float(coin['totalPositionIM']) > 0:
        margin_ratio = float(coin['walletBalance']) / float(coin['totalPositionIM'])
        print(f"Margin Ratio: {margin_ratio}")

    # Check collateral status
    if coin['marginCollateral']:
        print(f"Collateral Status: Active (Platform: {coin['collateralSwitch']})")

def monitor_risk_levels(data):
    """Monitor account risk levels"""
    if float(data['accountIMRate']) > 0.8:
        print("Warning: High initial margin usage")
    if float(data['accountMMRate']) > 0.5:
        print("Warning: High maintenance margin usage")

# Initialize WebSocket connection
ws = WebSocket(
    testnet=True,
    api_key="YOUR_API_KEY",
    api_secret="YOUR_API_SECRET"
)

# Subscribe to wallet updates
ws.wallet_stream(
    callback=process_wallet_update
)

# Keep connection alive
while True:
    sleep(1)
```

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

### Get Historical Volatility Endpoint

Source: https://github.com/suenot/bybit-docs-markdown/blob/main/docs/options/market.md

Retrieves historical volatility data for options.

```http
GET /v5/market/historical-volatility
```
Tokens:
Raw