> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration. ## This page - **On-site (HTML):** - **Markdown (.mdx) URL:** ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route). - **OpenAPI JSON:** ## Recommended docs entrypoints (this site) - [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown). - [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope. - [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages. - [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples. - [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths. - [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install. - [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help. - [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples. - [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start. - [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog. - [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI). - [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls). - [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist. - [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping. - [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages. - [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance. - [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs. - Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract. ## Markdown docs convention - Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`). - Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`). - Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`). --- # Get Yahoo Finance option chain (https://www.socialfetch.dev/docs/api/v1/yahoo-finance/instruments/symbol/options/get) ## Summary Get Yahoo Finance option expiries, strikes, calls and puts. **Tags:** `Yahoo Finance` ## HTTP - **Method:** GET - **Path:** `/v1/yahoo-finance/instruments/{symbol}/options` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.yahooFinance.getOptions({ symbol: "SPY" })` - **Accepted identifiers:** `symbol` (path) - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found` ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Failed requests (`lookup_failed`, `503`):** not charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `symbol` (path) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 40; pattern: `^[A-Za-z0-9^=.-]+$` - **Description:** Ticker symbol, case-insensitive, e.g. `AAPL`, `^GSPC`, `EURUSD=X`, `BTC-USD`, `7203.T`. ### `expiration` (query) - **Required:** no - **Constraints:** type `string` - **Description:** Expiry date in ISO 8601 form, for example `2026-12-18`. Must be one of the dates returned in `expirations`; omit it for the nearest expiry. ### `straddle` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Pair calls and puts by strike. Default: false. ## Responses (status codes) - **200**: A Yahoo Finance option chain. - **400**: Invalid request - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed. - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) A Yahoo Finance option chain. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the entity was found. HTTP 200 for both outcomes; branch on this field. - **symbol** (required) — type `string`. Ticker symbol the chain is for. - **expirations** (required) — type `array`. All expiry dates, ISO 8601 UTC. - _items:_ - type `string` - **strikes** (required) — type `array`. Strikes on the returned chain. - _items:_ - type `number` - **hasMiniOptions** (required) — type `boolean`; nullable. Whether the chain has mini options; null when not reported. - **quote** (required) — type `object`; nullable. The underlying quote record. - **options** (required) — type `array`. The chain: `expirationDate`, `calls[]` and `puts[]`. - _items:_ - type `object` - **meta** (required) — type `object`. Metadata describing the request and billing outcome. - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call. - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request. - **version** (required) — type `string`; enum: v1. Public API version that served the response. ### Example JSON (found) ```json { "data": { "lookupStatus": "found", "symbol": "SPY", "expirations": [ "2026-11-05T00:00:00.000Z" ], "strikes": [ 550 ], "hasMiniOptions": false, "quote": { "quoteType": "ETF", "typeDisp": "ETF", "quoteSourceName": "Nasdaq Real Time Price", "currency": "USD", "shortName": "State Street SPDR S&P 500 ETF T", "longName": "State Street SPDR S&P 500 ETF Trust", "corporateActions": [], "postMarketTime": "2026-11-05T00:59:59.000Z", "regularMarketTime": "2026-11-04T21:00:00.000Z", "exchange": "PCX", "exchangeTimezoneName": "America/New_York", "exchangeTimezoneShortName": "EST", "gmtOffSetMilliseconds": -18000000, "market": "us_market", "hasPrePostMarketData": true, "firstTradeDate": "1993-01-29T14:30:00.000Z", "priceHint": 2, "postMarketChangePercent": -0.024778295, "postMarketPrice": 766.62, "postMarketChange": -0.19000244, "regularMarketChange": 12.46, "regularMarketChangePercent": 1.65176, "fulldayChange": 10.7300415, "fulldayChangePercent": 1.4224222, "fulldayPrice": 766.81, "regularMarketPrice": 766.81, "regularMarketDayHigh": 769.22, "regularMarketDayRange": "762.64 - 769.22", "regularMarketDayLow": 762.64, "regularMarketVolume": 61628598, "regularMarketPreviousClose": 754.35, "bid": 766.7, "ask": 766.62, "bidSize": 80, "askSize": 640, "fullExchangeName": "NYSEArca", "financialCurrency": "USD", "regularMarketOpen": 762.99, "averageDailyVolume3Month": 40748778, "averageDailyVolume10Day": 41131560, "fiftyTwoWeekLowChange": 137.52997, "fiftyTwoWeekLowChangePercent": 0.2185513, "fiftyTwoWeekRange": "629.28 - 781.62", "fiftyTwoWeekHighChange": -14.809998, "fiftyTwoWeekHighChangePercent": -0.018947823, "fiftyTwoWeekLow": 629.28, "fiftyTwoWeekHigh": 781.62, "fiftyTwoWeekChangePercent": 11.330032, "trailingAnnualDividendRate": 5.662, "trailingPE": 24.395548, "trailingAnnualDividendYield": 0.0075058, "dividendYield": 1, "ytdReturn": 11.68683, "trailingThreeMonthReturns": 1.45386, "trailingThreeMonthNavReturns": 1.45386, "netAssets": 796865200000, "epsTrailingTwelveMonths": 31.432375, "marketState": "POSTPOST", "sharesOutstanding": 917782016, "bookValue": 429.22, "fiftyDayAverage": 767.0396, "fiftyDayAverageChange": -0.22961426, "fiftyDayAverageChangePercent": -0.00029935123, "twoHundredDayAverage": 729.46686, "twoHundredDayAverageChange": 37.34314, "twoHundredDayAverageChangePercent": 0.051192373, "netExpenseRatio": 0.0945, "priceToBook": 1.7865198, "exchangeDataDelayedBy": 0, "tradeable": false, "cryptoTradeable": false, "displayName": "S&P 500 ETF Trust", "symbol": "SPY" }, "options": [ { "expirationDate": "2026-11-05T00:00:00.000Z", "hasMiniOptions": false, "calls": [ { "contractSymbol": "SPY261105C00575000", "strike": 575, "currency": "USD", "lastPrice": 193.68, "change": 12.569992, "percentChange": 6.9405293, "volume": 3, "openInterest": 7, "bid": 190.9, "ask": 194.44, "contractSize": "REGULAR", "expiration": "2026-11-05T00:00:00.000Z", "lastTradeDate": "2026-11-04T17:45:29.000Z", "impliedVolatility": 2.7763702465820312, "inTheMoney": true } ], "puts": [ { "contractSymbol": "SPY261105P00550000", "strike": 550, "currency": "USD", "lastPrice": 0.01, "change": 0, "percentChange": 0, "volume": 2, "openInterest": 68, "bid": 0, "ask": 0.01, "contractSize": "REGULAR", "expiration": "2026-11-05T00:00:00.000Z", "lastTradeDate": "2026-11-03T20:51:42.000Z", "impliedVolatility": 1.875000625, "inTheMoney": false } ] } ] }, "meta": { "requestId": "req_yahoo_finance_example", "creditsCharged": 1, "version": "v1" } } ``` ### Machine-readable error codes When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime): - `bad_request` ## Error handling & retries Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status. - **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help. - **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help. - **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help). - **500**: Unexpected or billing error - **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable. - **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter. ### Suggested client defaults - Send the API key using the `x-api-key` header on every request. - On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user. - On `402`, surface an actionable billing message rather than blind retries. ## Examples ### TypeScript SDK ```typescript import { SocialFetchClient } from "@socialfetch/sdk"; const client = new SocialFetchClient({ apiKey: process.env.SOCIALFETCH_API_KEY!, }); const result = await client.yahooFinance.getOptions({ symbol: "SPY", }); if (!result.ok) { console.error(result.error); } else { console.log(result.value.data); } ``` ### Node.js ```javascript const response = await fetch( "https://api.socialfetch.dev/v1/yahoo-finance/instruments/SPY/options", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/yahoo-finance/instruments/SPY/options" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/yahoo-finance/instruments/SPY/options", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```