{
  "openapi": "3.0.1",
  "info": {
    "title": "Yahoo Finance Scraper: Stock Quotes, History & Fundamentals",
    "description": "Yahoo Finance scraper and API: live quotes, price history (OHLCV), key statistics, analyst targets, earnings, financial statements, ETF holdings, news and options for stocks, ETFs, crypto, forex and indices. $0.30 per 1,000 symbols. No API key.",
    "version": "0.1",
    "x-build-id": "8uifE64z5Iuo9Q7VA"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/datagleaner~yahoo-finance-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-datagleaner-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/datagleaner~yahoo-finance-scraper/runs": {
      "post": {
        "operationId": "runs-sync-datagleaner-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/datagleaner~yahoo-finance-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-datagleaner-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": {
          "symbols": {
            "title": "Symbols",
            "type": "array",
            "description": "Yahoo Finance symbols: stocks (AAPL, TSLA, 7203.T, VOD.L, RELIANCE.NS), ETFs and funds (SPY, VOO, VFIAX), indices (^GSPC, ^IXIC), crypto (BTC-USD), forex (EURUSD=X) and futures (GC=F, CL=F). One record per symbol.",
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "Company names to look up",
            "type": "array",
            "description": "Names or partial names (Toyota, Nvidia, Vanguard S&P 500). Each is matched to Yahoo Finance's best symbol, which is then scraped like a symbol above.",
            "items": {
              "type": "string"
            }
          },
          "screener": {
            "title": "Predefined screener",
            "enum": [
              "",
              "day_gainers",
              "day_losers",
              "most_actives",
              "undervalued_growth_stocks",
              "growth_technology_stocks",
              "aggressive_small_caps",
              "small_cap_gainers",
              "undervalued_large_caps",
              "most_shorted_stocks",
              "top_etfs_us",
              "top_mutual_funds",
              "portfolio_anchors",
              "solid_large_growth_funds",
              "high_yield_bond",
              "conservative_foreign_funds",
              "all_cryptocurrencies_us",
              "day_gainers_cryptocurrencies"
            ],
            "type": "string",
            "description": "Take the symbols from one of Yahoo Finance's predefined screeners, in Yahoo's order (e.g. today's top gainers). Combined with any symbols above."
          },
          "maxScreenerResults": {
            "title": "Max screener results",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "How many symbols to take from the screener.",
            "default": 25
          },
          "includeProfile": {
            "title": "Company profile",
            "type": "boolean",
            "description": "Sector, industry, website, employees, business description, address and officers.",
            "default": true
          },
          "includeStatistics": {
            "title": "Key statistics",
            "type": "boolean",
            "description": "Valuation (enterprise value, PEG, price/sales), margins, growth, cash, debt, ratios, cash flow, float, short interest and ownership.",
            "default": true
          },
          "includeAnalyst": {
            "title": "Analyst targets and earnings",
            "type": "boolean",
            "description": "Price targets, recommendation and its 4-month trend, next earnings date and estimates, last 4 quarters of EPS actual vs estimate, yearly revenue and earnings.",
            "default": true
          },
          "includeHistory": {
            "title": "Price history",
            "type": "boolean",
            "description": "OHLCV bars with adjusted close, plus dividends and splits, for the range and interval below.",
            "default": true
          },
          "historyRange": {
            "title": "History range",
            "enum": [
              "1d",
              "5d",
              "1mo",
              "3mo",
              "6mo",
              "1y",
              "2y",
              "5y",
              "10y",
              "ytd",
              "max"
            ],
            "type": "string",
            "description": "How far back the price history goes. Ignored when a start or end date is set.",
            "default": "1y"
          },
          "historyInterval": {
            "title": "Bar interval",
            "enum": [
              "1m",
              "2m",
              "5m",
              "15m",
              "30m",
              "60m",
              "90m",
              "1h",
              "1d",
              "5d",
              "1wk",
              "1mo",
              "3mo"
            ],
            "type": "string",
            "description": "Bar size. Yahoo keeps 1-minute bars for the last 7 days, other intraday bars for 60 days (hourly for 2 years); longer requests are cut to that window.",
            "default": "1d"
          },
          "historyStartDate": {
            "title": "History start date",
            "type": "string",
            "description": "Optional YYYY-MM-DD. Overrides the range."
          },
          "historyEndDate": {
            "title": "History end date",
            "type": "string",
            "description": "Optional YYYY-MM-DD (inclusive). Defaults to today."
          },
          "historyAsRows": {
            "title": "Output history as one row per bar",
            "type": "boolean",
            "description": "Off: the bars sit inside each symbol record (no extra charge). On: each bar is its own dataset row (symbol, date, open, high, low, close, adjClose, volume), ready for a spreadsheet or backtest, billed per bar.",
            "default": false
          },
          "includeFinancials": {
            "title": "Financial statements",
            "type": "boolean",
            "description": "Annual (last 4 years) and quarterly (last 5 quarters) revenue, gross profit, operating income, net income, diluted EPS, EBITDA, assets, liabilities, equity, cash, debt, operating cash flow, capex and free cash flow.",
            "default": false
          },
          "includeNews": {
            "title": "News",
            "type": "boolean",
            "description": "Latest Yahoo Finance news headlines for the symbol, with publisher, link, time and related symbols.",
            "default": false
          },
          "maxNewsPerSymbol": {
            "title": "Max news per symbol",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Headlines per symbol when news is on.",
            "default": 10
          },
          "includeOptions": {
            "title": "Options chain",
            "type": "boolean",
            "description": "Calls and puts with strike, bid, ask, last price, volume, open interest, implied volatility and in-the-money flag.",
            "default": false
          },
          "maxOptionExpirations": {
            "title": "Option expirations",
            "minimum": 1,
            "maximum": 60,
            "type": "integer",
            "description": "How many expiration dates to fetch, nearest first. All expiration dates are always listed.",
            "default": 1
          },
          "optionsAsRows": {
            "title": "Output options as one row per contract",
            "type": "boolean",
            "description": "Off: contracts sit inside each symbol record (no extra charge). On: each contract is its own dataset row, billed per contract.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Symbols fetched at the same time.",
            "default": 5
          },
          "requestDelaySeconds": {
            "title": "Delay between requests (seconds)",
            "minimum": 0,
            "maximum": 10,
            "type": "number",
            "description": "Extra pause after each request, per worker.",
            "default": 0
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. By default the Actor connects directly and moves to Apify Proxy on its own if Yahoo rate-limits the run."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}