Live Data

Get Account by Username

Fetches an account by its handle, with or without a leading @.

PlatformNotes
TikTok
Instagramthe post total is best effort and can be null
YouTubethe channel handle
Facebookpages and public profiles; some profiles come without a bio
Snapchatpublic profiles only; a personal account without one is refused

Examples:

  • GET /live/instagram/accounts/username/nike
  • GET /live/snapchat/accounts/username/nike

Fields a platform does not publish are null. region is a hint: TikTok uses it as the country the lookup is made from, the other platforms ignore it.

Optional live endpoint. You do not need this endpoint for normal API integrations; prefer tracked accounts, tracked videos, analytics, projects, and Creator Hub endpoints when working with viral.app data.

⚠️ Consumes extra credits: 3 credits per request. Additional charges may apply.

Headers:

  • X-Viral-Credits-Consumed
  • X-Viral-Credits-Meter
  • X-Viral-Credits-Benefited-Remaining
  • X-Viral-Credits-Can-Purchase-Extra
  • Retry-After (on 429 responses)

A page past the only one of a one-page lookup costs nothing: it carries X-Viral-Credits-Consumed: 0 and X-Viral-Credits-Meter, without the two balance headers.

get/live/{platform}/accounts/username/{username}

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/live/{platform}/accounts/username/{username}
  • Auth: API key in header x-api-key

Path parameters

platform'facebook' | 'instagram' | 'tiktok' | 'youtube' | 'snapchat' required

Social media platform (facebook, instagram, tiktok, youtube, snapchat)

Example:facebook
usernamestring required

Platform username without a leading @ prefix

Example:acme

Query parameters

regionstring nullable

Region code (2-letter ISO country code)

Example:US

Response

OK

platform'facebook' | 'instagram' | 'tiktok' | 'youtube' | 'snapchat' required

Social media platform (facebook, instagram, tiktok, youtube, snapchat)

platform_account_idstring nullable required

Native platform account id

account_usernamestring nullable required
account_display_namestring nullable required
account_profile_picture_urlstring nullable

URL

is_verifiedboolean nullable
is_privateboolean nullable
follower_countinteger nullable
following_countinteger nullable
video_countinteger nullable
biostring nullable
regionstring nullable

Region code (2-letter ISO country code)

Example response

{
  "platform": "facebook",
  "platform_account_id": "7123456789012345678",
  "account_profile_picture_url": "https://www.myproject.com",
  "region": "US"
}

Changes

No recorded changes to this operation across all 1 revision of this API.