SocialCrawl

Post schema

The unified SocialCrawl post schema. Every field, its type, per-platform availability, and a machine-readable JSON Schema, generated from the canonical Zod source.

Every SocialCrawl endpoint that returns a post gives you this exact shape, whatever the source platform. Write your parser once and the same code reads post data from every platform below. That is the unified schema: one contract instead of a dozen raw upstream formats.

Field reference

FieldTypeNullableDescription
idstringNoPlatform-specific post ID (always a string; numeric upstream IDs are stringified)
urlstringYesDirect URL to the post on the source platform
content.textstringYesPost caption, description, or text content
content.media_urlsstring or string[]YesURL(s) of the primary media. Single string for video/photo posts; array of strings for carousels.
content.thumbnail_urlstringYesURL to thumbnail image
content.duration_secondsintegerYesVideo/clip duration in seconds (null for non-video posts)
author.usernamestringYesAuthor username
author.display_namestringYesAuthor display name
author.avatar_urlstringYesURL to author profile picture
author.verifiedbooleanYesWhether the author account is verified
engagement.viewsintegerYesView count (if available). For Instagram video/reels this is the play count: the headline 'Views' the IG app shows. Instagram removed per-post play counts from its public web pages in August 2026, so GET /v1/instagram/post now fills the count automatically from a second source within the same call: videos and reels keep a numeric views with no extra endpoint or workaround. Note: since mid-July 2026 Instagram's play count is Instagram-only. It no longer includes Facebook crosspost views (Meta-side change; the app UI changed identically). For combined reach, also fetch the Facebook crosspost via /v1/facebook/post.
engagement.likesintegerYesLike / reaction count
engagement.commentsintegerYesComment count. Note: on GET /v1/instagram/post this is Instagram's edge_media_to_parent_comment.count (top-level comments); the IG list endpoints report the mobile comment_count total (includes replies). Both land on this same field.
engagement.sharesintegerYesShare / repost / retweet count. On Instagram this is reshare_count (the paper-plane Share / Send count) and it exists only on Instagram's mobile surface, so it is returned by /v1/instagram/post/stats, /v1/instagram/profile/reels/full, and /v1/instagram/profile/posts/full. The web-sourced Instagram list and search endpoints return null (never fabricated).
engagement.savesintegerYesSave / bookmark count. null on Instagram: the save count is platform-private and Instagram exposes no numeric save metric on any surface (never fabricated).
flags.nsfwbooleanYesNSFW flag (null when platform does not surface)
flags.spoilerbooleanYesSpoiler flag (null when platform does not surface)
flags.pinnedbooleanYesPinned-to-profile flag (null when platform does not surface)
flags.deletedbooleanNoWhether the post is tombstoned (always present)
flags.likes_hiddenbooleanYesPresent and true when the creator has hidden the like count. engagement.likes is null in that case (never the platform's decoy preview number). Absent on normal posts.
flags.comments_hiddenbooleanYesPresent and true when the upstream reports the comment count as hidden. engagement.comments is null in that case. Absent on normal posts.
flags.shares_hiddenbooleanYes
flags.views_hiddenbooleanYes
flags.saves_hiddenbooleanYes
published_atstring or integerYesPost creation timestamp as an ISO 8601 UTC string. When the upstream sent a Unix epoch it is converted here and the raw epoch is preserved under post.ext.published_at_epoch for one deprecation cycle.

Extension fields (ext)

Platform-specific passthrough. Each field is present only on the platforms that expose it and is absent everywhere else, so treat every ext.* field as optional. These carry the richer, per-platform signals the unified leaves cannot hold, and the join keys that chain endpoints together.

FieldTypeNullableDescription
ext.music_idstringYesTikTok music/clip id (exact string): pass to /v1/tiktok/song/videos?clipId= to find videos using the same sound
ext.author_idstringYesThe creator's platform-native numeric user id. On TikTok search and list items, pass to /v1/tiktok/profile?user_id= for the creator's current follower count (survives username changes). On Instagram search/reels items it is present on every row from every serving source, accepted by /v1/instagram/basic-profile?userId=. On Facebook it appears when the upstream exposed a numeric actor id and no real handle.
ext.author_followersintegerYesThe creator's follower count as embedded in the search payload itself, when the search source happens to carry one. On Instagram search/reels it is null on a plain call, because Instagram stopped sending follower counts in its search payload in August 2026; send include=creator (or country) and it is filled from the creator's profile, 2 credits per creator looked up. It stays null when that lookup does not resolve.
ext.author_followingintegerYes
ext.author_posts_countintegerYes
ext.author_countrystringYesThe creator's country as they declare it on Instagram's About this account panel, as a country name (for example Spain). It is not where the reel was filmed. Present only on /v1/instagram/search/reels when the request sends include=creator (or country), filled by looking the creator up. Null when Instagram does not publish a country for the creator or the lookup did not resolve, and nothing is guessed; absent on a plain call.
ext.author_public_emailstringYesThe public contact email on the creator's profile. Present only on /v1/instagram/search/reels when the request sends include=creator, filled by looking the creator up. Null when the creator lists no public email or the lookup did not resolve; absent on a plain call.
ext.author_public_phonestringYesThe public contact phone number on the creator's profile. Present only on /v1/instagram/search/reels when the request sends include=creator, filled by looking the creator up. Null when the creator lists no public phone or the lookup did not resolve; absent on a plain call.
ext.download_countintegerYesHow many times the video has been saved to a device. TikTok only, and distinct from engagement.saves: a save keeps the video in a private collection on the platform, a download takes a copy off it, and TikTok counts the two separately. Present on TikTok post, search and post-list responses; absent everywhere else.
ext.regionstringYesTikTok only: the country TikTok registers the video to, as an ISO 3166-1 alpha-2 code (normally the creator's account country when they posted). It is not the viewer's country, not the region you requested, and not a language. On /v1/tiktok/trending, /v1/tiktok/search and /v1/tiktok/search/top it is how you tell which rows are from a given country: filter on it when you need only that country. The region request parameter still only sets the proxy.
ext.subredditstringYesReddit subreddit name (search/list items): pass to /v1/reddit/subreddit/details?subreddit=
ext.titlestringYes
ext.selftextstringYes
ext.upvote_ratiointegerYesReddit only: the share of a post's votes that are upvotes, as a fraction from 0 to 1 and usually close to 1 (six live rows measured 1, 1, 1, 0.86, 0.75, 1). Fractional despite the integer type this schema emits for every numeric leaf, the same caveat as author.ext.average_rating. Populated on /v1/reddit/search rows whose source carries it, and null everywhere else on Reddit including /v1/reddit/post and /v1/reddit/subreddit.
ext.flairstringYes
ext.content_languagestringYesThe language the platform itself tags the post with, when it sends one: Reddit's own language tag on Reddit lanes, and TikTok's caption-language tag (for example de) on /v1/tiktok/trending?feed=local. Null when the platform could not tell (Reddit und, TikTok un, common on short or emoji-only captions); absent where the source sends no tag. Never inferred from the text by us: that is post.computed.language.
ext.typestringYes
ext.content_typestringYes
ext.ticker_symbolsstring[]Yes
ext.video_view_countintegerYesInstagram's legacy 3-second-view count. Historical: Instagram stopped serving it in August 2026 (removed from its web post surface along with the web play count), so fresh /v1/instagram/post lookups no longer carry it and no source can restore it. Use engagement.views (the play count) instead.
ext.ig_play_countintegerYesInstagram-only play count (ig_play_count). Since mid-July 2026 Instagram's headline play count (engagement.views) no longer includes Facebook crosspost views and equals this value; it is surfaced explicitly so you can tell the Instagram-only figure apart and detect any future re-divergence. For combined Instagram + Facebook reach, also fetch the Facebook crosspost via /v1/facebook/post. Present on /v1/instagram/post/stats and, since the August 2026 views fix, on /v1/instagram/post for video posts.
ext.repost_countintegerYes
ext.media_typestringYes
ext.text_truncatedbooleanYes
ext.ip_locationstringYes
ext.carousel_countintegerYes
ext.remix_countintegerYes
ext.audio_cluster_idstringYesInstagram's audio cluster for a reel, as an exact digit string: the id Instagram uses to group different uploads of the same sound. Present on /v1/instagram/audio/reels rows and on /v1/instagram/profile/reels with include=stats; absent on a row when it is not available and on every other surface.
ext.facebook_likesintegerYesInstagram only: the Facebook cross-post share that was EXCLUDED from engagement.likes on this row. A post shared to Facebook arrives from some sources with its Facebook likes already folded into the Instagram count, so the share is subtracted and published here, which keeps engagement.likes the Instagram-only figure instagram.com shows on the post. Add the two together for the combined number. Absent when the read carried no Facebook share, and absent on a post whose owner hides the like count, because nothing can be subtracted from a null. A response that excluded a share also carries a note in data._warnings.
ext.facebook_commentsintegerYesInstagram only: the Facebook cross-post share that was EXCLUDED from engagement.comments on this row, the comment counterpart of post.ext.facebook_likes. Each leaf appears only for the count it actually changed, so a post whose likes are hidden but whose comments were reconciled carries this one alone.
ext.published_at_epochintegerYesRaw Unix epoch for published_at (seconds, or milliseconds when the upstream sent millis). Present only when the upstream sent a numeric epoch that was normalised to the ISO 8601 published_at string. Kept for one deprecation cycle for integrations pinned to the numeric form.
ext.usertagsstring[]Yes
ext.coauthorsstring[]YesInstagram collaborative posts (the native "Collab" feature). The full list of co-author accounts on the post, as { id, username, full_name, is_verified, profile_pic_url }. A collab post has ONE producer and appears in every co-author's grid, so post.author is whichever account created it, which is not necessarily the profile you queried. The complete set of accounts on a post is post.author.username plus every username in this array. An empty array means Instagram reports the post as NOT a collab; the field is absent on surfaces that carry no co-author signal, including /v1/instagram/post (its web source ships the field permanently empty, so use /v1/instagram/post/stats for a single post).
ext.musicstringYes
ext.sponsor_tagsstring[]Yes
ext.locationstringYes
ext.quoted_poststringYesThreads quote posts: the post this one quotes, as { id, url, author: { id, username }, text, media_urls, thumbnail_url }. A quote post usually carries no caption or media of its own, and the text and video you see on the post's page belong to this attachment, by a different author. It is returned here rather than merged into post.content, so content.* always stays the outer post's own content and one account's media is never attributed to another. Absent on posts that are not quote posts.
ext.retweeted_poststringYes
ext.quote_countintegerYes
ext.all_media_urlsstring[]Yes
ext.reaction_countsstring[]Yes
ext.share_urnstringYes
ext.post_typestringYes
ext.activity_idstringYes
ext.published_at_precisionstringYes
ext.author_urnstringYes
ext.author_headlinestringYes
ext.author_typestringYes
ext.is_repost_quotebooleanYes
ext.articlestringYes
ext.reaction_typestringYes
ext.download_media_urlsstring[]Yes
ext.tagsstring[]Yes
ext.categoryIdstringYes
ext.categoryTitlestringYes
ext.topicCategoriesstring[]Yes
ext.durationstringYes
ext.licensestringYes
ext.madeForKidsbooleanYes
ext.defaultAudioLanguagestringYes
ext.hasPaidProductPlacementbooleanYes
ext.captionstringYes
ext.positionintegerYes
ext.playlistIdstringYes
ext.videoOwnerChannelIdstringYes
ext.videoPublishedAtstringYes
ext.descriptionstringYes
ext.default_languagestringYes
ext.localizationsstringYes
ext.playlist_item_idstringYes
ext.playlist_owner_channel_idstringYes
ext.playlist_owner_titlestringYes
ext.channel_idstringYes
ext.published_labelstringYes
ext.published_precisionstringYes
ext.video_countintegerYes
ext.commercestringYes
ext.on_screen_textsstring[]Yes
ext.topic_tagstringYes
ext.reshare_countintegerYes
ext.dsp_idsstringYes
ext.topic_tag_idstringYes
ext.amazon_shop_listsstring[]Yes
ext.amazon_shop_trending_picksstring[]Yes
ext.amazon_shop_curationsstring[]Yes
ext.amazon_shop_socialsstring[]Yes
ext.adstringYesAd Library envelope (Facebook adlibrary/ad and adlibrary/company/ads items): page_id, currency, spend, reach_estimate, publisher_platforms, categories, targeted_or_reached_countries, cta_text, cta_type, link_url, is_active, end_date_iso, display_format, title, video_hd_url, video_sd_url. Absent on every non-ad surface.
ext.apple_musicstringYes
ext.feedback_idstringYes
ext.eventstringYes
ext.trendstringYesTrend-board envelope: what TikTok's own trend board says about the row. On /v1/tiktok/hashtags/popular: rank, country_code, period_days, posts and views for the window (not lifetime totals), industry / industry_id / industry_label for the first board the hashtag was read from (null for the overall board), boards listing EVERY board it ranks on as { industry, industry_id, industry_label, rank } in board order (so a hashtag in the top 3 overall and on an industry board shows both), popularity_curve as { date, value } with value 0 to 100 relative to the window's peak, and top_creators. On /v1/tiktok/videos/popular: rank, country_code, period_days, order_by, period_views, organic_views, engagement_rate, six_second_view_through_rate, content_tags. Absent on every non-board surface.
ext.updated_atstringYes

Platform availability

27 platforms return the Post shape. id, flags.deleted are never null on any platform. The fields below vary: yes means the platform populates it (the value may still be null); a blank means the platform never provides it, so it is always null.

Platformauthor.verifiedengagement.savesengagement.sharescontent.duration_secondsengagement.viewsauthor.avatar_urlengagement.commentscontent.media_urlsurlengagement.likescontent.thumbnail_urlflags.pinned
Amazonyesyesyes
Apple Musicyesyesyesyes
Blueskyyesyesyesyes
Douyinyesyesyesyesyesyesyesyesyesyesyes
Facebookyesyesyesyesyesyesyesyesyesyesyes
GitHubyesyesyesyesyesyes
Googleyesyesyesyes
Hacker Newsyesyesyes
Instagramyesyesyesyesyesyesyesyesyesyesyes
Kickyesyesyesyesyesyesyesyesyesyes
Kwaiyesyesyesyesyesyesyesyesyesyesyes
LinkedInyesyesyesyesyesyesyesyesyes
Naveryesyesyes
Pinterestyesyesyesyesyesyesyesyesyesyesyes
Product Huntyes
Quorayesyesyesyesyes
Reddityesyesyesyesyesyesyesyesyesyesyesyes
Rumbleyesyesyesyesyes
Spotifyyesyesyesyesyes
Telegramyesyesyesyesyes
Threadsyesyesyesyesyesyesyesyesyes
TikTokyesyesyesyesyesyesyesyesyesyesyesyes
Truth Socialyesyesyesyesyesyesyesyesyesyes
Twitchyesyesyesyesyesyesyesyesyesyes
Twitter/Xyesyesyesyesyesyesyesyesyesyes
Xiaohongshuyesyesyesyesyesyesyesyesyesyes
YouTubeyesyesyesyesyesyesyesyes

Machine-readable schema

Validate responses programmatically against the JSON Schema (2020-12):

/schemas/post.json

Point a validator (Ajv, jsonschema, or your framework's) at that URL, or hand it to an agent so it can check the shape without a live call.

Returned by

Endpoints with the Post / PostList archetype return this shape:

Amazon · Apple Music · Bluesky · Douyin · Facebook · GitHub · Google · Hacker News · Instagram · Kick · Kwai · LinkedIn · Naver · Pinterest · Product Hunt · Quora · Reddit · Rumble · Spotify · Telegram · Threads · TikTok · Truth Social · Twitch · Twitter/X · Xiaohongshu · YouTube

See how the same fields map to each platform's raw upstream names in the cross-platform field equivalence table.

On this page