StatusSupportGet API keyDashboard
SchemasHashtags

Schemas

Hashtag

Use with AI

Public hashtags with their description, image and how many posts carry them (and, where shown, their views).

Endpoints

4 endpoints return hashtags on Instagram and TikTok.

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, instagram, …).

idstring

Platform-native hashtag ID (TikTok's challenge ID, Threads' tag ID); on platforms whose public pages key a hashtag by its name (Instagram, YouTube, Facebook, X), the name lowercased.

namestring

The tag without #, as the platform shows it (case kept). Threads tags may contain spaces ("book club").

urlstring uri

Canonical hashtag page URL (for a multi-word Threads tag, its tag search page).

descriptionstringnullable

The hashtag's description as its page shows it; null when it has none.

thumbnail_urlstring urinullable

The hashtag's own picture (not one of its posts' images); null when it has none. Platform CDN URLs can expire.

metricsobject

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

ShowHide 1 child field
post_countintegernullable

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

platform_specificobject

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

ShowHide 4 child fields
tiktokobjectnullable

A TikTok hashtag's own fields.

ShowHide 10 child fields
view_countintegernullable

Views across every post carrying the tag, all time, exact; null where TikTok does not show it.

banner_urlstring urinullable

The hashtag page's cover image URL; null when it has none. TikTok CDN URLs can expire.

is_promotedbooleannullable

An advertiser's hashtag: a Branded Hashtag Challenge, or one Creative Center marks promoted.

rankintegernullable

Position on the requested trending board (1 = most popular; the request's country, period and industry); null off a board.

rank_changeintegernullable

Places climbed since the previous period (negative: fell, 0: unchanged); null when new to the board or off a board.

is_new_to_boardbooleannullable

First time on the board this period; null off a board.

period_post_countintegernullable

Posts with the tag published in the board's period (the request's window); null off a board.

period_view_countintegernullable

Views in the board's period of posts with the tag; null off a board.

industrystringnullable

The industry Creative Center files the hashtag under (Apparel & Accessories, Games, …), as shown; not normalized.

trendobject[]

The hashtag's popularity over the board's period, oldest first; [] off a board (in unknown_fields).

ShowHide 2 child fields
start_atstring date-time

Start of the interval (a day on TikTok's boards), RFC 3339 UTC.

popularitynumber

Popularity in the interval relative to the period's peak, 0 to 1, as Creative Center scales it.

instagramobjectnullable

An Instagram hashtag's own fields.

ShowHide 3 child fields
is_restrictedbooleannullable

Instagram restricts the tag: its posts are hidden (a tag it reports as sensitive), though it exists.

is_trendingbooleannullable

Instagram marks the tag trending; null where it does not say (search results).

tag_idstringnullable

Instagram's own numeric ID of the hashtag; null where the source does not show it (a tag Instagram withholds).

youtubeobjectnullable

A YouTube hashtag's own fields.

ShowHide 1 child field
channel_countintegernullable

Channels that posted with the tag, rounded by YouTube (in approximate_fields).

threadsobjectnullable

A Threads tag's own fields.

ShowHide 2 child fields
is_communitybooleannullable

The tag is a Threads community ("NBA Threads"), not a plain tag.

recent_post_countintegernullable

Recent posts with the tag as Threads counts them (it does not state the window), rounded (in approximate_fields).

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text ("36M videos": metrics.post_count). [] 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, hashtag 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.

Last updated