> ## Documentation Index
> Fetch the complete documentation index at: https://docs.b3os.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Whale Index

Retrieves historical Whale Index data indicating large trader activity based on order book depth. Higher values suggest increased whale buying, lower values indicate whale selling pressure. Ideal for: whale tracking, smart money analysis, predicting large price moves, market manipulation detection.

![Get Whale Index logo](https://ai-icon.b3.fun/logo/coinglass)
Catalog action Blockchain Data

Retrieves historical Whale Index data indicating large trader activity based on order book depth. Higher values suggest increased whale buying, lower values indicate whale selling pressure. Ideal for: whale tracking, smart money analysis, predicting large price moves, market manipulation detection.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `coinglass-indicator-get-whale-index` |
| Category | Blockchain Data |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `coinglass`, `indicator`, `whale`, `smart-money`, `order-book`, `read` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `exchange` | `string` | Yes | Futures exchange name \(e.g., Binance, OKX, Bybit\). |
| `symbol` | `string` | Yes | Trading pair symbol \(e.g., BTCUSDT, ETHUSDT\). |
| `interval` | `string` | Yes | Time interval for data aggregation. |
| `limit` | `number` | No | Maximum number of results \(default: 1000\). |
| `startTime` | `number` | No | Start timestamp in milliseconds. |
| `endTime` | `number` | No | End timestamp in milliseconds. |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `exchange` | `string` | Yes | Exchange name. |
| `symbol` | `string` | Yes | Trading pair symbol. |
| `interval` | `string` | Yes | Time interval. |
| `dataPoints` | `array` | Yes | Array of Whale Index data points. |

## Examples

**Workflow node**

```json
{
  "type": "coinglass-indicator-get-whale-index",
  "payload": {
    "exchange": "example-exchange",
    "symbol": "ETH",
    "interval": "1m"
  },
  "children": []
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/coinglass-indicator-get-whale-index/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "exchange": "example-exchange",
    "symbol": "ETH",
    "interval": "1m"
  }
}'
```

**Use expressions for dynamic values**

Payload fields can use workflow expressions such as `{{$trigger.body.amount}}`, `{{$nodes.fetch.result.price}}`, and `{{$props.asset}}` when the value should come from a trigger, prior node, or reusable workflow prop.