Skip to main content
POST

Overview

Scrapes a public TikTok or YouTube account (profile and recent videos) and computes engagement metrics, top hashtags and more. The account is saved to your team; read it later with Account Details or List Accounts. The request waits for the scrape to finish, so it can take a while; set a generous client timeout. Keywords are generated afterwards in the background: keywords may be empty at first; check keywordsStatus in Account Details (pending, processing, completed, or failed when the keywords could not be generated). Analyzing an account your team already analyzed runs the analysis again, updates the saved account and charges again (same id, 201). To update an existing account you can also use Refresh Account.

Credits

8 credits per call. Scraping is a platform cost, so it is charged to every team, including teams that use their own provider keys (BYOK). The credits are refunded if the scrape fails or the account is not found.

Errors

This endpoint charges credits. Send an Idempotency-Key header to retry safely: a retry with the same key and body after a timeout returns the first answer and is not charged again.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Makes the request safe to retry. 1-255 printable ASCII characters, one per operation (your job id, or a UUID you store), reused on every retry. Within 24 hours the same key with the same body answers with the first response and the header Idempotent-Replayed: true, without running or charging again. Keys are scoped to your team and the endpoint. 5xx answers and refusals before anything ran (401, 402, 403, 409, 429) are not kept. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x20-\x7E]+$

Body

application/json
username
string
required

The account handle. A leading @ is removed and the value is lowercased.

Required string length: 1 - 100
platform
enum<string>
required

The platform the handle belongs to

Available options:
tiktok,
youtube

Response

Account analyzed

success
boolean
message
string

Account analyzed successfully

data
object