{
"openapi": "3.0.1",
"info": {
"title": "Yahoo Options Scraper",
"description": "Scrape Yahoo Finance option chains for stocks, ETFs, and indexes: bid, ask, IV, volume, open interest, plus Greeks, put/call ratios, max pain, and unusual options activity. Export to JSON, CSV, or Excel, with API and scheduling.",
"version": "1.0",
"x-build-id": "en2dDfpTet6PstSNP"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/parsebird~yahoo-options-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-parsebird-yahoo-options-scraper",
"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/parsebird~yahoo-options-scraper/runs": {
"post": {
"operationId": "runs-sync-parsebird-yahoo-options-scraper",
"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/parsebird~yahoo-options-scraper/run-sync": {
"post": {
"operationId": "run-sync-parsebird-yahoo-options-scraper",
"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": {
"tickers": {
"title": "Tickers",
"type": "array",
"description": "Enter stock, ETF, or index symbols, one per line, e.g. AAPL, SPY, ^SPX. Share classes like BRK.B are converted to Yahoo's BRK-B. Up to 50 per run. Only symbols with US-listed options on Yahoo Finance return data.",
"default": [
"AAPL"
],
"items": {
"type": "string"
}
},
"mode": {
"title": "Mode",
"enum": [
"chain",
"summary",
"unusual"
],
"type": "string",
"description": "Chain: one row per option contract. Summary: one row per ticker with volume, open interest, put/call ratios, average IV, 30-day ATM IV, premium flow, max pain, and a sentiment label. Unusual: only contracts with unusual volume and premium, ranked by score.",
"default": "chain"
},
"contractTypes": {
"title": "Contract types",
"type": "array",
"description": "Choose calls, puts, or both.",
"items": {
"type": "string",
"enum": [
"calls",
"puts"
],
"enumTitles": [
"Calls",
"Puts"
]
},
"default": [
"calls",
"puts"
]
},
"optionsExpirations": {
"title": "Number of expirations",
"minimum": 1,
"maximum": 60,
"type": "integer",
"description": "How many of the nearest expiration dates to fetch per ticker. The nearest expiration is often 0 to 2 days away, where Greeks mean little; 4 to 12 usually reaches a month out. Each extra expiration is one more request.",
"default": 1
},
"expirationDates": {
"title": "Exact expiration dates",
"type": "array",
"description": "Fetch these expiration dates (YYYY-MM-DD), e.g. 2026-11-20. Takes priority over the range and the number of expirations.",
"items": {
"type": "string"
}
},
"expirationFrom": {
"title": "Expirations from",
"type": "string",
"description": "Fetch every expiration on or after this date. Takes priority over the number of expirations."
},
"expirationTo": {
"title": "Expirations to",
"type": "string",
"description": "Fetch every expiration on or before this date."
},
"includeGreeks": {
"title": "Calculate Greeks",
"type": "boolean",
"description": "Add delta, gamma, theta, vega, rho, and a theoretical price, calculated with Black-Scholes-Merton from Yahoo's implied volatility.",
"default": true
},
"riskFreeRate": {
"title": "Risk-free rate",
"minimum": -0.05,
"maximum": 0.25,
"type": "number",
"description": "Rate for the Greeks as a decimal, e.g. 0.043. Leave empty to use the 13-week US Treasury bill yield (^IRX) from Yahoo Finance."
},
"moneyness": {
"title": "Moneyness",
"enum": [
"all",
"inTheMoney",
"outOfTheMoney",
"atTheMoney"
],
"type": "string",
"description": "Keep only in-the-money, out-of-the-money, or at-the-money contracts. At the money means a strike within the ATM tolerance of the underlying price.",
"default": "all"
},
"minStrike": {
"title": "Min strike",
"minimum": 0,
"type": "number",
"description": "Keep strikes at or above this price."
},
"maxStrike": {
"title": "Max strike",
"minimum": 0,
"type": "number",
"description": "Keep strikes at or below this price."
},
"strikeWindowPercent": {
"title": "Strike window (%)",
"minimum": 0,
"maximum": 1000,
"type": "number",
"description": "Keep strikes within this many percent of the underlying price, e.g. 10."
},
"minVolume": {
"title": "Min volume",
"minimum": 0,
"type": "integer",
"description": "Keep contracts that traded at least this many times today."
},
"minOpenInterest": {
"title": "Min open interest",
"minimum": 0,
"type": "integer",
"description": "Keep contracts with at least this much open interest."
},
"minImpliedVolatility": {
"title": "Min implied volatility",
"minimum": 0,
"type": "number",
"description": "Decimal, e.g. 0.3 for 30%. Contracts without IV are dropped."
},
"maxImpliedVolatility": {
"title": "Max implied volatility",
"minimum": 0,
"type": "number",
"description": "Decimal, e.g. 1.5 for 150%. Contracts without IV are dropped."
},
"minDaysToExpiration": {
"title": "Min days to expiration",
"minimum": 0,
"type": "integer",
"description": "Keep expirations at least this many calendar days away. Without exact dates or a range, the nearest expirations inside this window are fetched."
},
"maxDaysToExpiration": {
"title": "Max days to expiration",
"minimum": 0,
"type": "integer",
"description": "Keep expirations at most this many calendar days away."
},
"atmEpsilonPercent": {
"title": "ATM tolerance (%)",
"minimum": 0.1,
"maximum": 50,
"type": "number",
"description": "How close the strike must be to the underlying price to count as at the money, in percent. Minimum 0.1.",
"default": 1.5
},
"unusualVolumeOiRatio": {
"title": "Unusual: min volume / open interest",
"minimum": 0,
"type": "number",
"description": "Unusual mode flags contracts whose volume is at least this many times open interest. Contracts with no open interest yet qualify on volume alone.",
"default": 5
},
"unusualPremiumUsd": {
"title": "Unusual: min premium traded (USD)",
"minimum": 0,
"type": "integer",
"description": "Unusual mode also requires at least this much estimated premium traded (last price x volume x 100).",
"default": 50000
},
"maxItems": {
"title": "Max rows",
"minimum": 1,
"maximum": 25000,
"type": "integer",
"description": "Maximum rows for the whole run. With several tickers, rows are shared round-robin so one ticker can't use up the limit.",
"default": 1000
},
"sortBy": {
"title": "Sort by",
"enum": [
"yahooOrder",
"strikeAsc",
"strikeDesc",
"volumeDesc",
"openInterestDesc",
"impliedVolatilityDesc",
"impliedVolatilityAsc",
"premiumDesc",
"lastTradeNewest",
"nearestStrike",
"moneynessAsc"
],
"type": "string",
"description": "Order of contract rows within each ticker (chain mode). Unusual mode always ranks by score.",
"default": "yahooOrder"
},
"concurrency": {
"title": "Concurrency",
"minimum": 1,
"maximum": 8,
"type": "integer",
"description": "Tickers and requests fetched in parallel over one session.",
"default": 4
},
"maxRetries": {
"title": "Max retries",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Retries per request before a ticker fails.",
"default": 3
},
"requestDelayMs": {
"title": "Request delay (ms)",
"minimum": 0,
"maximum": 10000,
"type": "integer",
"description": "Wait this long before each request.",
"default": 0
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Optional. The Actor switches to Apify Proxy by itself if Yahoo Finance refuses direct requests.",
"default": {
"useApifyProxy": false
}
}
}
},
"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
},
"PROXY_UNBLOCKER_UNITS": {
"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
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}