> **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`). --- # List Apple App Store charts (https://www.socialfetch.dev/docs/api/v1/apple-app-store/charts/get) ## Summary List Apple App Store charts with full app records. **Tags:** `Apple App Store` ## HTTP - **Method:** GET - **Path:** `/v1/apple-app-store/charts` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.appleAppStore.listCharts({ chart: "top-free", platform: "iphone" })` - **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 ### `country` (query) - **Required:** no - **Constraints:** type `string`; pattern: `^[a-zA-Z]{2}$` - **Description:** Two-letter storefront code, e.g. `us`, `gb` or `jp`, case-insensitive. Prices, ratings, reviews and text are specific to it. A code Apple does not run a store for is refused. Default: `us`. ### `chart` (query) - **Required:** no - **Constraints:** type `string`; enum: top-free, top-paid, top-grossing, new, new-free, new-paid - **Description:** `top-free`, `top-paid`, `top-grossing`, `new`, `new-free` or `new-paid`. `top-grossing` is available on iPhone and iPad; the `new` charts on iPhone only. Default: `top-free`. ### `platform` (query) - **Required:** no - **Constraints:** type `string`; enum: iphone, ipad, mac - **Description:** `iphone`, `ipad` or `mac`. Default: `iphone`. ### `genre` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 9999 - **Description:** Genre id to rank within, e.g. `6014` for Games or `6005` for Social Networking. Default: `36`, all apps. ### `limit` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 200 - **Description:** Ranks to return, 1-200 (1-100 for top-grossing and the new charts). Default: 100. ## Responses (status codes) - **200**: App Store chart. - **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) App Store chart. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. `not_found` when the storefront has no such chart. - **storefront** (required) — type `string`. Storefront the chart is for. - **chart** (required) — type `string`; enum: top-free, top-paid, top-grossing, new, new-free, new-paid. The chart returned. - **platform** (required) — type `string`; enum: iphone, ipad, mac. Platform. - **genreId** (required) — type `integer`. Genre id of the chart. - **entries** (required) — type `array`. Chart positions in rank order. - _items:_ - **rank** (required) — type `integer`; minimum: 1. Position in the chart, from 1. - **id** (required) — type `integer`. App Store app id. - **app** (required) — type `object`; nullable. The app record; null when the app's record is unavailable in this storefront. The rank is kept. - **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", "storefront": "us", "chart": "top-free", "platform": "iphone", "genreId": 36, "entries": [ { "rank": 1, "id": 6741796873, "app": { "id": 6741796873, "bundleId": "com.ss.iphone.ugc.tiktok.pro", "name": "TikTok Pro - Events", "url": "https://apps.apple.com/us/app/tiktok-pro-events/id6741796873", "platforms": [ "ios" ], "deviceFamilies": [ "iphone" ], "developer": { "id": 1322881000, "name": "TikTok Ltd.", "url": "https://apps.apple.com/us/developer/tiktok-ltd/id1322881000" }, "seller": { "name": "TIKTOK PTE. LTD.", "url": "https://www.tiktok.com" }, "price": { "amount": 0, "currency": "USD", "formatted": "Free" }, "ratings": { "average": 4.82261, "count": 86517, "currentVersion": { "average": 4.82261, "count": 86517 } }, "ageRating": "12+", "contentAdvisories": [ "Infrequent/Mild Sexual Content and Nudity" ], "genres": [ { "id": 6016, "name": "Entertainment" } ], "primaryGenre": { "id": 6016, "name": "Entertainment" }, "currentVersion": { "version": "47.6.0", "releasedAt": "2026-11-03T03:44:23.000Z", "notes": "Quickly find and tag your friends in comments." }, "releasedAt": "2026-06-03T07:00:00.000Z", "minimumOsVersion": "15.0", "fileSizeBytes": 1056572416, "languages": [ "AR" ], "features": [ "iosUniversal" ], "gameCenter": false, "supportsDeviceLicensing": true, "description": "TikTok Pro - Events is a global discovery platform for videos where you can discover cool, funny, and educational short videos, as well as share important mome…", "icon": { "url60": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/c7/e0/05/c7e00539-f686-7de1-776b-2389d4f8d3af/AppIcon_TikTok-0-0-1x_U007emarketing-0-8-0-85-220.png/60x60…", "url100": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/c7/e0/05/c7e00539-f686-7de1-776b-2389d4f8d3af/AppIcon_TikTok-0-0-1x_U007emarketing-0-8-0-85-220.png/100x1…", "url512": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/c7/e0/05/c7e00539-f686-7de1-776b-2389d4f8d3af/AppIcon_TikTok-0-0-1x_U007emarketing-0-8-0-85-220.png/512x5…" }, "screenshots": { "iphone": [ "https://is1-ssl.mzstatic.com/image/thumb/PurpleSource211/v4/d1/b6/81/d1b681b5-4ba8-4e4d-0ece-e3d40e5659aa/iOS-_U5e95tab_U4fee_U6539-_U56fe3.png/320x480bb.jpg" ], "ipad": [ "https://is1-ssl.mzstatic.com/image/thumb/PurpleSource221/v4/83/a5/fc/83a5fc8b-ba94-5430-f5ac-5b75a1f0beee/Frame_2087325581.png/360x480bb.jpg" ], "appleTv": [], "mac": [] } } } ] }, "meta": { "requestId": "req_6f36f4be-0cde-48b1-b302-cb758aa7c3c6", "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.appleAppStore.listCharts({ chart: "top-free", platform: "iphone", }); 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/apple-app-store/charts?chart=top-free&platform=iphone", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/apple-app-store/charts?chart=top-free&platform=iphone" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/apple-app-store/charts?chart=top-free&platform=iphone", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```