{
  "openapi": "3.0.1",
  "info": {
    "title": "Yahoo Finance Scraper",
    "description": "Yahoo Finance data without an API key or login: quotes, fundamentals, financial statements, ETF holdings, news and price history by ticker, a stock screener with 100+ filters or 20 ready-made screens, and option chains with implied volatility and Greeks.",
    "version": "1.1",
    "x-build-id": "YsbaaihQqQMIAKACo"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sheshinmcfly~yahoo-finance-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sheshinmcfly-yahoo-finance-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/sheshinmcfly~yahoo-finance-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sheshinmcfly-yahoo-finance-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/sheshinmcfly~yahoo-finance-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sheshinmcfly-yahoo-finance-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": {
          "mode": {
            "title": "What to fetch",
            "enum": [
              "symbols",
              "screener",
              "options"
            ],
            "type": "string",
            "description": "Symbols (default): quotes, fundamentals and/or price history for your tickers, exactly as always. Screener: find stocks with your own filters or one of 20 ready-made Yahoo screens. Options: full option chains with implied volatility and Greeks for your tickers.",
            "default": "symbols"
          },
          "symbols": {
            "title": "Ticker symbols",
            "type": "array",
            "description": "Stock, ETF or index ticker symbols to fetch, e.g. AAPL, MSFT, TSLA, ^GSPC, BTC-USD. Used by Symbols and Options mode (not needed for Screener).",
            "items": {
              "type": "string"
            }
          },
          "dataTypes": {
            "title": "Data to extract",
            "type": "array",
            "description": "Which data blocks to include per symbol (Symbols mode). Quote, price history, fundamentals with the analyst breakdown, financial statements (4 years + last quarters of income, balance sheet and cash flow), ETF/fund holdings and returns, and news headlines. Any combination, still one result per symbol.",
            "items": {
              "type": "string",
              "enum": [
                "quote",
                "historical",
                "fundamentals",
                "statements",
                "etf",
                "news"
              ],
              "enumTitles": [
                "Quote (price, volume, market cap, P/E, 52-week range)",
                "Historical prices (OHLCV time series)",
                "Fundamentals (sector, margins, ROE, debt, cash flow, targets)",
                "Financial statements (income, balance sheet, cash flow — 4 years + recent quarters)",
                "ETF / fund data (top holdings, sector weights, expense ratio, returns, risk)",
                "News headlines (title, publisher, link, time)"
              ]
            },
            "default": [
              "quote"
            ]
          },
          "range": {
            "title": "Historical range",
            "enum": [
              "1d",
              "5d",
              "1mo",
              "3mo",
              "6mo",
              "1y",
              "2y",
              "5y",
              "10y",
              "max"
            ],
            "type": "string",
            "description": "Time span for historical prices (only used when 'Historical prices' is selected).",
            "default": "1mo"
          },
          "interval": {
            "title": "Historical interval",
            "enum": [
              "1d",
              "1wk",
              "1mo"
            ],
            "type": "string",
            "description": "Candle size for historical prices (only used when 'Historical prices' is selected).",
            "default": "1d"
          },
          "newsCount": {
            "title": "News headlines per symbol",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many recent headlines to include when News is selected (up to 50).",
            "default": 10
          },
          "maxResults": {
            "title": "Max results (screener and options)",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Maximum rows for Screener mode (stocks) and Options mode (contracts, across all symbols). Symbols mode always returns one row per symbol.",
            "default": 100
          },
          "screenPreset": {
            "title": "Ready-made screen",
            "enum": [
              "",
              "day_gainers",
              "day_losers",
              "most_actives",
              "growth_technology_stocks",
              "undervalued_growth_stocks",
              "undervalued_large_caps",
              "aggressive_small_caps",
              "small_cap_gainers",
              "most_shorted_stocks",
              "portfolio_anchors",
              "solid_large_growth_funds",
              "solid_midcap_growth_funds",
              "top_mutual_funds",
              "conservative_foreign_funds",
              "high_yield_bond",
              "day_gainers_mutual_funds",
              "all_cryptocurrencies_us",
              "day_gainers_cryptocurrencies",
              "day_losers_cryptocurrencies",
              "most_actives_cryptocurrencies"
            ],
            "type": "string",
            "description": "One of Yahoo Finance's 20 predefined screens. When set, the custom filters below are ignored.",
            "default": ""
          },
          "screenRegion": {
            "title": "Region",
            "enum": [
              "us",
              "ca",
              "gb",
              "de",
              "fr",
              "es",
              "it",
              "nl",
              "ch",
              "se",
              "jp",
              "hk",
              "cn",
              "in",
              "kr",
              "tw",
              "sg",
              "au",
              "br",
              "mx",
              "ar",
              "cl",
              "za",
              "il"
            ],
            "type": "string",
            "description": "Market to screen.",
            "default": "us"
          },
          "screenSector": {
            "title": "Sector",
            "enum": [
              "",
              "Technology",
              "Healthcare",
              "Financial Services",
              "Consumer Cyclical",
              "Industrials",
              "Communication Services",
              "Consumer Defensive",
              "Energy",
              "Basic Materials",
              "Real Estate",
              "Utilities"
            ],
            "type": "string",
            "description": "Keep only one sector.",
            "default": ""
          },
          "screenIndustry": {
            "title": "Industry",
            "type": "string",
            "description": "Exact industry name, e.g. Semiconductors, Biotechnology, Banks - Regional, Software - Infrastructure.",
            "default": ""
          },
          "screenMinMarketCapB": {
            "title": "Min market cap (USD billions)",
            "type": "number",
            "description": "e.g. 10 = over $10B."
          },
          "screenMaxMarketCapB": {
            "title": "Max market cap (USD billions)",
            "type": "number",
            "description": "e.g. 2 = under $2B."
          },
          "screenMinPE": {
            "title": "Min P/E (trailing)",
            "type": "number",
            "description": "Lower bound for the trailing price/earnings ratio."
          },
          "screenMaxPE": {
            "title": "Max P/E (trailing)",
            "type": "number",
            "description": "Upper bound for the trailing price/earnings ratio."
          },
          "screenMinDividendYield": {
            "title": "Min dividend yield (%)",
            "type": "number",
            "description": "e.g. 3 = forward yield over 3%."
          },
          "screenMinPrice": {
            "title": "Min price",
            "type": "number",
            "description": "Lowest share price."
          },
          "screenMaxPrice": {
            "title": "Max price",
            "type": "number",
            "description": "Highest share price."
          },
          "screenMinAvgVolume": {
            "title": "Min average volume (3 months)",
            "type": "number",
            "description": "e.g. 1000000 for liquid names only."
          },
          "screenMinChangePercent": {
            "title": "Min change today (%)",
            "type": "number",
            "description": "e.g. 5 = up more than 5% today."
          },
          "screenMaxChangePercent": {
            "title": "Max change today (%)",
            "type": "number",
            "description": "e.g. -5 = down more than 5% today."
          },
          "screenFilters": {
            "title": "More filters (advanced)",
            "type": "array",
            "description": "Any extra condition on Yahoo's screener fields, one per line: \"returnonequity.lasttwelvemonths > 20\", \"short_percentage_of_float.value >= 15\", \"beta between 0.5 and 1.2\", \"pctheldinst > 60\". Every field is checked first; an unknown one stops the run with a clear message instead of returning every stock.",
            "items": {
              "type": "string"
            }
          },
          "screenSortBy": {
            "title": "Sort by",
            "enum": [
              "marketCap",
              "percentChange",
              "volume",
              "avgVolume",
              "peRatio",
              "dividendYield",
              "price",
              "fiftyTwoWeekChange",
              "shortPercentOfFloat",
              "returnOnEquity",
              "revenueGrowth"
            ],
            "type": "string",
            "description": "Order of the results (custom filters only).",
            "default": "marketCap"
          },
          "screenSortOrder": {
            "title": "Sort order",
            "enum": [
              "desc",
              "asc"
            ],
            "type": "string",
            "description": "Direction of the sort.",
            "default": "desc"
          },
          "optionsType": {
            "title": "Calls, puts or both",
            "enum": [
              "both",
              "calls",
              "puts"
            ],
            "type": "string",
            "description": "Which side of the chain to return.",
            "default": "both"
          },
          "optionsExpirations": {
            "title": "Expirations per symbol",
            "minimum": 1,
            "maximum": 40,
            "type": "integer",
            "description": "How many upcoming expiration dates to fetch per symbol, nearest first.",
            "default": 1
          },
          "optionsExpirationDate": {
            "title": "Specific expiration date",
            "type": "string",
            "description": "Optional YYYY-MM-DD. When set, only that expiration is returned (overrides the number above).",
            "default": ""
          },
          "optionsStrikeRangePct": {
            "title": "Strikes within ±% of the price",
            "minimum": 0,
            "type": "number",
            "description": "e.g. 10 = only strikes within 10% of the current share price. 0 = all strikes.",
            "default": 0
          },
          "includeGreeks": {
            "title": "Include Greeks",
            "type": "boolean",
            "description": "Delta, gamma, theta (per day), vega and rho (per 1 percentage point), computed with Black-Scholes from the implied volatility.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify datacenter proxies work for Yahoo Finance. Switch to Residential only if you hit rate limits.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}