> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). The sections below mirror the orientation block in [`/llms.txt`](https://www.socialfetch.dev/llms.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need a structured operation inventory. The catalog covers documented operations with on-site reference pages. ## This page - **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/facebook/posts/get](https://www.socialfetch.dev/docs/api/v1/facebook/posts/get) - **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/facebook/posts/get.mdx](https://www.socialfetch.dev/docs/api/v1/facebook/posts/get.mdx) ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` 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:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/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()`. - [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users. - [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage. - [`/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`). --- # Get Facebook post or reel (https://www.socialfetch.dev/docs/api/v1/facebook/posts/get) ## Summary Returns public metadata for a single Facebook post or reel URL. Availability is indicated in `data.lookupStatus` as `found` or `not_found`. Optional `includeComments` and `includeTranscript` request extra fields when available. **Tags:** `Facebook` ## HTTP - **Method:** GET - **Path:** `/v1/facebook/posts` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.facebook.getPost({ url, includeComments?, includeTranscript? })` - **Accepted identifiers:** `url` (query) - **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. - **Normalization failure (502):** 1 credit charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `url` (query) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 4096 - **Description:** Public permalink to the Facebook post or reel. ### `includeComments` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** When true, includes a sample of top-level comments when available. ### `includeTranscript` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** When true, includes a plain-text transcript when available for the video. ## Responses (status codes) - **200**: Post or reel metadata (found or not found in body). - **400**: Invalid request - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed from the response (unexpected or invalid data). - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) Post or reel metadata (found or not found in body). ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the URL could be resolved to public content. - **post** (required) — type `object`; nullable. Post details when found. - **platform** (required) — type `string`; enum: facebook. Social platform for this content. - **postId** (required) — type `string`; minLength: 1. Platform post id when available. - **url** (required) — type `string`; minLength: 1. Canonical or resolved public URL for this post or reel. - **description** (required) — type `string`; nullable. Caption or body text when available. - **publishedAt** (required) — type `string`; nullable. Publication timestamp in ISO 8601 when available. - **feedbackId** (required) — type `string`; nullable. Opaque feedback identifier when exposed by the platform; may be used for related lookups. - **author** (required) — type `object`; nullable. Author when found. - **name** (required) — type `string`; minLength: 1. Display name of the author. - **profileUrl** (required) — type `string`; minLength: 1. Public profile URL for the author when available. - **avatarUrl** (required) — type `string`; nullable. Avatar image URL when available. - **platformUserId** (optional) — type `string`. Platform-specific author id when available. - **verified** (required) — type `boolean`. Whether the author is marked as verified. - **metrics** (required) — type `object`; nullable. Engagement metrics for the post or reel. - **likes** (required) — type `integer`; minimum: 0; nullable. Like count when available. - **comments** (required) — type `integer`; minimum: 0; nullable. Comment count when available. - **shares** (required) — type `integer`; minimum: 0; nullable. Share count when available. - **views** (required) — type `integer`; minimum: 0; nullable. View or play count when available. - **media** (required) — type `object`; nullable. Primary media for the post or reel. - **thumbnailUrl** (required) — type `string`; nullable. Thumbnail image URL when available. - **imageUrl** (required) — type `string`; nullable. Primary image URL when the post is image-based. - **videoUrl** (required) — type `string`; nullable. Standard-definition video URL when available. - **videoHdUrl** (required) — type `string`; nullable. High-definition video URL when available. - **durationSec** (required) — type `number`; minimum: 0; nullable. Video duration in seconds when available. - **width** (required) — type `integer`; minimum: 0; nullable. Video width in pixels when available. - **height** (required) — type `integer`; minimum: 0; nullable. Video height in pixels when available. - **captionsUrl** (required) — type `string`; nullable. Caption or subtitle asset URL when available. - **music** (required) — type `object`; nullable. Attached audio metadata when available. - **trackTitle** (required) — type `string`; nullable. Track title when the post uses attached audio. - **albumArtUrl** (required) — type `string`; nullable. Album art image URL when available. - **musicId** (optional) — type `string`. Audio track id when available. - **type** (optional) — type `string`. Audio source type label when available. - **comments** (required) — type `array`. Sample of top-level comments when requested and available. - _items:_ - **commentId** (required) — type `string`; minLength: 1. Stable id for the comment when available. - **text** (required) — type `string`; nullable. Comment body text. - **createdAt** (required) — type `string`; nullable. Creation timestamp in ISO 8601 when available. - **replyCount** (required) — type `integer`; minimum: 0. Number of direct replies when available. - **reactionCount** (required) — type `integer`; minimum: 0. Total reactions when available. - **authorName** (required) — type `string`; minLength: 1. Display name of the commenter. - **transcript** (required) — type `string`; nullable. Plain-text transcript when requested and 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", "post": { "platform": "facebook", "postId": "10162952105911701", "url": "https://www.facebook.com/reel/823172974137208", "description": "Example caption.", "publishedAt": "2026-04-07T19:02:33.000Z", "feedbackId": "ZmVlZGJhY2s6MTAxNjI5NTIxMDU5MTE3MDE=" }, "author": { "name": "Example Author", "profileUrl": "https://www.facebook.com/example.author", "avatarUrl": "https://example.com/avatar.jpg", "platformUserId": "pfbid02example", "verified": false }, "metrics": { "likes": 110, "comments": 10, "shares": 0, "views": null }, "media": { "thumbnailUrl": "https://example.com/thumb.jpg", "imageUrl": null, "videoUrl": "https://example.com/video-sd.mp4", "videoHdUrl": "https://example.com/video-hd.mp4", "durationSec": 37.64, "width": 1080, "height": 1920, "captionsUrl": null }, "music": { "trackTitle": "Example Artist · Example track", "albumArtUrl": "https://example.com/album.jpg", "musicId": "1736166400619393", "type": "LIBRARY_MUSIC" }, "comments": [], "transcript": null }, "meta": { "requestId": "req_01example", "creditsCharged": 1, "version": "v1" } } ``` ### Example JSON (with_comments) ```json { "data": { "lookupStatus": "found", "post": { "platform": "facebook", "postId": "10162952105911701", "url": "https://www.facebook.com/reel/823172974137208", "description": "Example caption.", "publishedAt": "2026-04-07T19:02:33.000Z", "feedbackId": "ZmVlZGJhY2s6MTAxNjI5NTIxMDU5MTE3MDE=" }, "author": { "name": "Example Author", "profileUrl": "https://www.facebook.com/example.author", "avatarUrl": "https://example.com/avatar.jpg", "platformUserId": "pfbid02example", "verified": false }, "metrics": { "likes": 110, "comments": 10, "shares": 0, "views": null }, "media": { "thumbnailUrl": "https://example.com/thumb.jpg", "imageUrl": null, "videoUrl": "https://example.com/video-sd.mp4", "videoHdUrl": "https://example.com/video-hd.mp4", "durationSec": 37.64, "width": 1080, "height": 1920, "captionsUrl": null }, "music": { "trackTitle": "Example Artist · Example track", "albumArtUrl": "https://example.com/album.jpg", "musicId": "1736166400619393", "type": "LIBRARY_MUSIC" }, "comments": [ { "commentId": "Y29tbWVudDox", "text": "Great post.", "createdAt": "2026-04-07T19:08:56.000Z", "replyCount": 0, "reactionCount": 2, "authorName": "Example User" } ], "transcript": null }, "meta": { "requestId": "req_01example", "creditsCharged": 1, "version": "v1" } } ``` ### Example JSON (not_found) ```json { "data": { "lookupStatus": "not_found", "post": null, "author": null, "metrics": null, "media": null, "music": null, "comments": [], "transcript": null }, "meta": { "requestId": "req_01example_nf", "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 from the response (unexpected or invalid data). **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.facebook.getPost({ url: "https://www.facebook.com/profile.php?id=61575098504636", }); 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/facebook/posts?url=https://www.facebook.com/profile.php?id=61575098504636", { headers: { "x-api-key": "YOUR_API_KEY", } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/facebook/posts?url=https://www.facebook.com/profile.php?id=61575098504636" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/facebook/posts?url=https://www.facebook.com/profile.php?id=61575098504636", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```