Home Docs API reference Data models Data models Every endpoint returns one of these models in data. The same field names mean the same thing on every platform. A field the platform does not provide is null, never invented; platform details with no field of their own are in extra. Pass trim=true to drop null fields and extra, or raw=true to also get the platform's original object next to data.
Lists#
Every list endpoint returns a list object. See Pagination .
Field Type Notes object"list"itemsarray The page of results; the type depends on the endpoint. cursorstring or null Pass it back unchanged for the next page. null on the last page. has_moreboolean Whether another page exists. parentobject or null The thing the list belongs to (a profile for its posts), where the platform returns it.
Activity#
One public activity event (GitHub events).
Field Type Required Notes object"activity"platformPlatform yes idstring yes typestring yes platform's event type, snake_case: "push", "pull_request", "star" actorAuthor or nullrepostring or null created_atstring (ISO 8601 date-time) or null extraobject or null
Field Type Required Notes object"ad"platformPlatform yes the ad library's platform idstring yes urlstring or null advertiserAdvertiser or nullstatus"active" or "inactive" or "unknown"started_atstring (ISO 8601 date-time) or null ended_atstring (ISO 8601 date-time) or null titlestring or null bodystring or null cta_textstring or null landing_urlstring or null formatstring or null "image" | "video" | "carousel" | "text" | platform-specific mediaMedia regionsstring[] or null publisher_platformsstring[] or null where it ran: facebook, instagram, ... impressionsRange or nullspendRange or nullextraobject or null
Advertiser#
Field Type Required Notes object"advertiser"platformPlatform yes the ad library's platform idstring or null namestring or null urlstring or null page_idstring or null countrystring or null verifiedboolean or null ad_countinteger or null extraobject or null
Album#
Field Type Required Notes object"album"platformPlatform yes idstring yes urlstring or null titlestring or null artistsstring[] or null released_atstring (ISO 8601 date) or null track_countinteger or null cover_urlstring or null labelstring or null tracksSong [] or nullextraobject or null
Author#
Compact reference to a profile, embedded in posts, comments, ads.
Field Type Required Notes idstring or null handlestring or null namestring or null urlstring or null avatar_urlstring or null verifiedboolean or null
BatchItem#
One envelope per batch request, in order. response is a full envelope.
Field Type Required Notes pathstring yes statusinteger yes responseobject yes
BatchResult#
Field Type Required Notes object"batch"resultsBatchItem []yes
Collection#
An ordered set of items someone curates: playlists, boards, podcasts, highlights.
Field Type Required Notes object"collection"platformPlatform yes idstring yes urlstring or null kind"playlist" or "board" or "podcast" or "highlight" or "topic" or "collection" or "unknown"titlestring or null descriptionstring or null ownerAuthor or nullitem_countinteger or null cover_urlstring or null updated_atstring (ISO 8601 date-time) or null extraobject or null
Field Type Required Notes object"comment"platformPlatform yes idstring yes urlstring or null post_idstring or null parent_idstring or null set on replies authorAuthor or nulltextstring or null published_atstring (ISO 8601 date-time) or null statsCommentStats is_pinnedboolean or null is_by_creatorboolean or null extraobject or null
Field Type Required Notes likesinteger or null repliesinteger or null dislikesinteger or null
A place people post into: subreddits, Facebook groups, X communities, Telegram channels.
Field Type Required Notes object"community"platformPlatform yes idstring or null urlstring or null kind"subreddit" or "group" or "community" or "channel" or "unknown"namestring or null the slug, "python" for r/python titlestring or null descriptionstring or null avatar_urlstring or null banner_urlstring or null member_countinteger or null online_countinteger or null is_nsfwboolean or null is_privateboolean or null verifiedboolean or null the platform's verified badge (Telegram channels) created_atstring (ISO 8601 date-time) or null extraobject or null
ContributionDay#
Field Type Required Notes datestring (ISO 8601 date) yes countinteger yes
Contributions#
Field Type Required Notes object"contributions"platformPlatform yes handlestring or null totalinteger or null daysContributionDay [] or nullextraobject or null
CreatorEmails#
Publicly listed emails for a creator, each with where it was found.
Field Type Required Notes object"creator_emails"platformPlatform yes the platform of the profile that was asked about handlestring or null profile_urlstring or null emailsFoundEmail []yes extraobject or null
CreditBalance#
Field Type Required Notes object"credit_balance"credits_remaininginteger yes team_idstring yes
Embed#
Field Type Required Notes object"embed"platformPlatform yes urlstring or null htmlstring yes extraobject or null
Event#
Field Type Required Notes object"event"platformPlatform yes idstring yes urlstring or null titlestring or null descriptionstring or null starts_atstring (ISO 8601 date-time) or null ends_atstring (ISO 8601 date-time) or null placePlace or nullis_onlineboolean or null hostAuthor or nullgoing_countinteger or null interested_countinteger or null cover_urlstring or null extraobject or null
FoundEmail#
Field Type Required Notes emailstring yes source_urlstring or null where it was published kindstring or null "business" | "management" | "personal" | ...
JobAccepted#
Answer for a job that is still running. Poll poll_url (free).
Field Type Required Notes object"job"job_idstring yes status"pending" or "running"yes poll_urlstring yes
Link#
Field Type Required Notes titlestring or null urlstring yes
LinkPage#
A link-in-bio page (Linktree, Komi, Pillar, Linkbio, Linkme).
Field Type Required Notes object"link_page"platformPlatform yes handlestring or null urlstring or null namestring or null biostring or null avatar_urlstring or null linksLink [] or nullsocialsLink [] or nulltitle = platform name extraobject or null
LiveStream#
Field Type Required Notes object"live_stream"platformPlatform yes is_liveboolean yes idstring or null room / stream id urlstring or null authorAuthor or nulltitlestring or null viewer_countinteger or null like_countinteger or null started_atstring (ISO 8601 date-time) or null cover_urlstring or null extraobject or null
Location#
A named place with coordinates (Facebook Marketplace city search).
Field Type Required Notes object"location"platformPlatform yes idstring or null namestring yes regionstring or null state / province countrystring or null ISO 3166-1 alpha-2 when known latitudenumber or null longitudenumber or null extraobject or null
Field Type Required Notes thumbnail_urlstring or null video_urlstring or null audio_urlstring or null image_urlsstring[] or null widthinteger or null heightinteger or null
Monitor#
Field Type Required Notes object"monitor"idstring yes endpointstring yes endpoint path it watches, "/v1/tiktok/profile/videos" paramsobject yes interval_minutesinteger yes webhook_urlstring yes activeboolean yes false: deleted, or paused after repeated failures (last_error says why) created_atstring (ISO 8601 date-time) yes webhook_secretstring or null last_run_atstring (ISO 8601 date-time) or null next_run_atstring (ISO 8601 date-time) or null last_errorstring or null error code of the last failed run, "insufficient_credits", ...
MonitorEvent#
Field Type Required Notes object"monitor_event"idstring yes monitor_idstring yes type"new_items"yes itemsobject[] yes normalised objects, as the watched endpoint returns them created_atstring (ISO 8601 date-time) yes
Place#
Field Type Required Notes namestring or null addressstring or null citystring or null regionstring or null countrystring or null ISO 3166-1 alpha-2 when known latitudenumber or null longitudenumber or null
Post#
Videos, reels, tweets, pins, clips, stories, Reddit posts: all posts with a type.
Field Type Required Notes object"post"platformPlatform yes idstring yes urlstring or null type"video" or "short" or "reel" or "image" or "carousel" or "story" or "live" or "clip" or "text" or "link" or "tweet" or "pin" or "community_post" or "episode" or "unknown"authorAuthor or nulltitlestring or null textstring or null published_atstring (ISO 8601 date-time) or null duration_secondsnumber or null languagestring or null hashtagsstring[] or null mentionsstring[] or null statsStats mediaMedia songSongRef or nulllocationPlace or nullis_pinnedboolean or null is_sponsoredboolean or null extraobject or null
Price#
Field Type Required Notes amountnumber or null currencystring or null ISO 4217 original_amountnumber or null before a discount displaystring or null as the platform shows it, "$12.99"
Product#
Shop products and marketplace listings.
Field Type Required Notes object"product"platformPlatform yes idstring yes urlstring or null titlestring or null descriptionstring or null pricePrice or nullsellerAuthor or nullratingnumber or null review_countinteger or null sold_countinteger or null image_urlsstring[] or null categorystring or null in_stockboolean or null locationPlace or nullpublished_atstring (ISO 8601 date-time) or null extraobject or null
Profile#
Field Type Required Notes object"profile"platformPlatform yes idstring or null handlestring or null namestring or null headlinestring or null a short tagline apart from the bio (LinkedIn's headline) urlstring or null kind"person" or "creator" or "channel" or "page" or "company" or "artist" or "organization" or "shop" or "unknown"biostring or null avatar_urlstring or null banner_urlstring or null verifiedboolean or null is_privateboolean or null external_urlstring or null linksLink [] or nulllocationstring or null categorystring or null created_atstring (ISO 8601 date-time) or null statsProfileStats extraobject or null
ProfileStats#
Field Type Required Notes followersinteger or null followinginteger or null postsinteger or null likesinteger or null viewsinteger or null
PullRequest#
Field Type Required Notes object"pull_request"platformPlatform yes idstring yes urlstring or null repostring or null "owner/name" numberinteger or null titlestring or null state"open" or "closed" or "merged" or "unknown"authorAuthor or nullcreated_atstring (ISO 8601 date-time) or null closed_atstring (ISO 8601 date-time) or null merged_atstring (ISO 8601 date-time) or null extraobject or null
Range#
A bounded estimate as ad libraries publish them (impressions, spend).
Field Type Required Notes lowernumber or null uppernumber or null currencystring or null
Repo#
Field Type Required Notes object"repo"platformPlatform yes idstring or null full_namestring yes "owner/name" namestring or null urlstring or null ownerAuthor or nulldescriptionstring or null languagestring or null topicsstring[] or null licensestring or null starsinteger or null forksinteger or null watchersinteger or null open_issuesinteger or null is_forkboolean or null is_archivedboolean or null default_branchstring or null created_atstring (ISO 8601 date-time) or null updated_atstring (ISO 8601 date-time) or null pushed_atstring (ISO 8601 date-time) or null extraobject or null
RequestLogEntry#
One past API request of the team (account request history).
Field Type Required Notes object"request_log"request_idstring yes endpointstring yes the path that was called, "/v1/tiktok/profile" endpoint_idstring or null statusinteger yes credits_chargedinteger yes cachedboolean or null created_atstring (ISO 8601 date-time) yes
Review#
Field Type Required Notes object"review"platformPlatform yes idstring yes product_idstring or null authorAuthor or nullratingnumber or null textstring or null published_atstring (ISO 8601 date-time) or null image_urlsstring[] or null extraobject or null
SearchResult#
One organic web search result (Google search).
Field Type Required Notes object"search_result"platformPlatform yes positioninteger or null titlestring or null urlstring yes displayed_urlstring or null snippetstring or null kindstring or null "organic" | "video" | "news" | ... extraobject or null
Song#
A sound or music track (TikTok sounds, Spotify/Apple/SoundCloud tracks).
Field Type Required Notes object"song"platformPlatform yes idstring yes urlstring or null titlestring or null artistsstring[] or null albumstring or null duration_secondsnumber or null cover_urlstring or null preview_urlstring or null released_atstring (ISO 8601 date) or null isrcstring or null explicitboolean or null is_originalboolean or null TikTok "original sound" statsSongStats extraobject or null
SongRef#
The sound used by a post (TikTok, Reels, Shorts).
Field Type Required Notes idstring or null titlestring or null artiststring or null urlstring or null
SongStats#
Field Type Required Notes playsinteger or null usesinteger or null videos made with the sound likesinteger or null
Stats#
Engagement on a post. Same five names on every platform.
Field Type Required Notes viewsinteger or null likesinteger or null commentsinteger or null sharesinteger or null savesinteger or null dislikesinteger or null where the platform shows them (Rumble)
Suggestion#
One search suggestion or typeahead entry (TikTok, YouTube, Instagram).
Field Type Required Notes object"suggestion"platformPlatform yes kind"query" or "channel" or "user" or "hashtag" or "place" or "product" or "unknown"textstring yes idstring or null channel / user / hashtag / place id when the platform gives one handlestring or null urlstring or null image_urlstring or null verifiedboolean or null extraobject or null
Transcript#
Field Type Required Notes object"transcript"platformPlatform yes video_idstring or null urlstring or null languagestring or null BCP 47, "en" source"captions" or "auto_captions" or "ai"yes duration_secondsnumber or null textstring yes segmentsTranscriptSegment [] or nullavailable_languagesstring[] or null extraobject or null
TranscriptSegment#
Field Type Required Notes startnumber yes seconds endnumber or null textstring yes
UsageStat#
Aggregated usage: one day (date set) or one endpoint (endpoint set).
Field Type Required Notes object"usage_stat"datestring (ISO 8601 date) or null endpointstring or null requestsinteger yes credits_chargedinteger yes
WebhookDelivery#
One delivery attempt of a monitor event.
Field Type Required Notes object"webhook_delivery"event_idstring yes monitor_idstring yes attemptinteger yes status_codeinteger or null okboolean yes dead_letterboolean yes the last attempt of a chain that gave up; redeliver to try again errorstring or null created_atstring (ISO 8601 date-time) yes
WebhookRedelivery#
Field Type Required Notes object"webhook_redelivery"event_idstring yes queuedboolean yes previous_state"pending" or "retrying" or "dead"yes
WebhookTest#
What the receiver answered to a signed test event ("type": "test").
Field Type Required Notes object"webhook_test"monitor_idstring yes deliveredboolean yes status_codeinteger or null errorstring or null
Allowed values: youtube, tiktok, instagram, reddit, bluesky, threads, truthsocial, pinterest, twitch, kick, snapchat, linktree, komi, pillar, linkbio, linkme, twitter, facebook, linkedin, amazon, spotify, apple_music, soundcloud, github, kwai, rumble, telegram, google, cosmos, web.