{
  "openapi": "3.0.1",
  "info": {
    "title": "Yahoo Options Scraper [💰$1.2/1K] | Greeks | IV | Live Chains",
    "description": "Extract Yahoo Finance options chains with full Greeks, volume and implied volatility data for any ticker. Build options screeners, volatility research and pricing models.",
    "version": "2.0",
    "x-build-id": "ekic8cdHxDbbPPZSJ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/ahmed_jasarevic~yahoo-finance-options/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-ahmed_jasarevic-yahoo-finance-options",
        "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/ahmed_jasarevic~yahoo-finance-options/runs": {
      "post": {
        "operationId": "runs-sync-ahmed_jasarevic-yahoo-finance-options",
        "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/ahmed_jasarevic~yahoo-finance-options/run-sync": {
      "post": {
        "operationId": "run-sync-ahmed_jasarevic-yahoo-finance-options",
        "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",
        "required": [
          "tickers"
        ],
        "properties": {
          "tickers": {
            "title": "Ticker symbols",
            "maxItems": 50,
            "type": "array",
            "description": "One or more Yahoo Finance symbols. Stocks, ETFs, indices (<code>^GSPC</code>), crypto pairs (<code>BTC-USD</code>) and forex (<code>EURUSD=X</code>) are accepted; only symbols with listed options return contracts. Maximum 50 per run.",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 25
            }
          },
          "mode": {
            "title": "Output mode",
            "enum": [
              "chain",
              "summary",
              "unusual"
            ],
            "type": "string",
            "description": "<b>chain</b> = one row per contract. <b>summary</b> = one analytics row per ticker (put/call ratios, 30-day IV, skew, sentiment). <b>unusual</b> = only contracts whose volume dwarfs their open interest, priced as a separate event.",
            "default": "chain"
          },
          "contractTypes": {
            "title": "Contract types",
            "type": "array",
            "description": "Which sides of the chain to return.",
            "items": {
              "type": "string"
            },
            "default": [
              "calls",
              "puts"
            ]
          },
          "expirationDates": {
            "title": "Exact expiration dates",
            "type": "array",
            "description": "Optional list of Yahoo-listed expiration dates in <code>YYYY-MM-DD</code> format. When set, <b>Expirations per ticker</b> is ignored. Takes priority over the date range.",
            "items": {
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            },
            "default": []
          },
          "expirationFrom": {
            "title": "Expiration from",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "type": "string",
            "description": "Earliest expiration to include, <code>YYYY-MM-DD</code>. Use with <b>Expiration to</b> to pull every expiry in a window (capped at 12)."
          },
          "expirationTo": {
            "title": "Expiration to",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "type": "string",
            "description": "Latest expiration to include, <code>YYYY-MM-DD</code>."
          },
          "optionsExpirations": {
            "title": "Expirations per ticker",
            "minimum": 1,
            "maximum": 12,
            "type": "integer",
            "description": "How many nearest expiration dates to fetch per ticker. Each expiration is a full call + put chain, so this multiplies the request count. Used when neither <b>Exact expiration dates</b> nor the date range is set.",
            "default": 1
          },
          "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 is the strike closest to the underlying price in each expiration.",
            "default": "all"
          },
          "minStrike": {
            "title": "Minimum strike",
            "minimum": 0,
            "type": "number",
            "description": "Inclusive lower strike bound."
          },
          "maxStrike": {
            "title": "Maximum strike",
            "minimum": 0,
            "type": "number",
            "description": "Inclusive upper strike bound."
          },
          "strikeWindowPercent": {
            "title": "Strike window around spot (%)",
            "minimum": 0,
            "maximum": 1000,
            "type": "number",
            "description": "Keep only strikes within this percentage of the underlying price, e.g. <code>10</code> keeps strikes within 10% either side. The main lever for cutting row counts."
          },
          "minVolume": {
            "title": "Minimum volume",
            "minimum": 0,
            "type": "number",
            "description": "Skip contracts trading fewer contracts today. Missing volume counts as 0."
          },
          "minOpenInterest": {
            "title": "Minimum open interest",
            "minimum": 0,
            "type": "number",
            "description": "Skip contracts with open interest below this. Missing open interest counts as 0."
          },
          "minImpliedVolatility": {
            "title": "Minimum implied volatility",
            "minimum": 0,
            "type": "number",
            "description": "Keep contracts at or above this decimal implied volatility, e.g. <code>0.25</code> means 25%. Contracts with no IV are dropped."
          },
          "maxImpliedVolatility": {
            "title": "Maximum implied volatility",
            "minimum": 0,
            "type": "number",
            "description": "Drop contracts above this decimal implied volatility."
          },
          "minDaysToExpiration": {
            "title": "Minimum days to expiration",
            "minimum": 0,
            "maximum": 3650,
            "type": "integer",
            "description": "Drop contracts expiring sooner than this many days."
          },
          "maxDaysToExpiration": {
            "title": "Maximum days to expiration",
            "minimum": 0,
            "maximum": 3650,
            "type": "integer",
            "description": "Drop contracts expiring later than this many days. Useful for near-dated flow."
          },
          "includeGreeks": {
            "title": "Include Greeks",
            "type": "boolean",
            "description": "Compute Black-Scholes delta, gamma, theta (per day), vega (per volatility point), rho and theoretical price from Yahoo's implied volatility. The risk-free rate is read from <code>^IRX</code> unless you override it.",
            "default": true
          },
          "riskFreeRate": {
            "title": "Risk-free rate override",
            "minimum": 0,
            "maximum": 1,
            "type": "number",
            "description": "Annual rate as a decimal, e.g. <code>0.0425</code> for 4.25%. Leave empty to fetch the 13-week T-bill from Yahoo automatically."
          },
          "sortBy": {
            "title": "Sort contracts by",
            "enum": [
              "yahooOrder",
              "strikeAsc",
              "strikeDesc",
              "volumeDesc",
              "openInterestDesc",
              "impliedVolatilityDesc",
              "impliedVolatilityAsc",
              "premiumDesc",
              "lastTradeNewest",
              "nearestStrike",
              "moneynessAsc"
            ],
            "type": "string",
            "description": "Order applied before <b>Max results</b> truncates the output. <b>nearestStrike</b> keeps the strikes closest to spot when you only need a few rows.",
            "default": "yahooOrder"
          },
          "maxItems": {
            "title": "Max results",
            "minimum": 1,
            "maximum": 25000,
            "type": "integer",
            "description": "Hard cap on dataset rows for the whole run. The cap is shared fairly across tickers (round-robin) so no single symbol starves the others. Free accounts are capped at 50.",
            "default": 1000
          },
          "unusualVolumeOiRatio": {
            "title": "Unusual mode: min volume / open interest",
            "minimum": 0,
            "type": "number",
            "description": "A contract is flagged when today's volume is at least this multiple of its open interest. Contracts with no open interest yet qualify on volume alone. Default 5.",
            "default": 5
          },
          "unusualPremiumUsd": {
            "title": "Unusual mode: min traded premium (USD)",
            "minimum": 0,
            "type": "number",
            "description": "Only report contracts whose estimated traded premium (volume x last price x 100) reaches this amount. Default 50000.",
            "default": 50000
          },
          "atmEpsilonPercent": {
            "title": "At-the-money tolerance (%)",
            "minimum": 0.1,
            "maximum": 10,
            "type": "number",
            "description": "How close to spot a strike must be to count as ATM, as a percentage of the underlying price. Default 1.5%, which captures the 2-4 nearest strikes. Values below 0.5% often match no strikes at all and make the atTheMoney moneyness filter return nothing.",
            "default": 1.5
          },
          "concurrency": {
            "title": "Concurrency",
            "minimum": 1,
            "maximum": 8,
            "type": "integer",
            "description": "Tickers fetched in parallel over one sticky proxy session. Raising this speeds up bulk runs; higher values raise the chance of Yahoo throttling.",
            "default": 4
          },
          "maxRetries": {
            "title": "Max retries",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Retries per request. On 401/403/429 the Actor re-establishes the Yahoo session (new cookie + crumb) before retrying.",
            "default": 3
          },
          "requestDelayMs": {
            "title": "Delay between requests (ms)",
            "minimum": 0,
            "maximum": 10000,
            "type": "integer",
            "description": "Throttle Yahoo requests. Raise this if you hit rate limits on large runs.",
            "default": 0
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "The Actor keeps one sticky session so the cookie and crumb come from the same IP. Turn on residential proxies if Yahoo challenges datacenter traffic."
          },
          "limitPerTicker": {
            "title": "Limit per ticker (deprecated)",
            "minimum": 1,
            "maximum": 25000,
            "type": "integer",
            "description": "Deprecated. Rows per ticker per side, used before v2.0. Still accepted so existing schedules keep working, and is converted to <b>Max results</b> automatically. Ignored when <b>Max results</b> is set explicitly.",
            "default": 20
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}