{"openapi":"3.1.0","info":{"title":"Yahoo Finance API (Bowmark)","version":"e833508f87ff","description":"Reads Yahoo Finance's own quote, market and estimate pages — price, market cap, analyst estimates, holders, news, trending tickers — off the site's own server-rendered markup, no browser and no account. Callable functions: resolving a company name or ticker guess to the matching symbols Yahoo Finance's own search box offers, and reading the live quote header for any ticker with price, change, market cap, P/E, 52-week range, volume and analyst target.\n\nEvery function Bowmark has for Yahoo Finance (finance.yahoo.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/yahoo_finance/searchSymbols":{"post":{"operationId":"searchSymbols","summary":"Resolves what a person would type — a company name (\"Apple\"), a ticker (\"AAPL\") or a rough guess — to the matching tickers Yahoo Finance's own search box would offer, ranked by Yahoo's own relevance s","description":"Resolves what a person would type — a company name (\"Apple\"), a ticker (\"AAPL\") or a rough guess — to the matching tickers Yahoo Finance's own search box would offer, ranked by Yahoo's own relevance score: symbol, display name, exchange (short code and full name), and quote type (\"EQUITY\", \"ETF\", \"FUTURE\", \"INDEX\", \"CURRENCY\", \"CRYPTOCURRENCY\", …). This is the DOOR every other function in this provider that takes a symbol needs — a caller holding only a company name has no other route to a ticker. A query with no matches answers `matches: []`, an honest empty result rather than a throw; an empty or non-string query throws before any request is sent.\n\nCalls `bowmark.providers.yahoo_finance.searchSymbols`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<yahooFinanceSearchResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"}},"required":["query"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/getQuote":{"post":{"operationId":"getQuote","summary":"Reads the live quote header for one ticker (\"AAPL\") the way the site's own quote page does — price, day's change and change percent, market cap, trailing P/E, 52-week range, volume, average volume, an","description":"Reads the live quote header for one ticker (\"AAPL\") the way the site's own quote page does — price, day's change and change percent, market cap, trailing P/E, 52-week range, volume, average volume, and analyst target mean price — everything shown in the quote strip and the right-rail statistics panel. An unknown or empty ticker throws before any request is sent.\n\nCalls `bowmark.providers.yahoo_finance.getQuote`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceQuote>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"symbol":{"type":"string","description":"TypeScript: `string`"}},"required":["symbol"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/getTrendingTickers":{"post":{"operationId":"getTrendingTickers","summary":"Reads what Yahoo Finance itself is showing as trending right now — the same sidebar every quote page carries — each row with its symbol, quote type, price, day change percent and Yahoo's own trending ","description":"Reads what Yahoo Finance itself is showing as trending right now — the same sidebar every quote page carries — each row with its symbol, quote type, price, day change percent and Yahoo's own trending score. No arguments: this is the market's current attention, not one ticker's.\n\nCalls `bowmark.providers.yahoo_finance.getTrendingTickers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceTrendingTicker[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/getMarketSummary":{"post":{"operationId":"getMarketSummary","summary":"Reads the market-wide overview the site's own Markets home shows: whether U.S.","description":"Reads the market-wide overview the site's own Markets home shows: whether U.S. markets are open (\"U.S. markets closed\"), the major-index strip (S&P 500, Dow 30, Nasdaq, Russell 2000, and whatever else the site is tracking that day — VIX, gold, Bitcoin, crude oil have all been observed), and the top day gainers, day losers and most-active stocks the site's own predefined screeners rank. No arguments: this is the market's current state, not one ticker's.\n\nCalls `bowmark.providers.yahoo_finance.getMarketSummary`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceMarketSummary>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/getHistoricalPrices":{"post":{"operationId":"getHistoricalPrices","summary":"Reads a ticker's daily open/high/low/close/volume history over a requested range (default: last 5 days), the way the site's own History tab does — the raw table an agent would otherwise have to read o","description":"Reads a ticker's daily open/high/low/close/volume history over a requested range (default: last 5 days), the way the site's own History tab does — the raw table an agent would otherwise have to read off a chart. Returns one row per date with OHLCV (open, high, low, close, volume) data, plus adjusted close. An unknown or empty ticker throws before any request is sent.\n\nCalls `bowmark.providers.yahoo_finance.getHistoricalPrices`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceHistoricalPrices>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"symbol":{"type":"string","description":"TypeScript: `string`"}},"required":["symbol"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/getAnalystEstimates":{"post":{"operationId":"getAnalystEstimates","summary":"Reads Wall Street's consensus numbers for a ticker the way the site's own Analysis tab presents them: the Revenue Estimate and Earnings Estimate tables, each with one row per metric (\"No.","description":"Reads Wall Street's consensus numbers for a ticker the way the site's own Analysis tab presents them: the Revenue Estimate and Earnings Estimate tables, each with one row per metric (\"No. of Analysts\", \"Avg. Estimate\", \"Low Estimate\", \"High Estimate\", and for revenue, \"Year Ago Sales\") and one column per period (current quarter, next quarter, current year, next year). Values are kept as the site renders them (\"113.62B\", \"8.82\") since revenue and EPS are different units. A section is null when Yahoo Finance rendered no analyst coverage for this ticker, not an empty table. An unknown or empty ticker throws before any request is sent.\n\nCalls `bowmark.providers.yahoo_finance.getAnalystEstimates`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceAnalystEstimates>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"symbol":{"type":"string","description":"TypeScript: `string`"}},"required":["symbol"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/getNews":{"post":{"operationId":"getNews","summary":"Reads the news stories Yahoo Finance itself has attached to a ticker's News tab — headline, link, source and how long ago it was published (Yahoo Finance's own relative wording, e.g.","description":"Reads the news stories Yahoo Finance itself has attached to a ticker's News tab — headline, link, source and how long ago it was published (Yahoo Finance's own relative wording, e.g. \"55m ago\" — no absolute timestamp is on the card), plus every ticker the story is tagged with, which is often more than the one asked about. A ticker with no recent coverage answers an empty story list, an honest empty result rather than a throw. An unknown or empty ticker throws before any request is sent.\n\nCalls `bowmark.providers.yahoo_finance.getNews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceNews>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"symbol":{"type":"string","description":"TypeScript: `string`"}},"required":["symbol"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/getHolders":{"post":{"operationId":"getHolders","summary":"Reads who owns a ticker the way the site's own Holders tab does: the insider/institution ownership breakdown (percent held by insiders, percent and count held by institutions — Yahoo's own metric word","description":"Reads who owns a ticker the way the site's own Holders tab does: the insider/institution ownership breakdown (percent held by insiders, percent and count held by institutions — Yahoo's own metric wording, kept as it renders), the top institutional holders and the top mutual-fund holders, each row with the holder's name, shares held, the date that holding was reported, percent of shares outstanding, and dollar value. A section renders empty when Yahoo Finance has no holders data for this ticker (a very new or thinly-covered listing), not a throw. An unknown or empty ticker throws before any request is sent.\n\nCalls `bowmark.providers.yahoo_finance.getHolders`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceHolders>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"symbol":{"type":"string","description":"TypeScript: `string`"}},"required":["symbol"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/getFinancials":{"post":{"operationId":"getFinancials","summary":"Reads a ticker's income statement, balance sheet and cash-flow statement the way the site's own Financials tab presents them, annual view.","description":"Reads a ticker's income statement, balance sheet and cash-flow statement the way the site's own Financials tab presents them, annual view. Each statement contains rows of financial metrics (Revenue, Net Income, Total Assets, etc.) with values for multiple fiscal years as columns. Values are kept as the site renders them ('383.285B', '6.05') because the same statement mixes revenue, counts, percentages and ratios. A section is null when Yahoo Finance has no financial statements for this ticker (non-equity quote types). An unknown or empty ticker throws before any request is sent.\n\nCalls `bowmark.providers.yahoo_finance.getFinancials`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceFinancials>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"symbol":{"type":"string","description":"TypeScript: `string`"}},"required":["symbol"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/listCryptoPrices":{"post":{"operationId":"listCryptoPrices","summary":"Reads the live cryptocurrency prices the way the site's own Crypto markets page does — for an agent asking what crypto is worth right now.","description":"Reads the live cryptocurrency prices the way the site's own Crypto markets page does — for an agent asking what crypto is worth right now. Returns the list of cryptocurrencies with their current price and percentage change.\n\nCalls `bowmark.providers.yahoo_finance.listCryptoPrices`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceCryptoPrices>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/getOptionsChain":{"post":{"operationId":"getOptionsChain","summary":"Reads a ticker's options chain the way the site's own Options tab does — every call and put contract at the requested expiration, with strike, last price, bid/ask, volume, open interest and implied vo","description":"Reads a ticker's options chain the way the site's own Options tab does — every call and put contract at the requested expiration, with strike, last price, bid/ask, volume, open interest and implied volatility. `expirationDate` is an optional ISO date (\"YYYY-MM-DD\") naming one of the dates this same function lists under `expirationDates`; omitted, Yahoo Finance answers its own nearest expiration. An unrecognized ticker answers an empty chain (no calls, no puts), an honest empty result rather than a throw; an empty or non-string symbol throws before any request is sent.\n\nCalls `bowmark.providers.yahoo_finance.getOptionsChain`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceOptionsChain>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"symbol":{"type":"string","description":"TypeScript: `string`"},"expirationDate":{"type":"string","description":"TypeScript: `string`"}},"required":["symbol"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/getCompanyProfile":{"post":{"operationId":"getCompanyProfile","summary":"Reads a company's profile from a ticker's Profile tab — sector, industry, website, business description, employee count, headquarters, and key executives.","description":"Reads a company's profile from a ticker's Profile tab — sector, industry, website, business description, employee count, headquarters, and key executives. An unknown or empty ticker throws before any request is sent.\n\nCalls `bowmark.providers.yahoo_finance.getCompanyProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceCompanyProfile>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"symbol":{"type":"string","description":"TypeScript: `string`"}},"required":["symbol"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/getKeyStatistics":{"post":{"operationId":"getKeyStatistics","summary":"Reads the key statistics table from a ticker's Key Statistics tab — metrics like market cap, P/E ratio, 52-week range, dividend yield, beta, and other commonly-referenced statistics.","description":"Reads the key statistics table from a ticker's Key Statistics tab — metrics like market cap, P/E ratio, 52-week range, dividend yield, beta, and other commonly-referenced statistics. Metrics are returned with their label and value exactly as Yahoo Finance renders them, preserving the mix of different units (percentages, currency amounts, counts, ranges). An unknown or empty ticker throws before any request is sent.\n\nCalls `bowmark.providers.yahoo_finance.getKeyStatistics`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceKeyStatistics>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"symbol":{"type":"string","description":"TypeScript: `string`"}},"required":["symbol"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/getEarningsDates":{"post":{"operationId":"getEarningsDates","summary":"Reads a ticker's next scheduled earnings date and the analyst consensus around it — EPS and revenue estimate average/low/high — plus the next earnings call date and the next ex-dividend and dividend d","description":"Reads a ticker's next scheduled earnings date and the analyst consensus around it — EPS and revenue estimate average/low/high — plus the next earnings call date and the next ex-dividend and dividend dates, the same calendar every quote page carries. `isEarningsDateEstimate` says whether Yahoo Finance is confirming the date or estimating it. Any field the site has not scheduled yet answers null rather than a throw. An unknown or empty ticker throws before any request is sent.\n\nCalls `bowmark.providers.yahoo_finance.getEarningsDates`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceEarningsDates>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"symbol":{"type":"string","description":"TypeScript: `string`"}},"required":["symbol"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/listWatchlists":{"post":{"operationId":"listWatchlists","summary":"Reads the signed-in viewer's saved watchlists with their tickers and current quotes, the way the site's own watchlists page does.","description":"Reads the signed-in viewer's saved watchlists with their tickers and current quotes, the way the site's own watchlists page does. NEEDS THE CALLER'S YAHOO SIGN-IN: with none saved the run pauses for one before any request. With one, the watchlists page is reached but its signed-in shape has never been measured, so the call still throws rather than guess.\n\nCalls `bowmark.providers.yahoo_finance.listWatchlists`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<YahooFinanceWatchlists>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/yahoo_finance/addToWatchlist":{"post":{"operationId":"addToWatchlist","summary":"Adds a ticker to one of the signed-in viewer's watchlists, for a caller managing their own market watch.","description":"Adds a ticker to one of the signed-in viewer's watchlists, for a caller managing their own market watch. NEEDS THE CALLER'S YAHOO SIGN-IN: with none saved the run pauses for one before any request. With one, the watchlists page is reached but its signed-in shape has never been measured, so the call still throws rather than guess.\n\nCalls `bowmark.providers.yahoo_finance.addToWatchlist`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<void>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"watchlistName":{"type":"string","description":"TypeScript: `string`"},"symbol":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["watchlistName","symbol"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}}}}}