Hyblock API

https://docs.hyblockcapital.com
Admin
Hyblock API is a comprehensive trading data and analytics platform providing real-time market...
Tokens:260,417
Snippets:854
Trust Score:8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get Best Bid Ask - cURL Example

Source: https://docs.hyblockcapital.com/best-bid-ask-27017232e0

Use this cURL command to fetch best bid and ask data. Ensure you replace placeholders with your actual token and API key.

```Shell
curl --location --request GET 'https://api.hyblockcapital.com/v2/bestBidAsk?coin&exchange&timeframe&limit&startTime&endTime&sort&marketTypes&advanceFilter' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>'
```

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

### Base64 Encoding Example

Source: https://docs.hyblockcapital.com/authentication-1949273m0

Example of encoding client ID and client secret for the Basic Auth header. The format must be `client_id:client_secret` before Base64 encoding.

```text
client_id:client_secret -> Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=

Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=
```

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

### Get Limit Order Count - cURL Example

Source: https://docs.hyblockcapital.com/limit-order-count

This cURL command demonstrates how to fetch the limit order count data. Ensure you replace placeholders like <token> and <api-key> with your actual credentials. The parameters allow for detailed filtering by coin, exchange, timeframe, and more.

```curl
curl --location --request GET 'https://api.hyblockcapital.com/v2/limitOrderCount?coin&exchange&timeframe&limit&startTime&endTime&sort&bucket&marketTypes&advanceFilter' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>'
```

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

### GET /v2/bidAskRatio

Source: https://docs.hyblockcapital.com/orderbook-5970329f0

Calculates the bid-ask ratio oscillator.

```APIDOC
## GET /v2/bidAskRatio

### Description
Bid Ask Ratio is an oscillator that ranges from -1 to 1. The mathematical formula is (Bids - Asks) / (Bids + Asks).

### Method
GET

### Endpoint
/v2/bidAskRatio
```

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

### Dvol Response Example

Source: https://docs.hyblockcapital.com/dvol

Example JSON response for the Dvol API, including data points like openDate, open, low, high, close, and metadata.

```json
{
    "data": [
        {
            "close": 39.88290896,
            "high": 39.83478107,
            "low": 39.88290896,
            "open": 39.83476124,
            "openDate": 1695892500
        }
    ],
    "metadata": {
        "exchanges": [
            "deribit_perp_stable"
        ]
    }
}
```

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

### GET /buy-volume

Source: https://docs.hyblockcapital.com/asks-increase-decrease

Retrieves buy volume data.

```APIDOC
## GET /buy-volume

### Description
Fetches the total buy volume for the requested period.

### Method
GET

### Endpoint
/buy-volume

### Response
#### Success Response (200)
- **data** (BuyVolumeResponse) - The buy volume data.
```

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

### GET /websites/hyblockcapital

Source: https://docs.hyblockcapital.com/whale-position-dominance

Retrieves whale position dominance data.

```APIDOC
## GET /websites/hyblockcapital

### Description
Retrieves whale position dominance data, including open dates and dominance percentages, potentially filtered by exchanges.

### Method
GET

### Endpoint
/websites/hyblockcapital

### Query Parameters
- **exchanges** (string) - Optional - Comma-separated list of exchanges to filter by (e.g., "binance_perp_stable").

### Response
#### Success Response (200)
- **data** (array) - An array of objects, where each object contains:
  - **openDate** (integer) - The date the data was recorded, represented as a Unix timestamp.
  - **whalePositionDominance** (number) - The percentage of whale position dominance.
- **metadata** (object) - Metadata about the response, including:
  - **exchanges** (array) - A list of exchanges associated with the data.

#### Response Example
```json
{
  "data": [
    {
      "openDate": 1736232600,
      "whalePositionDominance": 17.020000000000003
    }
  ],
  "metadata": {
    "exchanges": [
      "binance_perp_stable"
    ]
  }
}
```

### Error Handling
- **400 Bad Request**: Invalid or missing input parameters.
  - **detail** (object)
    - **error_code** (string) - e.g., "BAD_REQUEST"
    - **message** (string) - Description of the error.
  - Example:
    ```json
    {
      "detail": {
        "error_code": "BAD_REQUEST",
        "message": "endpoint_name is missing"
      }
    }
    ```
- **401 Unauthorized**: Authentication failed (e.g., invalid API key, expired token).
  - **detail** (object)
    - **error_code** (string) - e.g., "TOKEN_EXPIRED"
    - **message** (string) - Description of the authentication error.
  - Example:
    ```json
    {
      "detail": {
        "error_code": "TOKEN_EXPIRED",
        "message": "Unauthorized: Token expired"
      }
    }
    ```
- **403 Forbidden**: User is not authorized to access the resource.
  - **detail** (object)
    - **error_code** (string) - e.g., "SUBSCRIPTION_EXPIRED"
    - **message** (string) - Description of the authorization error.
  - Example:
    ```json
    {
      "detail": {
        "error_code": "SUBSCRIPTION_EXPIRED",
        "message": "Unauthorized: Your subscription has expired. Please upgrade or renew."
      }
    }
    ```
- **422 Unprocessable Entity**: Invalid input format.
  - **detail** (object)
    - **error_code** (string) - e.g., "INVALID_INPUT"
    - **message** (string) - Description of the invalid input.
  - Example:
    ```json
    {
      "detail": {
        "error_code": "INVALID_INPUT",
        "message": "Invalid coin: btcsd."
      }
    }
    ```
- **429 Too Many Requests**: The rate limit has been exceeded.
```

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

### GET /v2/bidAskDelta

Source: https://docs.hyblockcapital.com/orderbook-5970329f0

Evaluates the immediate disparity between buy and sell orders.

```APIDOC
## GET /v2/bidAskDelta

### Description
Evaluate the immediate disparity between buy and sell orders.

### Method
GET

### Endpoint
/v2/bidAskDelta
```

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

### GET /bidAskDelta

Source: https://docs.hyblockcapital.com/bid-ask-delta

Evaluate the immediate disparity between buy and sell orders.

```APIDOC
## GET /bidAskDelta

### Description
Evaluate the immediate disparity between buy and sell orders.

### Method
GET

### Endpoint
/bidAskDelta

### Parameters
#### Query Parameters
- **coin** (string) - Required - Please enter the valid coin.
- **exchange** (string) - Optional - Please enter the valid exchange, you can enter single or multiple exchange with comma separated.
- **timeframe** (enum<string>) - Required - Please select the timeframe: 1m, 5m, 15m, 1h, 4h, 1d.
- **limit** (integer) - Optional - Please enter the limit size. Available values: 5, 10, 20, 50, 100, 500, 1000.
- **startTime** (integer) - Optional - Please enter the valid startTime.
- **endTime** (integer) - Optional - Please enter the valid endTime.
- **sort** (string) - Optional - If desc, will sort results newest first. asc: ascending order, desc: descending order.
- **depth** (string) - Optional - You can enter one or two depth values separated by a comma to define a range.
- **marketTypes** (string) - Optional - Please select the valid marketTypes (e.g. all, spot, perpetuals).
- **advanceFilter** (string) - Optional - Select an advanced filter option. normalize: Scales the series to a 0–100 range per selection.

### Request Example
curl --location --request GET 'https://api.hyblockcapital.com/v2/bidAskDelta?coin&exchange&timeframe&limit&startTime&endTime&sort&depth&marketTypes&advanceFilter' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>'

### Response
#### Success Response (200)
- **data** (array[object]) - Data containing bidAskDelta and openDate.
- **metadata** (object) - MetaDataExchanges containing list of exchanges.

#### Response Example
{
    "data": [
        {
            "bidAskDelta": -35945460.68240702,
            "openDate": 1695711720
        }
    ],
    "metadata": {
        "exchanges": [
            "bitmex_perp_coin",
            "bybit_perp_coin"
        ]
    }
}
```

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

### GET /v2/liquidationLevelsTV

Source: https://docs.hyblockcapital.com/liquidity-5970334f0

Provides access to open liquidation levels for TradingView charts.

```APIDOC
## GET /v2/liquidationLevelsTV

### Description
Provides access to open liquidation levels for specified coins and exchanges on TradingView charts.

### Method
GET

### Endpoint
/v2/liquidationLevelsTV
```

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

### GET /v2/leaderboardNotionalProfit

Source: https://docs.hyblockcapital.com/sentiment-5970333f0

Retrieves the Bitmex Notional Leaderboard for most profitable traders.

```APIDOC
## GET /v2/leaderboardNotionalProfit

### Description
The Bitmex Notional Leaderboard show the most profitable all-time traders on BitMEX in terms of notional value (only active and verified accounts are included).

### Method
GET

### Endpoint
/v2/leaderboardNotionalProfit
```

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

### GET /v2/liqLevelsSize

Source: https://docs.hyblockcapital.com/liquidity-5970334f0

Measures the relative strength of predicted liquidation levels.

```APIDOC
## GET /v2/liqLevelsSize

### Description
Measures the relative strength of predicted liquidation levels to compare zones of potential liquidation pressure.

### Method
GET

### Endpoint
/v2/liqLevelsSize
```

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

### GET /v2/leaderboardROEProfit

Source: https://docs.hyblockcapital.com/sentiment-5970333f0

Retrieves the Bitmex ROE Leaderboard for most profitable traders.

```APIDOC
## GET /v2/leaderboardROEProfit

### Description
The Bitmex ROE Leaderboard show the most profitable all-time traders on BitMEX in terms of ROE or return on equity (only active and verified accounts are included).

### Method
GET

### Endpoint
/v2/leaderboardROEProfit
```

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

### BidAskRatioResponse Schema

Source: https://docs.hyblockcapital.com/bidaskratioresponse-11729088d0

Details of the BidAskRatioResponse schema, including its properties and examples.

```APIDOC
## BidAskRatioResponse Schema

### Description
Represents the response structure for Bid-Ask Ratio data, containing daily open dates and their corresponding ratios, along with metadata about exchanges.

### Properties

- **data** (array) - Required - An array of BidAskRatio objects.
  - **openDate** (integer) - Required - The Unix timestamp for the open date.
  - **bidAskRatio** (number) - Required - The calculated bid-ask ratio.
- **metadata** (object) - Required - Metadata related to the data.
  - **exchanges** (array of strings) - Required - A list of exchanges associated with the data.

### Examples

**Example 1:**
```json
{
  "data": [
    {
      "openDate": 1665047820,
      "bidAskRatio": 0.14752672038637354
    }
  ],
  "metadata": {
    "exchanges": [
      "bitmex_perp_coin",
      "bybit_perp_coin",
      "bitfinex_perp_stable",
      "coinbase_spot",
      "deribit_perp_stable",
      "huobi_perp_coin",
      "okx_perp_coin",
      "okx_qtrly",
      "binance_spot",
      "binance_perp_stable",
      "binance_perp_coin",
      "bybit_perp_stable",
      "bybit_spot",
      "coinbaseadvanced_spot",
      "coinbaseadvanced_perp_stable",
      "bitget_perp_stable",
      "bitget_spot",
      "bitget_perp_coin",
      "okx_perp_stable",
      "okx_spot"
    ]
  }
}
```
```

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

### GET /v2/globalBidAskDelta

Source: https://docs.hyblockcapital.com/global-metrics-5970330f0

Retrieves the net global liquidity imbalance.

```APIDOC
## GET /v2/globalBidAskDelta

### Description
Returns the net global liquidity imbalance by subtracting aggregated global asks from aggregated global bids. Positive values indicate buy-side pressure; negative values indicate sell-side pressure.

### Method
GET

### Endpoint
/v2/globalBidAskDelta
```

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

### GET /v2/participationRatio

Source: https://docs.hyblockcapital.com/orderflow-5970326f0

Indicates the percentage of volume attributed to net position openings.

```APIDOC
## GET /v2/participationRatio

### Description
This metric indicates the percentage of volume attributed to net position openings by dividing OI Delta by Volume, showing the share of total volume represented by open interest changes.

### Method
GET

### Endpoint
/v2/participationRatio
```

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

### GET /leaderboardNotionalProfit

Source: https://docs.hyblockcapital.com/leaderboard-notional-profit

Retrieves the leaderboard of notional profit for traders on BitMEX. This endpoint includes options for filtering by timeframe, limit, start and end times, sorting, specific users, and advanced filtering.

```APIDOC
## GET /leaderboardNotionalProfit

### Description
Retrieves the leaderboard of notional profit for traders on BitMEX. This endpoint includes options for filtering by timeframe, limit, start and end times, sorting, specific users, and advanced filtering.

### Method
GET

### Endpoint
/leaderboardNotionalProfit

### Parameters
#### Query Parameters
- **timeframe** (string) - Required - Please select the timeframe: <br>`1m`: `1 minute` <br> `5m`: `5 minutes` <br> `15m`: `15 minutes` <br> `1h`: `1 hour` <br> `4h`: `4 hours` <br> `1d`: `1 day`
- **limit** (integer) - Optional - Please enter the limit size. <br> Available values: 5,10,20,50,100,500,1000 <br> Default value: 50
- **startTime** (integer) - Optional - Please enter the valid startTime. If you do not enter any startTime, the default will be current time (e.g. 1748736000).
- **endTime** (integer) - Optional - Please enter the valid endTime. If you do not enter any endTime, the default will be current time (e.g. 1751328000).
- **sort** (string) - Optional - If `desc`, will sort results newest first. <br> `asc`: `ascending order` <br> `desc`: `descending order` <br> Default value: asc
- **user** (string) - Optional - You can enter leaderboard notional roe profit user. <br> Default value: all
- **advanceFilter** (string) - Optional - Select an advanced filter option. <br>`normalize`: Scales the series to a 0–100 range per selection. <br>default: `none`, no advanced filter is applied and operations are performed directly on raw market values.

### Response
#### Success Response (200)
- **data** (array) - Contains leaderboard data.
  - **openDate** (integer) - Timestamp of the open date.
  - **total** (number) - Total notional profit.
- **metadata** (object) - Metadata about the response.
  - **exchanges** (array) - List of exchanges.

#### Response Example
```json
{
  "data": [
    {
      "openDate": 1665047820,
      "total": 5951677969310
    }
  ],
  "metadata": {
    "exchanges": [
      "bitmex_perp_coin"
    ]
  }
}
```
```

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

### Using the Access Token

Source: https://docs.hyblockcapital.com/authentication-1949273m0

Instructions on how to include the generated access token in subsequent API requests for authentication.

```APIDOC
## Using the Access Token

### Description
Once you have obtained an `access_token`, include it in the `Authorization` header of your requests to protected API endpoints. You also need to include your `x-api-key`.

### Headers
- **Authorization** (string) - Required - Bearer token formatted as `Bearer <access_token>`.
- **x-api-key** (string) - Required - Your unique API key.

### Example Request Header
```http
Authorization: Bearer <access_token>
x-api-key: <your-api-key>
```
```

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

### Data Availability Endpoint Specification

Source: https://docs.hyblockcapital.com/data-availability

Defines the GET request for the /dataAvailability endpoint, which allows users to programmatically check the availability range for any supported data stream. It specifies query parameters for coin and endpointName, and details the structure of successful (200) and error (400, 401) responses, including example data.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /dataAvailability:
    get:
      summary: Availability
      deprecated: false
      description: >-
        This is to help users programmatically check the availability range for
        any supported data stream. This allows to determine the earliest
        available date for historical data tied to a specific endpoint.
      operationId: dataAvailability
      tags:
        - System
        - System
      parameters:
        - name: coin
          in: query
          description: >-
            Please enter the valid coin. All the supported coins with their
            respective exchanges can be fetched via `/catalog` endpoint.
          required: true
          schema:
            type: string
        - name: endpointName
          in: query
          description: Please enter valid endpointName.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Request was successful
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      properties:
                        availabilityFrom:
                          type: string
                          title: Availabilityfrom
                        exchange:
                          type: string
                          title: Exchange
                        symbol:
                          type: string
                          title: Symbol
                      type: object
                      required:
                        - availabilityFrom
                        - exchange
                        - symbol
                      title: DataAvailability
                      x-apidog-orders:
                        - availabilityFrom
                        - exchange
                        - symbol
                      examples:
                        - availabilityFrom: '2023-12-06 10:15:00'
                          exchange: binance_perp_stable
                          symbol: btcusdt
                    type: array
                    title: Data
                type: object
                required:
                  - data
                title: DataAvailabilityResponse
                x-apidog-orders:
                  - data
                examples:
                  - data:
                      - availabilityFrom: '2023-12-06 10:15:00'
                        exchange: binance_perp_stable
                        symbol: btcusdt
              example:
                data:
                  - availabilityFrom: '2023-12-06 10:15:00'
                    exchange: binance_perp_stable
                    symbol: btcusdt
          headers: {}
          x-apidog-name: OK
        '400':
          description: Bad Request – invalid or missing input
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: object
                    properties:
                      error_code:
                        type: string
                      message:
                        type: string
                    required:
                      - error_code
                      - message
                    x-apidog-orders:
                      - error_code
                      - message
                required:
                  - detail
                x-apidog-orders:
                  - detail
              example:
                detail:
                  error_code: BAD_REQUEST
                  message: endpoint_name is missing
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: |-
            Authentication failed. Possible reasons:
            - INVALID_API_KEY: Provided API key is invalid
            - TOKEN_EXPIRED: Bearer token has expired
            - MISSING_API_KEY: API key not provided
            - INVALID_TOKEN: Bearer token is invalid
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: object
                    properties:
                      error_code:
                        type: string
                      message:
                        type: string
                    required:
                      - error_code
                      - message
                    x-apidog-orders:
                      - error_code
                      - message
                required:
                  - detail
                x-apidog-orders:
                  - detail
              example:
                detail:
                  error_code: TOKEN_EXPIRED
                  message: 'Unauthorized: Token expired'
          headers: {}
```

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

### Define API Error Response Examples

Source: https://docs.hyblockcapital.com/anchored-cls

Examples of JSON error responses for 422, 429, and 500 HTTP status codes.

```yaml
        '422':
          description: Invalid input format
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: object
                    properties:
                      error_code:
                        type: string
                      message:
                        type: string
                    required:
                      - error_code
                      - message
                    x-apidog-orders:
                      - error_code
                      - message
                required:
                  - detail
                x-apidog-orders:
                  - detail
              example:
                detail:
                  error_code: INVALID_INPUT
                  message: 'Invalid coin: btcsd.'
```

```yaml
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: object
                    properties:
                      error_code:
                        type: string
                      message:
                        type: string
                    required:
                      - error_code
                      - message
                    x-apidog-orders:
                      - error_code
                      - message
                required:
                  - detail
                x-apidog-orders:
                  - detail
              example:
                detail:
                  error_code: TOO_MANY_REQUESTS
                  message: Too many requests!
```

```yaml
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: object
                    properties:
                      error_code:
                        type: string
                      message:
                        type: string
                    required:
                      - error_code
                      - message
                    x-apidog-orders:
                      - error_code
                      - message
                required:
                  - detail
                x-apidog-orders:
                  - detail
              example:
                detail:
                  error_code: INTERNAL_SERVER_ERROR
                  message: Internal Server Error
```

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

### Best Bid Ask Response Example

Source: https://docs.hyblockcapital.com/best-bid-ask-27017232e0

This JSON structure represents a successful response containing best bid and ask prices along with metadata about the exchanges.

```JSON
{
    "data": [
        {
            "bestAsk": 103949.3,
            "bestBid": 103949.2,
            "openDate": 1762246200
        }
    ],
    "metadata": {
        "exchanges": [
            "binance_perp_stable"
        ]
    }
}
```

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

### OpenAPI Specification for Liquidation Levels

Source: https://docs.hyblockcapital.com/liquidation-levels-trading-view

This YAML snippet defines the OpenAPI 3.0.1 specification for the `/liquidationLevelsTV` endpoint. It details the GET request, its parameters (coin, exchange, timestamp, leverage, position, tier, openDuration, oidv), and the structure of the successful JSON response, including data fields like timestamp, creationDate, tier, price, leverage, side, and openDuration.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /liquidationLevelsTV:
    get:
      summary: Liquidation Levels Trading View
      deprecated: false
      description: >-
        This endpoint provides access to open liquidation levels for specified
        coins and exchanges on TradingView charts, retrieving detailed
        information based on filters like leverage, position, tier, open
        duration, and open interest delta to volume ratio (oidv).
      operationId: liquidationLevelsTV
      tags:
        - Liquidity
        - Liquidity
      parameters:
        - name: coin
          in: query
          description: >-
            The valid coin for which liquidation levels are requested; all
            supported coins with their respective exchanges can be fetched via
            the “/catalog” endpoint.
          required: true
          schema:
            type: string
        - name: exchange
          in: query
          description: >-
            Please enter the valid exchange, you can enter single exchange. All
            the supported exchanges with their respective coins can be fetched
            via `/catalog` endpoint.
          required: true
          schema:
            type: string
        - name: timestamp
          in: query
          description: >-
            Please enter the valid timestamp.If you do not enter any timestamp,
            the default will be the current time (e.g. 1751328000).
          required: false
          schema:
            type: integer
        - name: leverage
          in: query
          description: The leverage level(s) for the liquidation levels.
          required: false
          schema:
            default: all
            type: string
        - name: position
          in: query
          description: >-
            The position type for the liquidation levels, only a single value is
            allowed.
          required: false
          schema:
            default: all
            type: string
        - name: tier
          in: query
          description: >-
            The size tier of the liquidation levels, with tier 1 being the
            smallest (most granular) and tier 3 being the largest (least
            granular).
          required: false
          schema:
            anyOf:
              - type: string
                enum:
                  - '1'
                  - '2'
                  - '3'
                title: Tier
              - type: string
            default: '1'
        - name: openDuration
          in: query
          description: >-
            The duration (in days) that the liquidation level has been open.
            Must be a positive integer up to 99. Filters liquidation levels
            based on how recently they opened.
          required: false
          schema:
            anyOf:
              - type: string
            default: '14'
        - name: oidv
          in: query
          description: >-
            The open interest delta divided by volume, representing the ratio of
            positions entering or exiting on that volume. A tuple of two floats
            between -1 and 1 (e.g., "0,1", "-1,1", "-0.2,0.2") to filter
            for positive open interest delta when positive.
          required: false
          schema:
            anyOf:
              - type: string
            default: '-1,1'
      responses:
        '200':
          description: Request was successful
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      properties:
                        timestamp:
                          type: integer
                          title: Timestamp
                        creationDate:
                          type: integer
                          title: Creationdate
                        tier:
                          type: integer
                          title: Tier
                        price:
                          type: number
                          title: Price
                        leverage:
                          type: string
                          title: Leverage
                        side:
                          type: string
                          title: Side
                        openDuration:
                          type: integer
                          title: Openduration
                      type: object
                      required:
                        - timestamp
                        - creationDate
                        - tier
                        - price
                        - leverage
                        - side
                        - openDuration
                      title: LiquidationLevelsTV
                      x-apidog-orders:
                        - timestamp
                        - creationDate

```

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

### GET /sell-volume

Source: https://docs.hyblockcapital.com/asks-increase-decrease

Retrieves sell volume data.

```APIDOC
## GET /sell-volume

### Description
Fetches the total sell volume for the requested period.

### Method
GET

### Endpoint
/sell-volume

### Response
#### Success Response (200)
- **data** (SellVolumeResponse) - The sell volume data.
```

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

### GET /v2/bestBidAsk

Source: https://docs.hyblockcapital.com/orderbook-5970329f0

Retrieves the total limit buy and sell size at the closest price levels.

```APIDOC
## GET /v2/bestBidAsk

### Description
Represents the total limit buy size (best bid) and limit sell size (best ask) at the closest price levels to the last traded price.

### Method
GET

### Endpoint
/v2/bestBidAsk
```

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

### GET /v2/stablecoinPremiumP2P

Source: https://docs.hyblockcapital.com/sentiment-5970333f0

Retrieves the relative ratio of USDT and USDC relative to the 1:1 USD peg on the Okx P2P market.

```APIDOC
## GET /v2/stablecoinPremiumP2P

### Description
The relative ratio of USDT and USDC relative to the 1:1 USD peg, otherwise known as 'premium', on the Okx peer-to-peer market.

### Method
GET

### Endpoint
/v2/stablecoinPremiumP2P
```

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

### GET /exchange-premium

Source: https://docs.hyblockcapital.com/asks-increase-decrease

Retrieves exchange premium data.

```APIDOC
## GET /exchange-premium

### Description
Fetches the premium data across different exchanges.

### Method
GET

### Endpoint
/exchange-premium

### Response
#### Success Response (200)
- **data** (ExchangePremiumResponse) - The exchange premium metrics.
```

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

### GET /stablecoinPremiumP2P

Source: https://docs.hyblockcapital.com/premium-p2p

Retrieves the relative ratio of USDT and USDC to the 1:1 USD peg on the Okx peer-to-peer market.

```APIDOC
## GET /stablecoinPremiumP2P

### Description
Retrieves the relative ratio of USDT and USDC to the 1:1 USD peg, otherwise known as 'premium', on the Okx peer-to-peer market.

### Method
GET

### Endpoint
/stablecoinPremiumP2P

### Parameters
#### Query Parameters
- **timeframe** (string) - Required - Please select the timeframe: <br>`1m`: `1 minute` <br> `5m`: `5 minutes` <br> `15m`: `15 minutes` <br> `1h`: `1 hour` <br> `4h`: `4 hours` <br> `1d`: `1 day`
- **limit** (integer) - Optional - Please enter the limit size. <br> Available values: 5,10,20,50,100,500,1000 <br> Default value: 50
- **startTime** (integer) - Optional - Please enter the valid startTime. If you do not enter any startTime, the default will be current time (e.g. 1748736000).
- **endTime** (integer) - Optional - Please enter the valid endTime. If you do not enter any endTime, the default will be current time (e.g. 1751328000).
- **sort** (string) - Optional - If `desc`, will sort results newest first. <br> `asc`: `ascending order` <br> `desc`: `descending order` <br> Default value: asc
- **advanceFilter** (string) - Optional - Select an advanced filter option. <br>`normalize`: Scales the series to a 0–100 range per selection. <br>default: `none`, no advanced filter is applied and operations are performed directly on raw market values.

### Response
#### Success Response (200)
- **data** (array) - Contains the premium data.
  - **openDate** (integer) - The date the data was opened.
  - **usdcPremium** (number) - The USDC premium value.
  - **usdtPremium** (number) - The USDT premium value.
- **metadata** (object) - Metadata about the response.
  - **exchanges** (array) - List of exchanges.

#### Response Example
```json
{
  "data": [
    {
      "openDate": 1691987220,
      "usdcPremium": 100.95,
      "usdtPremium": 100.6
    }
  ],
  "metadata": {
    "exchanges": [
      "okx_perp_coin"
    ]
  }
}
```
```

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

### GET /health-check

Source: https://docs.hyblockcapital.com/llms.txt

Verifies API service availability and connectivity.

```APIDOC
## GET /health-check

### Description
Fetch API availability and service status response. Use it to verify API uptime and connectivity.

### Method
GET

### Endpoint
/health-check
```

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

### GET /v2/profilesTool

Source: https://docs.hyblockcapital.com/profile-tool-5970335f0

Retrieves volume profile analysis data including volume delta, open interest, and liquidations.

```APIDOC
## GET /v2/profilesTool

### Description
Profiles Tools take the concept of volume profile analysis to the next level by incorporating additional data such as volume delta, open interest, and liquidations. This type of graph helps you understand the distribution of trading activity over different price levels.

### Method
GET

### Endpoint
/v2/profilesTool

### Parameters
#### Query Parameters
- **exchange** (string) - Required - Exchange identifier (e.g., binance_perp_stable)
- **coin** (string) - Required - Cryptocurrency symbol (e.g., BTC, ETH)
- **timeframe** (string) - Required - Time interval (1m, 5m, 15m, 1h, 4h, 1d)
- **limit** (integer) - Optional - Number of data points to return (default: 50)
- **startTime** (integer) - Optional - Start timestamp (Unix timestamp)
- **endTime** (integer) - Optional - End timestamp (Unix timestamp)
- **sort** (string) - Optional - Sort order (asc or desc)
```

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

### GET /v2/wbtcMintBurn

Source: https://docs.hyblockcapital.com/sentiment-5970333f0

Tracks WBTC minting and burning activity.

```APIDOC
## GET /v2/wbtcMintBurn

### Description
Wrapped Bitcoin (WBTC) is an ERC20 token backed 1:1 with Bitcoin. Track when wBTC is minted (btc is exchanged to create wBTC) and burned (wBTC is swapped back for BTC) across a variety of members.

### Method
GET

### Endpoint
/v2/wbtcMintBurn
```

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

### GET /v2/marketImbalanceIndex

Source: https://docs.hyblockcapital.com/orderbook-5970329f0

Retrieves the proprietary market imbalance index.

```APIDOC
## GET /v2/marketImbalanceIndex

### Description
A proprietary Hyblock indicator that combines orderflow (aggressive volume) and orderbook (passive liquidity) imbalances to quantify overall market pressure.

### Method
GET

### Endpoint
/v2/marketImbalanceIndex
```

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

### GET /v2/marginLendingRatio

Source: https://docs.hyblockcapital.com/sentiment-5970333f0

Retrieves the ratio of cumulative data value between BTC/USDT leverage quote currency and underlying asset.

```APIDOC
## GET /v2/marginLendingRatio

### Description
This indicator shows the ratio of cumulative data value between BTC/USDT leverage quote currency (USDT) and underlying asset (BTC) over a given period of time.

### Method
GET

### Endpoint
/v2/marginLendingRatio

### Query Parameters
- **exchange** (string) - Optional - Exchange identifier
- **coin** (string) - Optional - Cryptocurrency symbol
- **timeframe** (string) - Optional - Time interval
- **limit** (integer) - Optional - Number of data points
- **startTime** (integer) - Optional - Start timestamp
- **endTime** (integer) - Optional - End timestamp
- **sort** (string) - Optional - Sort order
```

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

### GET /v2/netLongShortDelta

Source: https://docs.hyblockcapital.com/longs-shorts-5970328f0

The difference between Net Longs and Net Shorts.

```APIDOC
## GET /v2/netLongShortDelta

### Description
The difference between Net Longs and Net Shorts.

### Method
GET

### Endpoint
/v2/netLongShortDelta
```

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

### Generate Access Token (cURL)

Source: https://docs.hyblockcapital.com/authentication-1949273m0

Use this cURL command to generate an access token using client credentials. Ensure you replace placeholders with your actual API key and client credentials.

```bash
curl --location --request POST 'https://api.hyblockcapital.com/v2/oauth2/token'   --header 'x-api-key: <your-api-key>'   --header 'Authorization: Basic <base64(client_id:client_secret)>'   --header 'Content-Type: application/x-www-form-urlencoded'   --data-urlencode 'grant_type=client_credentials'
```

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

### GET /v2/globalCombinedBook

Source: https://docs.hyblockcapital.com/global-metrics-5970330f0

Retrieves the combined global orderbook liquidity.

```APIDOC
## GET /v2/globalCombinedBook

### Description
Returns the combined global orderbook liquidity by summing aggregated bids and aggregated asks across all tickers.

### Method
GET

### Endpoint
/v2/globalCombinedBook
```

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

### GET /liquidation-levels-trading-view

Source: https://docs.hyblockcapital.com/llms.txt

Fetches open liquidation levels formatted specifically for TradingView charts.

```APIDOC
## GET /liquidation-levels-trading-view

### Description
Fetch open liquidation levels formatted for TradingView charts for any supported ticker and timeframe. Use it to visualize liquidation zones directly on price charts.

### Method
GET

### Endpoint
/liquidation-levels-trading-view
```

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

### GET /kline

Source: https://docs.hyblockcapital.com/asks-increase-decrease

Retrieves kline data for market analysis.

```APIDOC
## GET /kline

### Description
Retrieves kline (candlestick) data for the specified market.

### Method
GET

### Endpoint
/kline

### Response
#### Success Response (200)
- **data** (KlinesResponse) - The kline data points.
```

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

### Authentication Overview

Source: https://docs.hyblockcapital.com/market-order-count

Details on how to authenticate with the Hyblock Capital API using OAuth2 Client Credentials or API Keys.

```APIDOC
## Authentication

### Description
The API supports OAuth2 Client Credentials and API Key authentication. OAuth2 tokens are retrieved from the token URL and passed via the Authorization header.

### Security Schemes
- **OAuth2ClientCredentials**: Uses client credentials flow. Token URL: `https://api.hyblockcapital.com/oauth2/token`.
- **ApiKeyAuth**: Uses `x-api-key` header.
- **OAuth+API Auth**: A combination scheme requiring specific scopes.
```

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

### WhaleRetailDeltaResponse Schema

Source: https://docs.hyblockcapital.com/whaleretaildeltaresponse-11729146d0

Details of the WhaleRetailDeltaResponse schema, including its properties and examples.

```APIDOC
## WhaleRetailDeltaResponse Schema

### Description
Represents the response structure for whale and retail delta data.

### Data Structure

- **data** (array) - Required - An array of daily delta data.
  - **openDate** (integer) - Required - The date of the data in Unix timestamp format.
  - **whaleRetailDelta** (number) - Required - The calculated whale-to-retail delta for the day.

- **metadata** (object) - Required - Metadata associated with the data.
  - **exchanges** (array of strings) - Required - A list of exchanges included in the calculation.

### Example Request Body (Conceptual)
```json
{
  "data": [
    {
      "openDate": 1683417600,
      "whaleRetailDelta": 5.805907172995783
    }
  ],
  "metadata": {
    "exchanges": [
      "binance_perp_stable"
    ]
  }
}
```

### Example Response Body (Conceptual)
```json
{
  "data": [
    {
      "openDate": 1683417600,
      "whaleRetailDelta": 5.805907172995783
    }
  ],
  "metadata": {
    "exchanges": [
      "binance_perp_stable"
    ]
  }
}
```
```

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

### Authentication Overview

Source: https://docs.hyblockcapital.com/bid-ask-ratio-diff

Details on the supported authentication schemes for the Hyblock Capital API.

```APIDOC
## Authentication Methods

### OAuth2 Client Credentials
- **Token URL**: https://api.hyblockcapital.com/oauth2/token
- **Flow**: clientCredentials
- **Authorization Header**: Authorization: Bearer <access_token>

### API Key Authentication
- **Location**: Header
- **Header Name**: x-api-key

### Combined Authentication
- **Type**: Combination of OAuth2 and API Key
- **Requirement**: Both schemes are required for authorized access to resources.
```

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

### Asks Increase Decrease Response Example

Source: https://docs.hyblockcapital.com/asks-increase-decrease

JSON structure returned by the API upon a successful request.

```JSON
{
    "data": [
        {
            "asksIncreaseDecrease": 5048640.743506074,
            "openDate": 1695717720
        }
    ],
    "metadata": {
        "exchanges": [
            "bitmex_perp_coin",
            "bybit_perp_coin",
            "bitfinex_perp_stable",
            "coinbase_spot",
            "deribit_perp_stable",
            "huobi_perp_coin",
            "okx_perp_coin",
            "okx_qtrly",
            "binance_spot",
            "binance_perp_stable",
            "binance_perp_coin",
            "bybit_perp_stable",
            "bybit_spot",
            "coinbaseadvanced_spot",
            "coinbaseadvanced_perp_stable",
            "bitget_perp_stable",
            "bitget_spot",
            "bitget_perp_coin",
            "okx_perp_stable",
            "okx_spot"
        ]
    }
}
```

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

### GET /v2/ping

Source: https://docs.hyblockcapital.com/system-5970338f0

Health check endpoint to verify API availability.

```APIDOC
## GET /v2/ping

### Description
Health check endpoint to verify API availability.

### Method
GET

### Endpoint
/v2/ping

### Authentication
May be accessible without authentication depending on configuration. Otherwise, requires API Key (x-api-key header) or OAuth2 (Bearer token).

### Response
#### Success Response (200)
- **status** (string) - Indicates the API is operational.
```

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

### GET /participationRatio

Source: https://docs.hyblockcapital.com/participation-ratio

Retrieves the Participation Ratio, which indicates the percentage of volume attributed to net position openings by dividing OI Delta by Volume.

```APIDOC
## GET /participationRatio

### Description
This metric indicates the percentage of volume attributed to net position openings by dividing OI Delta by Volume, showing the share of total volume represented by open interest changes.

### Method
GET

### Endpoint
/participationRatio

### Parameters
#### Query Parameters
- **marketTypes** (string) - Optional - Please select the valid marketTypes (e.g. all, perp_stable, perp_coin). <br> Default value: all
- **coin** (string) - Required - Please enter the valid coin. All the supported coins with their respective exchanges can be fetched via `/catalog` endpoint.
- **exchange** (string) - Optional - Please enter the valid exchange, you can enter single or multiple exchange with comma separated. All the supported exchanges with their respective coins can be fetched via `/catalog` endpoint. <br> Default value: binance_perp_stable, bitmex_perp_coin, bybit_perp_coin, deribit_perp_stable, bitfinex_perp_stable, phemex_perp_stable, huobi_perp_coin, okx_perp_coin, okx_qtrly, binance_perp_coin, bybit_perp_stable, bitget_perp_stable, bitget_perp_coin, okx_perp_stable
- **timeframe** (string) - Required - Please select the timeframe: <br>`1m`: `1 minute` <br> `5m`: `5 minutes` <br> `15m`: `15 minutes` <br> `1h`: `1 hour` <br> `4h`: `4 hours` <br> `1d`: `1 day`
- **limit** (integer) - Optional - Please enter the limit size. <br> Available values: 5,10,20,50,100,500,1000 <br> Default value: 50
- **startTime** (integer) - Optional - Please enter the valid startTime. If you do not enter any startTime, the default will be current time (e.g. 1748736000).
- **endTime** (integer) - Optional - Please enter the valid endTime. If you do not enter any endTime, the default will be current time (e.g. 1751328000).
- **sort** (string) - Optional - If `desc`, will sort results newest first. <br> `asc`: `ascending order` <br> `desc`: `descending order` <br> Default value: asc
- **advanceFilter** (string) - Optional - Select an advanced filter option. <br>`normalize`: Scales the series to a 0–100 range per selection. <br>default: `none`, no advanced filter is applied and operations are performed directly on raw market values.

### Response
#### Success Response (200)
- **data** (array) - Contains the participation ratio data.
  - **openDate** (integer) - The date of the data point.
  - **participationRatio** (number) - The calculated participation ratio.
- **metadata** (object) - Metadata about the response.

#### Response Example
```json
{
  "data": [
    {
      "openDate": 1698326940,
      "participationRatio": 0.27843641118409124
    }
  ],
  "metadata": {
    "exchanges": []
  }
}
```
```

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

### GET /v2/userBotRatio

Source: https://docs.hyblockcapital.com/sentiment-5970333f0

Retrieves the ratio of users to bots connected to Bitmex.

```APIDOC
## GET /v2/userBotRatio

### Description
This indicator shows the number of users and bots (via api) connected to Bitmex and the ratio between them.

### Method
GET

### Endpoint
/v2/userBotRatio
```

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

### GET /v2/bidAsk

Source: https://docs.hyblockcapital.com/orderbook-5970329f0

Retrieves current bid and ask metrics representing passive buy and sell orders.

```APIDOC
## GET /v2/bidAsk

### Description
A bid (or limit buy) is a "passive" buyer who advertises the price and size they would like to buy at. An asks (or limit sell) is a "passive" seller who advertises the price and size they would like to sell at.

### Method
GET

### Endpoint
/v2/bidAsk
```
Tokens:
Raw