Schemas

Public accounts (creators, channels, pages, companies, communities) with their bio, links, and follower and post counts.

Endpoints

36 endpoints return profiles on Amazon, Apple Music, Bluesky, Facebook, Facebook Ad Library, Google Ads Transparency Center, Instagram, Komi, Kwai, Lnk.Bio, LinkedIn, Linkme, Linktree, Pillar, 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 account ID (string; YouTube UC…, Reddit t2_…).

usernamestringnullable

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

display_namestringnullable

Display name, channel title or page name; null when empty or not exposed.

urlstring uri

Canonical profile URL.

typestring

Coarse account kind, as the platform labels it; unknown when it does not (TikTok labels organizations only). New values may be added; treat unknown values as unknown.

One ofpersonorganizationcommunityunknown

biostringnullable

Profile bio, channel description or page about text; null when empty or not exposed.

avatar_urlstring urinullable

Profile picture URL (largest available). Platform CDN URLs can expire within hours.

banner_urlstring urinullable

Header or cover image URL.

is_verifiedbooleannullable

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

is_privatebooleannullable

True when the account's posts are not public.

categorystringnullable

Platform category label (e.g. Musician, Media & Entertainment), as shown; not normalized. Often set only for business or creator accounts.

external_linksobject[]

Links in the bio or channel links; [] if none or not exposed.

ShowHide 2 child fields
urlstring uri

Link target, absolute (https:// is added where the platform stores the link without a scheme).

titlestringnullable

Link label shown by the platform.

locationstringnullable

Self-declared location text.

country_codestringnullable

ISO 3166-1 alpha-2 country the platform states for the account.

created_atstring date-timenullable

Account creation or join date, RFC 3339 UTC (some platforms give only the day: see approximate_fields).

metricsobject

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

ShowHide 5 child fields
follower_countintegernullable

Followers or subscribers.

following_countintegernullable

Accounts this profile follows.

post_countintegernullable

Posts or videos as the platform counts them on the profile (for a private account, posts the caller cannot see).

total_like_countintegernullable

Likes received across all of the profile's posts (not likes given).

total_view_countintegernullable

Lifetime views across all of the profile's posts.

platform_specificobject

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

ShowHide 26 child fields
approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text (e.g. metrics.follower_count). 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, profile 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