> ## 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 OI Aggregated History

Get aggregated Open Interest OHLC (candlestick) history data across all exchanges for a cryptocurrency. Combines open interest from all futures exchanges into a single time series. Supports 1m to 1w intervals. Ideal for: market-wide OI analysis, total derivatives exposure tracking, macro market trends.

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

Get aggregated Open Interest OHLC (candlestick) history data across all exchanges for a cryptocurrency. Combines open interest from all futures exchanges into a single time series. Supports 1m to 1w intervals. Ideal for: market-wide OI analysis, total derivatives exposure tracking, macro market trends.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `coinglass-get-oi-aggregated-history` |
| Category | Blockchain Data |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `coinglass`, `open-interest`, `aggregated`, `ohlc`, `futures`, `derivatives`, `read` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `symbol` | `string` | Yes | Coin symbol \(e.g., 'BTC', 'ETH'\). The aggregated open interest across all exchanges for this coin. |
| `interval` | `string` | Yes | Data aggregation time interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 1w. |
| `limit` | `number` | No | Maximum number of results to return \(default: 1000, max: 4500\). |
| `startTime` | `number` | No | Start timestamp in seconds \(e.g., 1641522717\). |
| `endTime` | `number` | No | End timestamp in seconds \(e.g., 1641522717\). |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `symbol` | `string` | Yes | Coin symbol. |
| `interval` | `string` | Yes | Time interval. |
| `candles` | `array` | Yes | Array of OHLC candle data points |

## Examples

**Workflow node**

```json
{
  "type": "coinglass-get-oi-aggregated-history",
  "payload": {
    "symbol": "ETH",
    "interval": "1m"
  },
  "children": []
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/coinglass-get-oi-aggregated-history/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "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.