# Crypto Options Analytics - Deribit IV Put/Call Max Pain (`gochujang/options-analytics`) Actor Tracks live BTC/ETH/SOL options on Deribit (largest crypto options exchange). Implied volatility (IV) surface by expiry, put/call ratio, max pain price, top OI strikes, funding vs spot. No API key. Perfect for options traders. $0.005/run. - **URL**: https://apify.com/gochujang/options-analytics.md - **Developed by:** [Hojun Lee](https://apify.com/gochujang) (community) - **Categories:** Developer tools, Automation, Other - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Crypto Options Analytics — Deribit IV, Put/Call Ratio, Max Pain Scrape live BTC and ETH options data from [Deribit](https://www.deribit.com/) — the world's largest crypto options exchange by open interest. Returns the full options chain with implied volatility, put/call ratios, max pain prices, and OI by strike. **No API key required.** ### What You Get **Per contract (dataset rows):** - `currency`, `expiry`, `strike`, `option_type` (call/put) - `iv` — implied volatility (%) - `bid_iv` / `ask_iv` — bid/ask IV spread - `mark_price` — current mark price in BTC/ETH - `open_interest` — OI in base currency - `open_interest_usd` — OI in USD - `volume_24h` — 24h trading volume - Optional: `delta`, `gamma`, `theta`, `vega` (set `includeGreeks: true`) **SUMMARY key-value store:** - **Put/Call ratio per expiry** (OI-weighted) - **Max Pain price per expiry** — the strike where most options expire worthless - Total contract count ### Use Cases - **Max Pain analysis** — identify where price is "pulled" near expiry - **Options wall detection** — find large call/put walls (support/resistance) - **IV surface** — see implied volatility across strikes and expirations - **Put/Call ratio** — gauge market sentiment per expiry - **Expiry-specific research** — filter to specific dates for granular analysis ### Sample Output ```json { "currency": "BTC", "expiry": "27JUN25", "strike": 100000, "option_type": "call", "iv": 62.5, "bid_iv": 61.8, "ask_iv": 63.2, "mark_price": 0.0245, "index_price": 97850.0, "open_interest": 142.5, "open_interest_usd": 13944187.5, "volume_24h": 18.3, "timestamp": "2025-06-10T14:32:00+00:00" } ```` **SUMMARY:** ```json { "put_call_ratios": { "27JUN25": { "put_oi_usd": 850000000, "call_oi_usd": 1200000000, "put_call_ratio": 0.708 } }, "max_pain_by_expiry": { "27JUN25": { "max_pain_strike": 95000, "total_oi_loss": 125000000 } } } ``` ### Input Parameters | Parameter | Type | Default | Description | |-----------|------|---------|-------------| | `currencies` | Array | `["BTC","ETH"]` | Currencies to analyze: BTC, ETH, SOL | | `expiryFilter` | String | `"all"` | `"all"`, `"weekly"`, `"monthly"`, or specific date like `"27JUN25"` | | `includeGreeks` | Boolean | false | Add delta/gamma/theta/vega to output | | `minOpenInterestUsd` | Integer | 0 | Filter out contracts below this OI threshold | ### Pricing **Pay-Per-Event: $0.0001 per option contract** Typical runs: - BTC only (1 expiry) → ~100–300 contracts → **$0.01–$0.03** - BTC + ETH (all expiries) → ~1,000–3,000 contracts → **$0.10–$0.30** Use `expiryFilter` and `minOpenInterestUsd` to narrow results and reduce cost. ### No API Key Required Uses [Deribit's public API](https://docs.deribit.com/) — free and globally accessible, no authentication needed. ### Technical Details - **Runtime**: Python 3.12 on Apify - **Data source**: Deribit public REST API - **Concurrency**: 12 parallel requests for fast data collection - **Typical run time**: 30–90 seconds (depending on currency/expiry count) # Actor input Schema ## `currencies` (type: `array`): List of currencies to analyze. Options: BTC, ETH, SOL. ## `expiryFilter` (type: `string`): Filter by expiry type: 'all' (all expirations), 'weekly' (next 7 days), 'monthly' (next 30 days), or a specific date like '27JUN25'. ## `includeGreeks` (type: `boolean`): Include delta, gamma, theta, vega in output. ## `minOpenInterestUsd` (type: `integer`): Only include contracts with OI above this USD threshold (0 = all). ## Actor input object example ```json { "currencies": [ "BTC", "ETH" ], "expiryFilter": "all", "includeGreeks": false, "minOpenInterestUsd": 0 } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("gochujang/options-analytics").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("gochujang/options-analytics").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call gochujang/options-analytics --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=gochujang/options-analytics", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Crypto Options Analytics - Deribit IV Put/Call Max Pain", "description": "Tracks live BTC/ETH/SOL options on Deribit (largest crypto options exchange). Implied volatility (IV) surface by expiry, put/call ratio, max pain price, top OI strikes, funding vs spot. No API key. Perfect for options traders. $0.005/run.", "version": "0.1", "x-build-id": "QfzDPMBtzgfAKbsP2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gochujang~options-analytics/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gochujang-options-analytics", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/gochujang~options-analytics/runs": { "post": { "operationId": "runs-sync-gochujang-options-analytics", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/gochujang~options-analytics/run-sync": { "post": { "operationId": "run-sync-gochujang-options-analytics", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "currencies": { "title": "Currencies", "type": "array", "description": "List of currencies to analyze. Options: BTC, ETH, SOL.", "default": [ "BTC", "ETH" ] }, "expiryFilter": { "title": "Expiry Filter", "type": "string", "description": "Filter by expiry type: 'all' (all expirations), 'weekly' (next 7 days), 'monthly' (next 30 days), or a specific date like '27JUN25'.", "default": "all" }, "includeGreeks": { "title": "Include Greeks", "type": "boolean", "description": "Include delta, gamma, theta, vega in output.", "default": false }, "minOpenInterestUsd": { "title": "Min Open Interest (USD)", "minimum": 0, "type": "integer", "description": "Only include contracts with OI above this USD threshold (0 = all).", "default": 0 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```