Skip to main content
POST

Authorizations

x-api-key
string
header
required

Your API key. Include it in the x-api-key header for all requests.

Headers

x-streamforge-end-user
string

Only for API keys that carry a per-end-user allowance, which must send it on every call; other keys can leave it out. An opaque identifier for the person the request is made for: 8 to 128 characters of A-Z, a-z, 0-9, _ and -. Send a stable pseudonymous value, not an IP address or other personal data. A request can be read back only with the value it was created with.

Pattern: ^[A-Za-z0-9_-]{8,128}$
Example:

"8f2c1d7ab0e94c53"

Body

application/json

Exactly one of handle, profile_id and url. platform is required with handle or profile_id; with url it is optional and, if sent, must be the platform the URL belongs to.

platform
enum<string>
Available options:
twitch,
youtube,
instagram,
tiktok,
twitter
handle
string

The creator's handle on the platform. Case does not matter and a leading @ is ignored

Example:

"examplecreator"

profile_id
string

Platform-specific creator ID. For YouTube, a channel ID (UC followed by 22 characters)

Example:

"484563826"

url
string

A link to the creator's profile or channel on YouTube, Twitch, TikTok, Instagram or X. The scheme is optional

Example:

"https://www.youtube.com/@examplecreator"

audience
boolean
default:true

Whether to produce the audience analysis as well as the profile

Response

The request has finished. payload.status is ready, partial, not_found or failed

payload
object
meta
object