{
  "openapi": "3.0.1",
  "info": {
    "title": "Yahoo Finance Scraper: Stock Prices, History & Dividends",
    "description": "Yahoo Finance prices for any ticker (stocks, ETFs, indices, crypto, forex): one summary row with price, 52-week range, returns, moving averages and dividend yield, or OHLCV candles from 1 minute to monthly, plus symbol search and news. $0.40 per 1,000 tickers, $0.15 per 1,000 candles.",
    "version": "0.2",
    "x-build-id": "8sgAUU25QC5zlZb3c"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tidyharvest~yahoo-finance-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tidyharvest-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/tidyharvest~yahoo-finance-scraper/runs": {
      "post": {
        "operationId": "runs-sync-tidyharvest-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/tidyharvest~yahoo-finance-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-tidyharvest-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": {
          "tickers": {
            "title": "Tickers",
            "type": "array",
            "description": "Yahoo Finance symbols, one per line: stocks (AAPL, BRK-B, SHOP.TO, 7203.T), ETFs (SPY), indices (^GSPC, ^IXIC), crypto (BTC-USD), forex (EURUSD=X), futures (GC=F). A finance.yahoo.com/quote/... URL also works.",
            "items": {
              "type": "string"
            }
          },
          "outputMode": {
            "title": "Output",
            "enum": [
              "summary",
              "candles",
              "both"
            ],
            "type": "string",
            "description": "summary = one row per ticker with the latest price, change, day and 52-week range, volume, 5d/1m/3m/6m/YTD/1y returns, 50/200-day averages and dividends, plus any data sections you turn on below. candles = one row per OHLCV candle for the period below. both = the summary row plus the candles.",
            "default": "summary"
          },
          "includeStatistics": {
            "title": "Key statistics and valuation",
            "type": "boolean",
            "description": "Market cap, enterprise value, P/E (trailing and forward), PEG, price/book, price/sales, EPS, beta, shares outstanding, float, short interest and short ratio, insider and institutional %, margins, ROE/ROA, revenue, cash, debt, dividend rate and yield, payout ratio, pre/post-market price, bid/ask.",
            "default": false
          },
          "includeProfile": {
            "title": "Company or fund profile",
            "type": "boolean",
            "description": "Sector, industry, employees, address, phone, website, business description, officers with pay, governance risk scores and recent SEC filings. For ETFs and funds: fund family, category, expense ratio, turnover, net assets, top holdings, asset allocation, sector weights and performance.",
            "default": false
          },
          "includeFinancials": {
            "title": "Financial statements",
            "type": "boolean",
            "description": "Income statement, balance sheet and cash flow: annual, quarterly and trailing 12 months, every line item Yahoo Finance has (typically 4 years and 5-6 quarters). Companies only.",
            "default": false
          },
          "includeEarnings": {
            "title": "Earnings",
            "type": "boolean",
            "description": "Next earnings date, EPS and revenue estimates, EPS history (actual vs estimate, surprise), quarterly and yearly revenue and earnings, analyst estimate trends and revisions, ex-dividend and dividend dates.",
            "default": false
          },
          "includeAnalyst": {
            "title": "Analyst ratings and price targets",
            "type": "boolean",
            "description": "Consensus rating, mean/median/high/low price target, number of analysts, monthly recommendation trend (strong buy to strong sell), the full upgrade/downgrade history with firms and target changes, growth estimates vs the index.",
            "default": false
          },
          "includeOwnership": {
            "title": "Ownership",
            "type": "boolean",
            "description": "Insider and institutional % held, top institutional and fund holders (shares, value, % change), insider holders, insider transactions, 6-month insider buying and selling.",
            "default": false
          },
          "includeInsights": {
            "title": "Insights and technical outlook",
            "type": "boolean",
            "description": "Short, intermediate and long-term technical outlook, support, resistance and stop-loss levels, valuation (over/undervalued), research rating and target, bull and bear case, technical events, significant developments and recent research report titles.",
            "default": false
          },
          "includeSimilar": {
            "title": "Similar symbols",
            "type": "boolean",
            "description": "Symbols people also look at, with a relevance score.",
            "default": false
          },
          "includeNews": {
            "title": "Latest news per ticker",
            "type": "boolean",
            "description": "The latest Yahoo Finance headlines for each ticker (title, publisher, time, related tickers, link).",
            "default": false
          },
          "maxNewsPerTicker": {
            "title": "News items per ticker",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many headlines per ticker when news is on (max 50).",
            "default": 10
          },
          "includeOptions": {
            "title": "Options chain",
            "type": "boolean",
            "description": "Calls and puts with strike, last price, change, bid, ask, volume, open interest, implied volatility, in-the-money flag and last trade time, plus every listed expiration date. Nearest expiration unless you choose below.",
            "default": false
          },
          "optionAllExpirations": {
            "title": "All expirations",
            "type": "boolean",
            "description": "Return the chain for every listed expiration (large for index ETFs: SPY lists 30+). Very large chains are cut at about 7 MB per ticker and the remaining dates listed in expirationsNotReturned.",
            "default": false
          },
          "optionDates": {
            "title": "Specific expiration dates",
            "type": "array",
            "description": "Only these expirations (YYYY-MM-DD, e.g. 2026-12-18). Dates that aren't listed are reported in requestedDatesNotListed. Leave empty for the nearest expiration.",
            "items": {
              "type": "string"
            }
          },
          "optionStrikesAroundPrice": {
            "title": "Strikes around the price",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only the N strikes above and N below the current price in each expiration (e.g. 10). 0 or empty = all strikes."
          },
          "screeners": {
            "title": "Screeners",
            "type": "array",
            "description": "Yahoo Finance's predefined lists: day gainers and losers, most active, most shorted, undervalued growth, sector lists, top ETFs and funds, crypto, private companies, options. Each symbol on the list gets a summary row (and any data sections you turn on), tagged with discoveredBy.",
            "items": {
              "type": "string",
              "enum": [
                "DAY_GAINERS",
                "DAY_LOSERS",
                "MOST_ACTIVES",
                "MOST_SHORTED_STOCKS",
                "MOST_WATCHED_TICKERS",
                "UNDERVALUED_GROWTH_STOCKS",
                "UNDERVALUED_LARGE_CAPS",
                "STRONG_UNDERVALUED_STOCKS",
                "GROWTH_TECHNOLOGY_STOCKS",
                "AGGRESSIVE_SMALL_CAPS",
                "SMALL_CAP_GAINERS",
                "MOST_ACTIVE_PENNY_STOCKS",
                "FIFTY_TWO_WK_GAINERS",
                "FIFTY_TWO_WK_LOSERS",
                "MS_TECHNOLOGY",
                "MS_HEALTHCARE",
                "MS_FINANCIAL_SERVICES",
                "MS_CONSUMER_CYCLICAL",
                "MS_CONSUMER_DEFENSIVE",
                "MS_COMMUNICATION_SERVICES",
                "MS_INDUSTRIALS",
                "MS_ENERGY",
                "MS_BASIC_MATERIALS",
                "MS_REAL_ESTATE",
                "MS_UTILITIES",
                "TOP_ETFS_US",
                "TOP_PERFORMING_ETFS",
                "TECHNOLOGY_ETFS",
                "BOND_ETFS",
                "DAY_GAINERS_ETFS",
                "DAY_LOSERS_ETFS",
                "MOST_ACTIVES_ETFS",
                "TOP_MUTUAL_FUNDS",
                "DAY_GAINERS_MUTUAL_FUNDS",
                "DAY_LOSERS_MUTUAL_FUNDS",
                "PORTFOLIO_ANCHORS",
                "SOLID_LARGE_GROWTH_FUNDS",
                "SOLID_MIDCAP_GROWTH_FUNDS",
                "CONSERVATIVE_FOREIGN_FUNDS",
                "HIGH_YIELD_BOND",
                "ALL_CRYPTOCURRENCIES_US",
                "DAY_GAINERS_CRYPTOCURRENCIES",
                "DAY_LOSERS_CRYPTOCURRENCIES",
                "MOST_ACTIVES_CRYPTOCURRENCIES",
                "HIGHEST_VALUATION_PRIVATE_COMPANY",
                "MOST_FUNDED_PRIVATE_COMPANY",
                "RECENTLY_FUNDED_PRIVATE_COMPANY",
                "TOP_OPTIONS_OPEN_INTEREST",
                "TOP_OPTIONS_IMPLIED_VOLATALITY"
              ],
              "enumTitles": [
                "Day gainers",
                "Day losers",
                "Most active",
                "Most shorted stocks",
                "Most watched tickers",
                "Undervalued growth stocks",
                "Undervalued large caps",
                "Strong undervalued stocks",
                "Growth technology stocks",
                "Aggressive small caps",
                "Small-cap gainers",
                "Most active penny stocks",
                "52-week gainers",
                "52-week losers",
                "Sector: technology",
                "Sector: healthcare",
                "Sector: financial services",
                "Sector: consumer cyclical",
                "Sector: consumer defensive",
                "Sector: communication services",
                "Sector: industrials",
                "Sector: energy",
                "Sector: basic materials",
                "Sector: real estate",
                "Sector: utilities",
                "Top ETFs (US)",
                "Top performing ETFs",
                "Technology ETFs",
                "Bond ETFs",
                "ETF day gainers",
                "ETF day losers",
                "Most active ETFs",
                "Top mutual funds",
                "Mutual fund day gainers",
                "Mutual fund day losers",
                "Portfolio anchors (funds)",
                "Solid large-growth funds",
                "Solid mid-cap growth funds",
                "Conservative foreign funds",
                "High-yield bond funds",
                "All cryptocurrencies (US)",
                "Crypto day gainers",
                "Crypto day losers",
                "Most active crypto",
                "Private companies: highest valuation",
                "Private companies: most funded",
                "Private companies: recently funded",
                "Options: highest open interest",
                "Options: highest implied volatility"
              ]
            }
          },
          "trendingRegions": {
            "title": "Trending tickers in",
            "type": "array",
            "description": "Country codes (US, GB, DE, FR, CA, AU, IN, HK, ...): the tickers trending on Yahoo Finance there right now.",
            "items": {
              "type": "string"
            }
          },
          "maxDiscoveryResults": {
            "title": "Max tickers per screener or trending list",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "How many symbols to take from each screener or trending list, in Yahoo's order (trending lists have up to 100).",
            "default": 25
          },
          "range": {
            "title": "Period (candles)",
            "enum": [
              "1d",
              "5d",
              "1mo",
              "3mo",
              "6mo",
              "ytd",
              "1y",
              "2y",
              "5y",
              "10y",
              "max"
            ],
            "type": "string",
            "description": "How far back the candles go. Ignored when a start date is set.",
            "default": "1mo"
          },
          "interval": {
            "title": "Candle size",
            "enum": [
              "1m",
              "2m",
              "5m",
              "15m",
              "30m",
              "60m",
              "90m",
              "1h",
              "1d",
              "5d",
              "1wk",
              "1mo",
              "3mo"
            ],
            "type": "string",
            "description": "Yahoo limits intraday history: 1m only for the last ~30 days (7 days per request), other minute/hour sizes for the last ~60 days (1h: ~730 days). Daily and longer go back to the first trade.",
            "default": "1d"
          },
          "startDate": {
            "title": "Start date",
            "type": "string",
            "description": "Optional. YYYY-MM-DD, or a relative period like '30 days', '6 months', '2 years'. Overrides the period."
          },
          "endDate": {
            "title": "End date",
            "type": "string",
            "description": "Optional, inclusive. Defaults to now."
          },
          "includePrePost": {
            "title": "Include pre/post-market candles",
            "type": "boolean",
            "description": "Intraday candles only: also return extended-hours trading.",
            "default": false
          },
          "adjustedPrices": {
            "title": "Adjust OHLC for splits and dividends",
            "type": "boolean",
            "description": "Scale open/high/low/close by the adjusted-close factor (total-return series). adjClose is always included for daily and longer candles.",
            "default": false
          },
          "maxCandlesPerTicker": {
            "title": "Max candles per ticker",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only the most recent N candles per ticker. 0 or empty = all in the period."
          },
          "includeEvents": {
            "title": "Include dividends and splits",
            "type": "boolean",
            "description": "Candles carry a dividend amount / split ratio on the candle where it happened; summary rows list the past year's dividends and splits.",
            "default": true
          },
          "searchQueries": {
            "title": "Search queries",
            "type": "array",
            "description": "Free text, e.g. a company name. Returns matching symbols (with exchange, type, sector, industry) and the latest related Yahoo Finance news headlines.",
            "items": {
              "type": "string"
            }
          },
          "maxSymbolsPerQuery": {
            "title": "Max symbol matches per query",
            "minimum": 0,
            "maximum": 25,
            "type": "integer",
            "description": "How many matching symbols to return per search query (max 25).",
            "default": 10
          },
          "maxNewsPerQuery": {
            "title": "Max news items per query",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "How many news headlines to return per search query (0 = none, max 50).",
            "default": 10
          },
          "scrapeSearchMatches": {
            "title": "Also scrape the top match of each search",
            "type": "boolean",
            "description": "Adds each query's best symbol match to the ticker list, so 'apple' gets you AAPL's summary/candles.",
            "default": false
          },
          "lang": {
            "title": "Language",
            "type": "string",
            "description": "Language for news and text fields, e.g. en-US, en-GB, de-DE, fr-FR, ja-JP, zh-Hant-HK.",
            "default": "en-US"
          },
          "region": {
            "title": "Region",
            "type": "string",
            "description": "Market region for news and screeners, e.g. US, GB, DE, JP, HK, AU, CA, FR.",
            "default": "US"
          },
          "maxItems": {
            "title": "Max rows in total",
            "minimum": 0,
            "type": "integer",
            "description": "Hard cap on all rows (summaries + candles + search results) for the run; also caps your cost. 0 or empty = no limit."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}