> **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 fund profile (https://www.socialfetch.dev/docs/api/v1/yahoo-finance/instruments/symbol/fund/get) ## Summary Get Yahoo Finance fund profile, performance and top holdings. **Tags:** `Yahoo Finance` ## HTTP - **Method:** GET - **Path:** `/v1/yahoo-finance/instruments/{symbol}/fund` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.yahooFinance.getFund({ 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`. ## Responses (status codes) - **200**: A Yahoo Finance fund profile. - **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 fund profile. ### 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 sections belong to. - **sources** (required) — type `object`. Status of each optional part of the result. - **fundProfile** (required) — type `object`; nullable. Fund family, category, legal type, expense ratio, total net assets in millions of the fund's currency, inception date and brokerages. Null when it is not available. - **fundPerformance** (required) — type `object`; nullable. Fund returns over several periods and category comparisons, plus risk measures such as beta, Sharpe ratio and standard deviation. Null when it is not available. - **topHoldings** (required) — type `object`; nullable. The fund's largest holdings with symbol, name and percentage of assets, plus asset, sector and bond-rating weights. Null when it is not available. - **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", "sources": { "fund": "ok" }, "fundProfile": { "styleBoxUrl": "https://s.yimg.com/lq/i/fi/3_0stylelargeeq2.gif", "family": "State Street Investment Management", "categoryName": "Large Blend", "legalType": "Exchange Traded Fund", "managementInfo": { "managerName": null, "managerBio": null }, "feesExpensesInvestment": { "annualReportExpenseRatio": 0.000945, "annualHoldingsTurnover": 0.03, "totalNetAssets": 504496.28, "projectionValues": {} }, "feesExpensesInvestmentCat": { "annualReportExpenseRatio": 0.0072176997, "annualHoldingsTurnover": 0.9461, "totalNetAssets": 504496.28, "projectionValuesCat": {} }, "brokerages": [] }, "fundPerformance": { "fundCategoryName": "Large Blend", "performanceOverview": { "asOfDate": "2026-11-03T00:00:00.000Z", "ytdReturnPct": 0.1148653, "fiveYrAvgReturnPct": 0.1166064, "oneYearTotalReturn": 0.1158071, "threeYearTotalReturn": 0.2163005 }, "performanceOverviewCat": { "ytdReturnPct": 0.051434003, "fiveYrAvgReturnPct": 0.112004004, "oneYearTotalReturn": 0.27720898, "threeYearTotalReturn": 0.1934272 }, "trailingReturns": { "asOfDate": "2026-11-03T00:00:00.000Z", "ytd": 0.116868295, "oneMonth": -0.0087734, "threeMonth": 0.0145386, "oneYear": 0.12008721, "threeYear": 0.2326477, "fiveYear": 0.1196218, "tenYear": 0.1534065, "lastBullMkt": 0, "lastBearMkt": 0 }, "trailingReturnsNav": { "ytd": 0.116868295, "oneMonth": -0.0087734, "threeMonth": 0.0145386, "oneYear": 0.12008721, "threeYear": 0.2326477, "fiveYear": 0.1196218, "tenYear": 0.1534065 }, "trailingReturnsCat": { "ytd": 0.051434003, "oneMonth": 0.0943234, "threeMonth": 0.0341969, "oneYear": 0.27720898, "threeYear": 0.1934272, "fiveYear": 0.112004004, "tenYear": 0.1377275, "lastBullMkt": 0, "lastBearMkt": 0 }, "annualTotalReturns": { "returns": [ { "year": "2025", "annualValue": 0.1771505 } ], "returnsCat": [ { "year": "2025", "annualValue": 0.1554386 } ] }, "pastQuarterlyReturns": { "returns": [] }, "riskOverviewStatistics": { "riskStatistics": [ { "year": "5y", "alpha": 1.06, "beta": 0.98, "meanAnnualReturn": 1.04, "rSquared": 99.27, "stdDev": 15.42, "sharpeRatio": 0.56, "treynorRatio": 8.1 } ] }, "riskOverviewStatisticsCat": { "riskStatisticsCat": [ { "year": "5y", "alpha": -1.39, "beta": 0.96, "meanAnnualReturn": 0.99, "rSquared": 92.82, "sharpeRatio": 0.53, "treynorRatio": 7.79 } ] } }, "topHoldings": { "cashPosition": 0.00059999997, "stockPosition": 0.9994, "bondPosition": 0, "otherPosition": 0, "preferredPosition": 0, "convertiblePosition": 0, "holdings": [ { "symbol": "AAPL", "holdingName": "Apple Inc", "holdingPercent": 0.0770069 } ], "equityHoldings": { "priceToEarnings": 0.0416, "priceToBook": 0.197, "priceToSales": 0.29058, "priceToCashflow": 0.05486 }, "bondHoldings": {}, "bondRatings": [ { "us_government": 0 } ], "sectorWeightings": [ { "realestate": 0.018 } ] } }, "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.getFund({ 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/fund", { 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/fund" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/yahoo-finance/instruments/SPY/fund", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```