Our own visit statistics are always on. Google Analytics, which helps us understand how people use our public pages (not your signed-in workspace), is enabled only with your permission. See our Privacy policy.

POST

API health

24h health
Normal
24h average time
—
  • Healthy / normal
  • Available
  • Limited
  • Mostly down
Normal

Check whether a TikTok account is live right now, by handle. While it is live you get the room ID, title, link, viewers now, peak and total viewers, likes, shares, product count, start time, cover and a stream link that expires. An account that is not live returns one row with is_live false.

Price $0.81 per 1,000 requests ($0.000806 per call). Failed calls and empty results are not charged. Synchronous. For slow jobs add "mode": "async" to the body, take the job_id and poll.

AI prompt

Please help me write a data collection script with the EveryInfra TikTok Live room endpoint (tiktok/live_room).

How the endpoint works:
- Request: POST https://api.everyinfra.com/api/v1/social with the header Authorization: Bearer <API key>. Read the key from the EVERYINFRA_API_KEY environment variable and never hard-code it.
- In the request body, set platform to tiktok and action to live_room, and put the parameters inside params.
- Required parameters:
  - username: The TikTok handle to check, such as tiktoklive_latam; a leading @ is removed and a profile link works too.
- Returns one object. Main fields: username, display_name, user_id, is_live, room_id, url, title, viewer_count, peak_viewer_count, total_viewer_count, like_count, share_count; 16 fields in total, full list at https://api.everyinfra.com/api/v1/social/catalog?platform=tiktok.
- Example request body:
{
  "platform": "tiktok",
  "action": "live_room",
  "params": {
    "username": "nasa"
  }
}
- Price: $0.81 per 1,000 requests; failed and empty results are not charged.
- For dozens or hundreds of targets, add "mode": "async" to the body: you get a job_id at once and poll GET https://api.everyinfra.com/api/v1/jobs/{job_id} for the result.
- On 422, fix the request using the suggested parameter names and allowed values in the error; on 429 or 503, wait for Retry-After and try again.

Before writing code, ask me which targets I need, how many, which fields, and what output format I want; then confirm the plan and the rough cost with me.

Request parameters

NameInTypeRequiredDefaultDescription
AuthorizationheaderstringYes-Bearer followed by your API key. Create it in the console; never put it in a URL or a code repository.
platformbodystringYestiktokPlatform identifier, fixed value.
actionbodystringYeslive_roomCapability identifier, fixed value.
usernamebody.paramsstringYes-The TikTok handle to check, such as tiktoklive_latam; a leading @ is removed and a profile link works too.

Code samples

bash
curl -X POST 'https://api.everyinfra.com/api/v1/social' \
  -H "Authorization: Bearer $EVERYINFRA_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "platform": "tiktok",
  "action": "live_room",
  "params": {
    "username": "nasa"
  }
}'

OpenAPI definition (JSON)Samples read the key from the EVERYINFRA_API_KEY environment variable; copied code never contains your key.

Response example

Field preview

No sample response is available for these parameters yet. This preview shows the response shape and fields from the API definition, with … as placeholders; it is not the result of a live call.

json
{
  "id": "req_…",
  "platform": "tiktok",
  "action": "live_room",
  "results": {
    "username": …,
    "display_name": …,
    "user_id": …,
    "is_live": …,
    "room_id": …,
    "url": …,
    "title": …,
    "viewer_count": …,
    "peak_viewer_count": …,
    "total_viewer_count": …,
    "like_count": …,
    "share_count": …,
    "product_count": …,
    "started_at": …,
    "cover_image_url": …,
    "stream_url": …,
    "platform": …
  },
  "billing": {
    "charged": …,
    "charged_usd": …,
    "balance_after_usd": …,
    …
  },
  "quota": { … }
}

Response fields

Business data is in results. The table lists the fields a record can contain; values the platform does not show are never made up.

FieldMeaning
usernameUsername (@handle).
display_nameDisplay name; can differ from username.
user_idUser's unique ID on the platform.
is_liveKeeps the platform's own meaning
room_idKeeps the platform's own meaning
urlLink to the record on the platform.
titleTitle. null when the platform has no titles (for example text-only posts).
viewer_countKeeps the platform's own meaning
peak_viewer_countKeeps the platform's own meaning
total_viewer_countKeeps the platform's own meaning
like_countLikes. null means the platform or this capability does not disclose it; it is not 0.
share_countShares. null means not disclosed, not 0.
product_countKeeps the platform's own meaning
started_atKeeps the platform's own meaning
cover_image_urlKeeps the platform's own meaning
stream_urlKeeps the platform's own meaning
platformSource platform identifier, the same as platform in the request (for example xiaohongshu, tiktok).

Errors and billing

401
Missing or invalid key.
402
Insufficient balance. Top up first.
422
Invalid parameter name or value. Fix it using the suggestions in the error. No charge.
429
Per-minute request limit reached. Wait for Retry-After, then try again.
503
Could not complete. The held charge is returned to your balance. If the outcome is unknown, verify it before you retry.
200 empty
No data. No charge.

Errors