StatusSupportGet API keyDashboard
SchemasPosts

Schemas

Post

Use with AI

Public posts (videos, reels, shorts, photos, carousels, tweets and text) with their author, text, media, and views, likes and comments.

Endpoints

67 endpoints return posts on Amazon, Apple Music, Bluesky, Facebook, Instagram, Kick, Kwai, LinkedIn, Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, Truth Social, Twitch, X and YouTube.

Schema

Single-item endpoints return this object as data; list endpoints return an array of them as data with a page object. The standard meta comes with every response.

platformstring

Platform ID (tiktok, youtube, …).

idstring

Platform-native post ID (string; Instagram shortcode, Reddit with its t3_ prefix).

urlstring uri

Canonical post URL.

typestring

Normalized content shape. New values may be added; treat unknown values as other.

One ofvideoimagecarouseltextlinkaudio

platform_typestringnullable

The platform's own product label, lowercase (reel, short, story, live, tweet, …).

titlestringnullable

Headline (YouTube title, Reddit title); null on caption-only platforms.

textstringnullable

Caption, description or body as plain text.

languagestringnullable

BCP-47 language of text, when the platform states it.

published_atstring date-timenullable

When the post went public, RFC 3339 UTC.

authorobject

The posting account. An account the platform no longer names (a deleted account) has a null id and username and the platform's label as display_name (Reddit: [deleted]). A post credited to what is no account of the platform's (an Apple Music radio episode's show) has a null id and username, and every other field null too when the platform doesn't name it.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

coauthorsobject[]

Other accounts credited as co-authors of the post (Instagram and Facebook collabs, YouTube collaborations), in the platform's order, author excluded; [] if none.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

duration_msintegernullable

Length of the primary video or audio in milliseconds; null for other posts.

thumbnail_urlstring urinullable

Cover or poster image URL.

mediaobject[]

Attachments in display order (carousel items); [] for text posts.

ShowHide 8 child fields
typestring

Kind of file. New values may be added; treat unknown values as other.

One ofimagevideoaudiogif

urlstring urinullable

Direct file URL; null when the platform withholds it, or when the link would only work from SocialTap's network or with a login. Often signed and expiring: see expires_at.

expires_atstring date-timenullable

When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire.

thumbnail_urlstring urinullable

Poster or preview image URL.

widthintegernullable

Width in pixels.

heightintegernullable

Height in pixels.

duration_msintegernullable

Duration in milliseconds (video and audio only).

alt_textstringnullable

Accessibility text provided by the author or platform.

hashtagsstring[]

Hashtags without #, case kept; [] if none.

mentionsstring[]

Mentioned or tagged usernames without @; [] if none.

is_pinnedbooleannullable

Pinned to the author's profile.

is_sponsoredbooleannullable

Labeled as a paid partnership or branded content.

is_nsfwbooleannullable

Marked adult or sensitive by the platform.

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 7 child fields
view_countintegernullable

Views or plays.

like_countintegernullable

Likes, hearts, total reactions or upvotes; never negative. Null when hidden by the owner.

comment_countintegernullable

Comments and replies.

share_countintegernullable

Shares or sends (not reposts).

repost_countintegernullable

Reposts, retweets or reshares.

quote_countintegernullable

Quote posts.

save_countintegernullable

Saves, bookmarks or favorites.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 21 child fields

These fields, in this page's Markdown

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text. A list path (external_links) means the list may be incomplete. [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.

Item errors

Besides the request-level errors every endpoint can return, post endpoints return:

CodeHTTPRetryMeaningWhat to do
not_found404NoThe item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).Check the link or ID. Do not retry.
private_or_unavailable403NoThe item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.Only public items can be fetched. Do not retry.

Last updated