{
  "openapi": "3.0.1",
  "info": {
    "title": "Yahoo Finance Scraper: Quotes, Fundamentals & History",
    "description": "Yahoo Finance data for any ticker: quote, profile, key stats, analysts, holders, earnings. $0.50 per 1,000 symbols. Statements, price history, options, news.",
    "version": "0.1",
    "x-build-id": "RB7EFcpHjx9jx1pNi"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/luzivanlt~yahoo-finance-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-luzivanlt-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/luzivanlt~yahoo-finance-scraper/runs": {
      "post": {
        "operationId": "runs-sync-luzivanlt-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/luzivanlt~yahoo-finance-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-luzivanlt-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": "Ticker symbols",
            "type": "array",
            "description": "Ticker symbols as Yahoo Finance writes them, one per line, up to 500 per run: stocks, ETFs, funds, indices, crypto, currencies and futures from any exchange Yahoo covers. A Yahoo Finance quote link works too. Each symbol is one row. Example: AAPL, 7203.T, BTC-USD, EURUSD=X, ^GSPC",
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "Search queries",
            "type": "array",
            "description": "Company or fund names to look up, one per line. Each query is read as Yahoo Finance's own search box answers it, and every symbol it finds becomes a row, up to Max symbols per list (Yahoo itself returns only a handful per query). Example: nvidia",
            "items": {
              "type": "string"
            }
          },
          "trendingRegions": {
            "title": "Trending symbols in",
            "type": "array",
            "description": "Markets whose trending tickers to read: each region's list as Yahoo Finance shows it now, up to 100 symbols, each one a full row like a symbol you typed. Pick none to skip. Example: [\"US\", \"GB\"]",
            "items": {
              "type": "string",
              "enum": [
                "US",
                "GB",
                "CA",
                "AU",
                "IN",
                "DE",
                "FR",
                "ES",
                "IT",
                "HK",
                "SG",
                "TW",
                "BR",
                "NZ"
              ],
              "enumTitles": [
                "United States",
                "United Kingdom",
                "Canada",
                "Australia",
                "India",
                "Germany",
                "France",
                "Spain",
                "Italy",
                "Hong Kong",
                "Singapore",
                "Taiwan",
                "Brazil",
                "New Zealand"
              ]
            }
          },
          "screeners": {
            "title": "Screeners",
            "type": "array",
            "description": "Yahoo Finance's ready-made screeners (day gainers, most active, undervalued growth stocks, top ETFs and more): every symbol on each one becomes a full row, in the screener's order, up to Max symbols per list. Example: [\"day_gainers\", \"most_actives\"]",
            "items": {
              "type": "string",
              "enum": [
                "day_gainers",
                "day_losers",
                "most_actives",
                "most_watched_tickers",
                "most_shorted_stocks",
                "undervalued_growth_stocks",
                "growth_technology_stocks",
                "aggressive_small_caps",
                "small_cap_gainers",
                "undervalued_large_caps",
                "portfolio_anchors",
                "top_etfs_us",
                "top_mutual_funds",
                "solid_large_growth_funds",
                "solid_midcap_growth_funds",
                "conservative_foreign_funds",
                "high_yield_bond"
              ],
              "enumTitles": [
                "Day gainers",
                "Day losers",
                "Most active",
                "Most watched",
                "Most shorted stocks",
                "Undervalued growth stocks",
                "Growth technology stocks",
                "Aggressive small caps",
                "Small cap gainers",
                "Undervalued large caps",
                "Portfolio anchors",
                "Top ETFs (US)",
                "Top mutual funds",
                "Solid large growth funds",
                "Solid mid-cap growth funds",
                "Conservative foreign funds",
                "High yield bond funds"
              ]
            }
          },
          "maxSymbolsPerList": {
            "title": "Max symbols per list",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Stop each search query, trending list and screener after this many symbols, in the list's own order, from 1 to 1,000 (25 by default). It does not limit the symbols you type yourself. Each symbol saved is charged once.",
            "default": 25
          },
          "includeFinancials": {
            "title": "Financial statements",
            "type": "boolean",
            "description": "Adds each symbol's income statement, balance sheet and cash flow: about 100 line items per period, for the last four fiscal years, the last five quarters and the trailing twelve months, as Yahoo Finance shows them. One more request per symbol. Off by default.",
            "default": false
          },
          "includeHistory": {
            "title": "Price history",
            "type": "boolean",
            "description": "Adds each symbol's price bars (open, high, low, close, adjusted close, volume) plus its dividends, splits and capital gains, for the range and interval below. One more request per symbol, and the bars ride on the symbol's own row. Off by default.",
            "default": false
          },
          "historyRange": {
            "title": "History range",
            "enum": [
              "1d",
              "5d",
              "1mo",
              "3mo",
              "6mo",
              "ytd",
              "1y",
              "2y",
              "5y",
              "10y",
              "max"
            ],
            "type": "string",
            "description": "How far back the price history goes, counted from today: one day up to the symbol's whole history (max). A start date below overrides it. Used only with Price history on. Example: 1y",
            "default": "1y"
          },
          "historyInterval": {
            "title": "History interval",
            "enum": [
              "1m",
              "2m",
              "5m",
              "15m",
              "30m",
              "60m",
              "90m",
              "1h",
              "1d",
              "5d",
              "1wk",
              "1mo",
              "3mo"
            ],
            "type": "string",
            "description": "The length of one price bar. Yahoo keeps 1-minute bars for the last 30 days (up to 7 days per run), 2 to 90-minute bars for the last 60 days and hourly bars for the last 2 years; daily, weekly and monthly bars go back to the start. Example: 1d",
            "default": "1d"
          },
          "historyStartDate": {
            "title": "History from",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "type": "string",
            "description": "The first day of price history, written YYYY-MM-DD. When set, it replaces History range, and the history runs to History to (or today). Leave empty to use History range. Used only with Price history on. Example: 2024-01-01"
          },
          "historyEndDate": {
            "title": "History to",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "type": "string",
            "description": "The last day of price history, written YYYY-MM-DD, that day included. Needs History from. Leave empty to run the history up to today. Used only with Price history on. Example: 2024-12-31"
          },
          "optionExpirations": {
            "title": "Option expirations",
            "minimum": 0,
            "maximum": 3,
            "type": "integer",
            "description": "Adds each symbol's option chains, calls and puts with bid, ask, volume, open interest and implied volatility, for this many expiration dates, nearest first (0 to 3; 0 = none, the default). Every expiration date and strike is listed either way. One more request per expiration.",
            "default": 0
          },
          "maxNewsPerSymbol": {
            "title": "News per symbol",
            "minimum": 0,
            "maximum": 40,
            "type": "integer",
            "description": "Adds up to this many of each symbol's newest news stories from Yahoo Finance (0 to 40; 0 = none, the default): title, publisher, link, publish time, thumbnail and the other tickers it names. One more request per symbol.",
            "default": 0
          },
          "includeSimilarSymbols": {
            "title": "Similar symbols",
            "type": "boolean",
            "description": "Adds the symbols Yahoo Finance recommends alongside each one (\"people also watch\"), with Yahoo's own score for each. One more small request per symbol. The similar symbols are listed on the row, not read as rows of their own. Off by default.",
            "default": false
          },
          "includeInsights": {
            "title": "Insights",
            "type": "boolean",
            "description": "Adds Yahoo Finance's insights for each symbol: short, mid and long-term technical outlook, valuation, the analysts' rating and target, research report summaries, significant developments and SEC report notes. One more request per symbol. Off by default.",
            "default": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}