Web result API: one schema on 6 platforms

Endpoints

17 endpoints return web results on Facebook, Instagram, LinkedIn, Telegram, TikTok and X.

Schema

Every endpoint above returns an array of these objects as data, with a page object. The standard meta comes with every response.

platformstring

Platform the item is on.

typestring

The kind of item the result names, as the resource that describes it: profile (an account), post, hashtag, sound, place or community. The item's summary is the field of that name, and a filled result's record is details.<type>. A search that finds several kinds (a platform's top search) mixes them in one list. New values may be added as more kinds are searchable; treat unknown values as other.

One ofprofileposthashtagsoundplacecommunity

positioninteger

Zero-based rank of the result in the list, across pages: the search engine's order, counting only the results kept.

urlstring uri

The item's canonical link on the platform (the account's page for a profile, the post's for a post).

matched_urlstring uri

The page the index listed: the item's own page, or one of its pages that names it (a video of an account, for a profile found through it).

titlestringnullable

The page's title as the index shows it: often the item's name, but not the item's own field. Null when the index shows none.

snippetstringnullable

The index's excerpt of the page: often the item's description and counts as the page stated them when it was indexed, days or weeks ago. Null when the index shows none.

profileobjectnullable

The account the result names (type profile): what its link and the index's text say of it, completed from details when the result is filled. Null for every other type.

Show 8 child fields

idstringnullable

Platform-native account ID; null until the result is filled (the index shows only the handle).

usernamestringnullable

Handle without the @, as the matched link names it; null when the link names the account only by its number.

display_namestringnullable

Display name, as the index's title shows it; null when it shows none.

urlstring uri

Canonical profile URL (equals the result's url).

biostringnullable

Profile bio as the index's snippet quotes it (often cut short: see approximate_fields); null when it quotes none.

avatar_urlstring urinullable

Profile picture URL; null until the result is filled (an index's thumbnails are its own copies). Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null until the result is filled, or where the platform has no badge.

metricsobject

Counts as the index's snippet states them (rounded, as old as the index's copy: see approximate_fields), or the platform's current ones once filled; null = not stated.

Show 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.

postobjectnullable

The post the result names (type post): what its link and the index's text say of it, completed from details when the result is filled. Null for every other type.

Show 8 child fields

idstringnullable

Platform-native post ID: the one in the link where the platform's links name it (an X post's /status/<id>), else null until the result is filled.

urlstring uri

Canonical post URL (equals the result's url).

titlestringnullable

Headline, on platforms whose posts have one (a YouTube or Reddit title), as the index's title shows it; null on caption-only platforms (the page's title is the result's title).

textstringnullable

Caption or body as the index's snippet quotes it (often cut short: see approximate_fields); null when it quotes none.

published_atstring date-timenullable

When the post went public, as the index's text dates it (often to the day: see approximate_fields); null when it does not.

authorobject

The posting account as the link and the index's text name it (a /@<username>/video/ link's username, the title's display name); its id, avatar_url and is_verified null until the result is filled.

Show 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.

thumbnail_urlstring urinullable

Cover or poster image URL; null until the result is filled (an index's thumbnails are its own copies).

metricsobject

Counts as the index's snippet states them ("1,234 likes, 56 comments"; rounded, as old as the index's copy: see approximate_fields), or the platform's current ones once filled; null = not stated.

Show 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.

hashtagobjectnullable

The hashtag the result names (type hashtag): what its link and the index's text say of it, completed from details when the result is filled. Null for every other type.

Show 6 child fields

idstringnullable

The hashtag's ID as the platform's hashtag endpoints key it; null until the result is filled.

namestring

The tag without #, as the matched link or the index's title spells it (case kept where the title shows it).

urlstring uri

Canonical hashtag page URL (equals the result's url).

descriptionstringnullable

The hashtag's description as the index's snippet quotes it; null when it quotes none (a platform's generic page text is not one).

thumbnail_urlstring urinullable

The hashtag's own picture; null until the result is filled.

metricsobject

Counts as the index's text states them ("36.2M posts"; rounded, as old as the index's copy: see approximate_fields), or the platform's current ones once filled; null = not stated.

Show 1 child field

post_countintegernullable

Posts carrying the tag, as the platform counts them; rounded on YouTube and Threads (see approximate_fields).

soundobjectnullable

The sound the result names (type sound): what its link and the index's text say of it, completed from details when the result is filled. Null for every other type.

Show 7 child fields

idstringnullable

Platform-native sound ID; null until the result is filled.

urlstring urinullable

Canonical page of the sound (equals the result's url).

titlestringnullable

Sound or track title as the index's text shows it, else the words of the sound page's link (see approximate_fields); null when neither names it.

author_namestringnullable

Who the platform credits for the sound (a track's artist, an original sound's creator), as the index's text names it; null when it does not.

is_originalbooleannullable

An original sound a creator uploaded, as the index's title says ("original sound"); null when the text does not say, until the result is filled.

cover_urlstring urinullable

Cover art URL; null until the result is filled. Platform CDN URLs can expire within hours.

metricsobject

Counts as the index's text states them ("80K reels"; rounded, as old as the index's copy: see approximate_fields), or the platform's current ones once filled; null = not stated.

Show 1 child field

post_countintegernullable

Posts using the sound (TikTok videos, Instagram and Facebook reels, YouTube Shorts), as the platform counts them.

placeobjectnullable

The place the result names (type place): what its link and the index's text say of it, completed from details when the result is filled. Null for every other type.

Show 10 child fields

idstringnullable

Platform-native place ID; null until the result is filled.

namestringnullable

Place name as the index's title shows it; null when it shows none.

urlstring uri

Canonical place page URL (equals the result's url).

categorystringnullable

The platform's category label, as the index's text shows it; null when it does not.

addressstringnullable

Address as the index's text shows it; null when it does not.

citystringnullable

City or locality, as the index's text shows it.

country_codestringnullable

ISO 3166-1 alpha-2 country of the place.

latitudenumbernullable

WGS 84 latitude in degrees; null unless the index's text states coordinates, until the result is filled (set together with longitude).

longitudenumbernullable

WGS 84 longitude in degrees; null unless the index's text states coordinates, until the result is filled (set together with latitude).

metricsobject

Counts as the index's text states them ("12K posts"; rounded, as old as the index's copy: see approximate_fields), or the platform's current ones once filled; null = not stated.

Show 3 child fields

post_countintegernullable

Public posts tagged with the place, as the platform counts them.

review_countintegernullable

Public reviews or recommendations of the place, as the platform counts them.

image_countintegernullable

Pictures the platform has of the place; more than the length of images when the source returns only the first ones.

communityobjectnullable

The community the result names (type community: a group, a subreddit): what its link and the index's text say of it, completed from details when the result is filled. Null for every other type.

Show 8 child fields

idstringnullable

Platform-native community ID; null until the result is filled.

namestringnullable

The name its links use, as the matched link names it (golang for r/golang, a Facebook group's vanity name); null when the link names it only by number.

titlestringnullable

The community's title as the index's title shows it; null when it shows none.

descriptionstringnullable

Its description as the index's snippet quotes it (often cut short: see approximate_fields); null when it quotes none (a platform's generic page text is not one).

urlstring uri

Canonical community URL (equals the result's url).

avatar_urlstring urinullable

The community's icon or picture; null until the result is filled.

privacystringnullable

Who can see and post, as the index's text says ("Public group"); null when it does not. New values may be added; treat unknown values as restricted.

One ofpublicrestrictedprivate

metricsobject

Counts as the index's text states them ("762K members"; rounded, as old as the index's copy: see approximate_fields), or the platform's current ones once filled; null = not stated.

Show 1 child field

member_countintegernullable

Members (on Reddit, subscribers) as the platform counts them.

detailsobjectnullable

The item's own record from the platform, fetched when the request asked for it (fill=true): what the platform's endpoint for the kind returns, under the result's type (details.profile). Null when not asked for, when the platform has no endpoint for the kind, or when it did not serve the item (meta.warnings says how many).

Show 6 child fields

These fields, in this page's Markdown

platform_specificobject

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

Show 2 child fields

facebookobjectnullable

What the index shows of a Facebook account beyond the summary.

Show 5 child fields

account_typestringnullable

What the index's text says the account is: page (Facebook describes it with counts, as it does a Page, and a person in professional mode) or person (Facebook's "is on Facebook" text). Null when the text doesn't say. New values may be added.

One ofpageperson

like_countintegernullable

The Page's likes as the index's snippet states them; null when it does not, as for most Pages, which show followers instead.

talking_about_countintegernullable

How many people Facebook counted as talking about the account, as the index's snippet states it; null when it does not.

were_here_countintegernullable

How many people have checked in at the account's place, as the index's snippet states it; null when it does not.

placestringnullable

Where the account is, as the index's snippet names it after its name (a city, usually); null when it does not.

linkedinobjectnullable

What the index shows of a LinkedIn account beyond the summary.

Show 7 child fields

kindstringnullable

What the account is on LinkedIn, as its link says: a company's Page, a school's, a showcase page, or a member. Null when unknown. New values may be added; treat unknown values as unknown.

One ofcompanyschoolshowcasemember

taglinestringnullable

A Page's tagline as the index's snippet quotes it; null when it quotes none, and for a member.

headlinestringnullable

What the index's title says of a member after their name: their headline, or where LinkedIn hides it their current employer, school or place (often cut short); null when it says none, and for a Page.

locationstringnullable

Where a member is, as the index's snippet or title says it; null when it does not, and for a Page.

companystringnullable

A member's current employer, as the index's snippet says it; null when it does not, and for a Page.

schoolstringnullable

The school a member's profile shows first, as the index's snippet says it; null when it does not, and for a Page.

connection_countintegernullable

A member's connections as the index's snippet states them (LinkedIn shows any count above 500 as 500+, which is 500 here); null when it does not, and for a Page.

approximate_fieldsstring[]

JSON paths of values parsed from the index's display text or rounded there (profile.metrics.follower_count from "13K followers", a profile.bio or post.text the snippet cut short). Filled values are exact and leave the list. [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none; [] when every list is known (a result has none yet).