API reference
TikTok Sampled Audience Geography API
Retrieve source-reported country counts. Source percentages can be null. Calculated returned_count_share_percentage uses returned_count_total only; it is not whole-audience reach. Sampling method and collection time are unknown.
Endpoint
GET/v1/tiktok/user-audiencelive · proven30 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
handle | yes | TikTok username without the @ | nasa |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
judgments | no | Add bounded AI labels to eligible returned records (default on). off preserves the original data shape. Unclassified records remain present; labels depend on evidence, time, capacity and the existing request budget. No label surcharge. | on |
label | no | Set none to disable labels; default enables the endpoint’s label set. Equivalent to judgments=off. | none |
label_evidence | no | Include exact supporting sentences and zero-based sentence indexes when a label has validated evidence. No extra charge or change to decisions. | 1 |
exclude | no | Optionally remove confidently labelled engagement bait. Uncertain and unclassified records stay; removed IDs and an owner-bound recall reference are returned. | engagement_bait |
fit | no | Use goal to replace confidently irrelevant records with recall stubs. Keeps first, last, relevant and uncertain records; preserves order. Full evidence is stored for 24 hours when available. | goal |
goal | no | Required with fit=goal: describe the task in at most 600 characters. Supplied text is task context, never permission to act on posts. | Find concrete product complaints |
tokens | no | Optional soft response target for fit=goal, 256–32000. Safety and evidence retention take priority, so the returned result may exceed it. | 4000 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/tiktok/user-audience?handle=nasa" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/tiktok/user-audience?handle=nasa",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/tiktok/user-audience?handle=nasa",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "tiktok",
"endpoint": "/v1/tiktok/user-audience",
"data": {
"platform": "tiktok",
"locations": [
{
"country": "United Kingdom",
"country_code": "GB",
"count": 30,
"percentage": null,
"returned_count_share_percentage": 100
}
],
"returned_count_total": 30,
"sampling": {
"share_basis": "returned_country_counts",
"methodology": null,
"sampled_at": null
}
},
"credits_used": 30,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: reviewed response shaper. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
platform | string | null | tiktok |
locations | array | Nested response fields; optional unless explicitly documented. |
locations[].country | string | null | Country name. |
locations[].country_code | string | null | Source country code. |
locations[].count | number | null | Source-reported country count; unknown sampling method. |
locations[].percentage | number | null | Source percentage only, 0–100; null when absent. Its denominator is not independently verified. |
locations[].returned_count_share_percentage | number | null | Calculated percentage of returned_count_total only; not a whole-audience percentage. |
returned_count_total | number | null | Sum of returned country counts, or null if any count is missing or invalid. |
sampling | object | Nested response fields; optional unless explicitly documented. |
sampling.share_basis | string | null | returned_country_counts |
sampling.methodology | string | null | Unknown when null. |
sampling.sampled_at | string | null | Unknown when null. |
sampling.note | string | null | Sampling limitations. |
_warnings | array | Collection limitations or component warnings. Read before interpreting coverage. |
Source percentages are optional. Calculated shares describe the returned rows only; no demographic or population accuracy is implied.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference