curl --request GET \
--url https://api.vidnavigator.com/v1/tiktok/profile/{task_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.vidnavigator.com/v1/tiktok/profile/{task_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.vidnavigator.com/v1/tiktok/profile/{task_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vidnavigator.com/v1/tiktok/profile/{task_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vidnavigator.com/v1/tiktok/profile/{task_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vidnavigator.com/v1/tiktok/profile/{task_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vidnavigator.com/v1/tiktok/profile/{task_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"task_id": "<string>",
"task_status": "processing",
"profile_url": "<string>",
"profile": {},
"filters": {
"max_posts": 123,
"after_datetime": "<string>",
"before_datetime": "<string>",
"min_likes": 123,
"max_likes": 123
},
"stats": {
"videos_scanned": 123,
"videos_matched": 123,
"pages_consumed": 123
},
"videos": [
{
"id": "<string>",
"track": "<string>",
"artists": [
"<string>"
],
"duration": 123,
"title": "<string>",
"description": "<string>",
"timestamp": 123,
"published_at": "2023-11-07T05:31:56Z",
"views": 123,
"likes": 123,
"reposts": 123,
"comments": 123,
"thumbnails": [
{}
],
"url": "<string>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total_items": 123,
"has_next": true,
"has_prev": true,
"next_cursor": "<string>",
"prev_cursor": "<string>"
},
"download_url": "https://storage.googleapis.com/bucket/api/tiktok_profiles/user/task.json?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Signature=...",
"error_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
}
}{
"status": "error",
"error": "invalid_cursor",
"message": "<string>"
}{
"status": "error",
"error": "task_not_found",
"message": "<string>"
}{
"status": "error",
"error": "internal_server_error",
"message": "<string>"
}Get TikTok Profile Scrape Result
Poll an async TikTok profile scrape task and retrieve a cursor-paginated page of videos.
Cursor pagination: The cursor encodes an absolute offset, so it is safe to change limit between calls without skipping or duplicating videos. Pass the next_cursor returned from a previous response as cursor in the next request. Omit cursor to start from the beginning.
TTL: Tasks (and their download_url availability) expire ~1 hour after creation. Poll while task_status is processing, and switch to download_url for very large profiles.
This endpoint does not consume credits — polling is free.
Usage disclosure: Set include_usage=true to receive a usage block describing the charges the background worker recorded for this task. Returned only when task_status=completed (processing tasks haven’t finished billing; failed tasks have all charges refunded). Charges are standard_request units, one per TikTok page consumed.
curl --request GET \
--url https://api.vidnavigator.com/v1/tiktok/profile/{task_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.vidnavigator.com/v1/tiktok/profile/{task_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.vidnavigator.com/v1/tiktok/profile/{task_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vidnavigator.com/v1/tiktok/profile/{task_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vidnavigator.com/v1/tiktok/profile/{task_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vidnavigator.com/v1/tiktok/profile/{task_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vidnavigator.com/v1/tiktok/profile/{task_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"task_id": "<string>",
"task_status": "processing",
"profile_url": "<string>",
"profile": {},
"filters": {
"max_posts": 123,
"after_datetime": "<string>",
"before_datetime": "<string>",
"min_likes": 123,
"max_likes": 123
},
"stats": {
"videos_scanned": 123,
"videos_matched": 123,
"pages_consumed": 123
},
"videos": [
{
"id": "<string>",
"track": "<string>",
"artists": [
"<string>"
],
"duration": 123,
"title": "<string>",
"description": "<string>",
"timestamp": 123,
"published_at": "2023-11-07T05:31:56Z",
"views": 123,
"likes": 123,
"reposts": 123,
"comments": 123,
"thumbnails": [
{}
],
"url": "<string>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total_items": 123,
"has_next": true,
"has_prev": true,
"next_cursor": "<string>",
"prev_cursor": "<string>"
},
"download_url": "https://storage.googleapis.com/bucket/api/tiktok_profiles/user/task.json?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Signature=...",
"error_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
}
}{
"status": "error",
"error": "invalid_cursor",
"message": "<string>"
}{
"status": "error",
"error": "task_not_found",
"message": "<string>"
}{
"status": "error",
"error": "internal_server_error",
"message": "<string>"
}Overview
This endpoint is the second half of the TikTok profile scraping workflow. Use it after you submit a scrape withPOST /tiktok/profile.
It serves three purposes:
- check whether the task is still running
- retrieve the filtered video results page by page
- get a temporary
download_urlfor the full JSON result when available
Request Parameters
| Parameter | In | Required | Description |
|---|---|---|---|
task_id | path | Yes | Task ID returned by POST /tiktok/profile |
cursor | query | No | Opaque pagination cursor from a previous response |
limit | query | No | Maximum number of videos to return, between 1 and 500. Default is 50. |
How Pagination Works
Pagination is cursor-based, but the cursor encodes an absolute offset. That means you can safely changelimit between requests without skipping or duplicating videos.
Typical flow:
- Call the endpoint with no
cursor. - Read
data.pagination.next_cursor. - Pass that value back as the next request’s
cursor. - Stop when
has_nextisfalse.
Polling Lifecycle
Thetask_status field will be one of:
processing: the scrape is still runningcompleted: the scrape finished and results are readyfailed: the scrape ended with an error
profilemay benullvideoswill be emptydownload_urlwill usually benull
videoscontains a cursor-paginated page of matching postspaginationtells you whether more pages existdownload_urlmay contain a temporary signed URL for the full JSON result
Example Requests
curl "https://api.vidnavigator.com/v1/tiktok/profile/tt_profile_abc123?limit=25" \
-H "X-API-Key: YOUR_API_KEY"
import requests
response = requests.get(
"https://api.vidnavigator.com/v1/tiktok/profile/tt_profile_abc123",
headers={"X-API-Key": "YOUR_API_KEY"},
params={"limit": 25},
)
print(response.json())
const response = await fetch(
'https://api.vidnavigator.com/v1/tiktok/profile/tt_profile_abc123?limit=25',
{
headers: {
'X-API-Key': 'YOUR_API_KEY'
}
}
);
const result = await response.json();
Fetch the Next Page
curl "https://api.vidnavigator.com/v1/tiktok/profile/tt_profile_abc123?limit=25&cursor=eyJvZmZzZXQiOjI1fQ==" \
-H "X-API-Key: YOUR_API_KEY"
Example Completed Response
{
"status": "success",
"data": {
"task_id": "tt_profile_abc123",
"task_status": "completed",
"profile_url": "https://www.tiktok.com/@tiktok",
"profile": {
"uploader": "tiktok",
"follower_count": 12345678
},
"filters": {
"max_posts": 50,
"after_datetime": "2024-01-01T00:00:00Z",
"before_datetime": null,
"min_likes": 10000,
"max_likes": null
},
"stats": {
"videos_scanned": 120,
"videos_matched": 50,
"pages_consumed": 8
},
"videos": [
{
"id": "7351234567890123456",
"track": "Original sound",
"artists": ["Creator Name"],
"duration": 28,
"title": "Example TikTok",
"description": "Video caption text here",
"timestamp": 1712345678,
"published_at": "2024-04-05T19:34:38Z",
"views": 250000,
"likes": 22000,
"reposts": 180,
"comments": 950,
"thumbnails": [],
"url": "https://www.tiktok.com/@tiktok/video/7351234567890123456"
}
],
"pagination": {
"limit": 25,
"offset": 0,
"total_items": 50,
"has_next": true,
"has_prev": false,
"next_cursor": "eyJvZmZzZXQiOjI1fQ==",
"prev_cursor": null
},
"download_url": "https://storage.googleapis.com/bucket/api/tiktok_profiles/user/task.json?...",
"error_message": null,
"created_at": "2026-04-25T20:00:00Z",
"completed_at": "2026-04-25T20:01:12Z",
"expires_at": "2026-04-25T21:00:00Z"
}
}
Understanding the Response
profile
Contains profile-level metadata returned by the scraper, such as uploader information and follower counts when available.
stats
Helps you understand what happened during the scrape:
videos_scanned: total TikTok entries iterated before filteringvideos_matched: entries that passed your filterspages_consumed: estimated number of TikTok API pages fetched during the scrape
videos
This is the current page of matched TikTok videos. Each item includes public metadata such as:
idtitledescriptiontimestamp: Unix timestamp in seconds when the video was uploadedpublished_at: UTC datetime string derived fromtimestamp, in ISO 8601 format with timezoneviewslikescommentsurl
download_url
When present, this is a short-lived signed URL pointing to the full scrape result as one JSON file. It is useful for large profiles, browser downloads, and no-code integrations.
If it is null, either:
- the task has not finished yet, or
- signed URL generation is not configured and you should paginate through
videosinstead
Error Cases
400 invalid_cursor: the suppliedcursoris invalid404 task_not_found: task does not exist, expired, or does not belong to the current user
Tips
- poll every few seconds while
task_statusisprocessing - switch to
download_urlfor large completed jobs - do not assume tasks live forever; they expire after about 1 hour
- call the endpoint again later if you need a freshly minted
download_url - use the
expires_atvalue to avoid polling a task after it has already expired
Authorizations
API key authentication. Include your VidNavigator API key in the X-API-Key header.
Path Parameters
ID returned by POST /tiktok/profile.
Query Parameters
Opaque pagination cursor returned as next_cursor from the previous response. Omit to fetch the first page.
Maximum number of videos to include in the response.
1 <= x <= 500When true and task_status=completed, attach a usage block describing the charges the background worker recorded (standard_request × pages_consumed).

