Example
curl 'https://socialtap.dev/v1/tiktok/search_ads?query=coffee' \
-H "x-api-key: $SOCIALTAP_API_KEY"import { SocialTap } from "socialtap";
const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY
const res = await client.tiktok.searchAds.list({ query: "coffee" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);const params = new URLSearchParams({
query: "coffee",
});
const res = await fetch(`https://socialtap.dev/v1/tiktok/search_ads?${params}`, {
headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, page, meta } = body;
console.log(data, meta.credits_charged);import os
import requests
res = requests.get(
"https://socialtap.dev/v1/tiktok/search_ads",
params={"query": "coffee"},
headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, page, meta = body["data"], body["page"], body["meta"]
print(data, meta["credits_charged"])package main
import (
"encoding/json"
"fmt"
"log"
"net/http"
"net/url"
"os"
)
func main() {
q := url.Values{}
q.Set("query", "coffee")
req, err := http.NewRequest("GET", "https://socialtap.dev/v1/tiktok/search_ads?"+q.Encode(), nil)
if err != nil {
log.Fatal(err)
}
req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
log.Fatal(err)
}
defer res.Body.Close()
var body struct {
Data json.RawMessage `json:"data"`
Page json.RawMessage `json:"page"`
Meta map[string]any `json:"meta"`
Error *struct {
Code string `json:"code"`
Message string `json:"message"`
} `json:"error"`
}
if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
log.Fatal(err)
}
if body.Error != nil {
log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
}
fmt.Println(string(body.Data), body.Meta["credits_charged"])
}<?php
$query = http_build_query([
'query' => 'coffee',
]);
$ch = curl_init('https://socialtap.dev/v1/tiktok/search_ads?' . $query);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;require "json"
require "net/http"
uri = URI("https://socialtap.dev/v1/tiktok/search_ads")
uri.query = URI.encode_www_form('query' => 'coffee')
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
public class Main {
public static void main(String[] args) throws Exception {
String query = "query=" + encode("coffee");
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://socialtap.dev/v1/tiktok/search_ads?" + query))
.header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
// An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
if (response.statusCode() >= 400) throw new RuntimeException(response.body());
System.out.println(response.body());
}
static String encode(String value) {
return URLEncoder.encode(value, StandardCharsets.UTF_8);
}
}using System.Text.Json;
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));
var query = string.Join("&",
"query=" + Uri.EscapeDataString("coffee"));
var res = await http.GetAsync("https://socialtap.dev/v1/tiktok/search_ads?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
var error = body.RootElement.GetProperty("error");
throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let res = reqwest::blocking::Client::new()
.get("https://socialtap.dev/v1/tiktok/search_ads")
.query(&[("query", "coffee")])
.header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
.send()?;
let ok = res.status().is_success();
let body: serde_json::Value = res.json()?;
if !ok {
return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
}
println!("{} {}", body["data"], body["meta"]["credits_charged"]);
Ok(())
}{
"data": [
{
"advertiser": {
"avatar_url": null,
"display_name": "raisedinluxury",
"id": null,
"is_verified": null,
"url": null,
"username": null
},
"approximate_fields": [
"first_shown_at",
"last_shown_at",
"reach"
],
"audience_size": null,
"country_codes": [],
"creatives": [
{
"body": "Mushroom coffee #coffee",
"cta_text": null,
"link_description": null,
"link_url": null,
"media": [
{
"alt_text": null,
"duration_ms": null,
"expires_at": null,
"height": null,
"thumbnail_url": "https://p16-common-sign.tiktokcdn.com/tos-alisg-p-37c799-sg/o8UknFBVVDq0iQCOhAzGAS2tQfwxmfEEd3QRkE~tplv-noop.image?dr=18692&refresh_token=d75541c5&x-expires=4070908800&x-signature=SCRUBBED&t=9276707c&ps=14f1eb3e&shp=9e36835a&shcp=0c75dd76&idc=sg1&VideoID=v15025gf0000da547cfog65jp…",
"type": "video",
"url": "https://library.tiktok.com/api/v1/cdn/1793574003/video/aHR0cHM6Ly92NzcudGlrdG9rY2RuLmNvbS8yNzFmNGQ5MDI5ZjE0Y2M0M2IxYTU4MWNlNGZjN2EyZi82YWU4MThlNy92aWRlby90b3MvYWxpc2cvdG9zLWFsaXNnLXZlLTM3Yzc5OS1zZy9vWUlyUktBMVJSS1FIaVdvelNxQjlBUUJxNGlmQVl6VUlFRURpUy8=/e4ffaaa5-2a8f-4350-8715-b93e…",
"width": null
}
],
"title": null
}
],
"first_shown_at": "2026-08-23T00:00:00Z",
"id": "1874320211952658",
"impressions": null,
"is_active": null,
"is_political": null,
"languages": [],
"last_shown_at": "2026-08-23T00:00:00Z",
"paid_by": null,
"platform": "tiktok",
"platform_specific": {
"tiktok": {
"advertiser_business_id": null,
"advertiser_registry_location": null,
"budget": null,
"category": null,
"ctr_top_percent": null,
"is_removed": false,
"like_count": null,
"objective": null,
"rank": null,
"removal_country_codes": [],
"removal_reasons": [],
"targeting": null
}
},
"publisher_platforms": [
"tiktok"
],
"reach": {
"lower_bound": 0,
"upper_bound": 1000
},
"spend": null,
"type": "video",
"unknown_fields": [
"country_codes"
],
"url": "https://library.tiktok.com/ads/detail/?ad_id=1874320211952658"
},
{
"advertiser": {
"avatar_url": null,
"display_name": "Manea Coffee",
"id": null,
"is_verified": null,
"url": null,
"username": null
},
"approximate_fields": [
"first_shown_at",
"last_shown_at",
"reach"
],
"audience_size": null,
"country_codes": [],
"creatives": [
{
"body": "Caja de muestras | Manea Coffee",
"cta_text": null,
"link_description": null,
"link_url": null,
"media": [
{
"alt_text": null,
"duration_ms": null,
"expires_at": null,
"height": null,
"thumbnail_url": "https://p16-common-sign.tiktokcdn.com/tos-alisg-p-0051c001-sg/o0QMomDeZefhMFgshsbGeqxAQBA4NRQIDA8W2C~tplv-tiktokx-origin.jpeg?dr=14582&refresh_token=3d9c5080&x-expires=4070908800&x-signature=SCRUBBED&t=4d5b0474&ps=13740610&shp=0c75dd76&shcp=9b759fb9&idc=sg1",
"type": "video",
"url": "https://library.tiktok.com/api/v1/cdn/1793574003/video/aHR0cHM6Ly92NzcudGlrdG9rY2RuLmNvbS84NjM5ZjgxN2VlZTkzMzk2N2U2YjgzNjY3YzE3ZGNlNy82YWU4MThmNi92aWRlby90b3MvdXNlYXN0MmEvdG9zLXVzZWFzdDJhLXZlLTAwNTFjNzk5LWV1dHRwL293VEF3Q0VRZDRERWJGQUl0V0xWRnNtRGZ2Z1FnVUVHaGZJZkI3Lw==/2683c39b-6f1…",
"width": null
}
],
"title": null
}
],
"first_shown_at": "2026-06-08T00:00:00Z",
"id": "1867421334452290",
"impressions": null,
"is_active": null,
"is_political": null,
"languages": [],
"last_shown_at": "2026-06-19T00:00:00Z",
"paid_by": null,
"platform": "tiktok",
"platform_specific": {
"tiktok": {
"advertiser_business_id": null,
"advertiser_registry_location": null,
"budget": null,
"category": null,
"ctr_top_percent": null,
"is_removed": false,
"like_count": null,
"objective": null,
"rank": null,
"removal_country_codes": [],
"removal_reasons": [],
"targeting": null
}
},
"publisher_platforms": [
"tiktok"
],
"reach": {
"lower_bound": 1000,
"upper_bound": 10000
},
"spend": null,
"type": "video",
"unknown_fields": [
"country_codes"
],
"url": "https://library.tiktok.com/ads/detail/?ad_id=1867421334452290"
},
{
"advertiser": {
"avatar_url": null,
"display_name": "Manea Coffee",
"id": null,
"is_verified": null,
"url": null,
"username": null
},
"approximate_fields": [
"first_shown_at",
"last_shown_at",
"reach"
],
"audience_size": null,
"country_codes": [],
"creatives": [
{
"body": "Caja de muestras | Manea Coffee",
"cta_text": null,
"link_description": null,
"link_url": null,
"media": [],
"title": null
}
],
"first_shown_at": "2026-06-08T00:00:00Z",
"id": "1867423264630914",
"impressions": null,
"is_active": null,
"is_political": null,
"languages": [],
"last_shown_at": "2026-06-09T00:00:00Z",
"paid_by": null,
"platform": "tiktok",
"platform_specific": {
"tiktok": {
"advertiser_business_id": null,
"advertiser_registry_location": null,
"budget": null,
"category": null,
"ctr_top_percent": null,
"is_removed": false,
"like_count": null,
"objective": null,
"rank": null,
"removal_country_codes": [],
"removal_reasons": [],
"targeting": null
}
},
"publisher_platforms": [
"tiktok"
],
"reach": {
"lower_bound": 0,
"upper_bound": 1000
},
"spend": null,
"type": "image",
"unknown_fields": [
"country_codes"
],
"url": "https://library.tiktok.com/ads/detail/?ad_id=1867423264630914"
}
],
"page": {
"has_more": true,
"next_cursor": "c1.EXAMPLE_CURSOR",
"next_cursor_expires_at": "2026-10-26T12:00:00Z",
"end_reason": null
},
"meta": {
"request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
"platform": "tiktok",
"source": "api",
"is_cached": false,
"credits_charged": 1,
"latency_ms": 2510,
"fetched_at": "2026-10-25T12:00:00Z",
"input": null,
"credits_remaining": 9999,
"client_request_id": null,
"warnings": []
}
}Long arrays and strings are shortened for display; real responses are complete.
Keywords, a "quoted phrase", or (search_by=advertiser) an advertiser's name.
Examplecoffee
search_bystringadvertiser: the advertiser named exactly as query, else TikTok's first suggestion.
One ofkeywordadvertiser
advertiser_idstringAn advertiser's business ID (platform_specific.tiktok.advertiser_business_id), with query its name.
Example7413374016335134736
Region: an ISO 3166-1 alpha-2 country code such as US or BR (case-insensitive).
ExampleUS
statusstringOnly items that are still running (active), only items that stopped (inactive), or both (all).
One ofactiveinactiveall
Exampleactive
sortstringOrder of the results. Keywords rank by relevance first.
One ofrelevancenewestoldestpopular
Only items at or after this time: RFC 3339 (2026-10-01T12:00:00Z) or a date (2026-10-01, midnight UTC). On newest-first lists, paging stops when it is reached, so later pages are not fetched or charged.
Example2026-10-01
Only items before this time (exclusive): RFC 3339 or a date (midnight UTC).
Example2026-10-08
Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for.
Example12
cursorstringpage.next_cursor from the previous response. Send the same other parameters; omit to start from the first page.
Unknown parameters are rejected with a suggestion, never ignored (Requests). limit and cursor page through the list: see Pagination.
Parameters every endpoint accepts
Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent.
fieldsstringReturn only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole.
Response
200
{data, page, meta}. data is an array of up to 12 ad objects, relevance (keywords) or newest; page says how to get the next page; meta describes the request (meta). Fields only TikTok Ad Library has are under platform_specific.tiktok.
platformstringLibrary owner's platform ID (facebook for Meta's library, tiktok, google, linkedin).
idstringLibrary ad ID (string).
urlstring uriPublic library page of the ad.
advertiserobjectThe advertising page, business or account.
ShowHide 6 child fields
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
paid_bystringnullableDisclosed payer ("Paid for by").
is_activebooleannullableTrue while the ad is running.
first_shown_atstring date-timenullableFirst delivery, RFC 3339 UTC (often date-only: see approximate_fields).
last_shown_atstring date-timenullableLast delivery, RFC 3339 UTC; null while active.
typestringCreative shape. New values may be added; treat unknown values as other.
One ofimagevideocarouseltextdynamicother
publisher_platformsstring[]Where it ran, lowercase IDs (facebook, instagram, messenger, audience_network, youtube, …); [] if not disclosed.
creativesobject[]The ad's creatives: one per card of a carousel and per variation of a dynamic or catalog ad, else one for the ad itself; [] if none are shown.
ShowHide 6 child fields
titlestringnullableHeadline.
bodystringnullablePrimary text.
link_urlstring urinullableDestination URL.
link_descriptionstringnullableLink description text.
cta_textstringnullableCall-to-action label (e.g. Shop now).
mediaobject[]Images and videos of this creative; [] if none.
ShowHide 8 child fields
typestringKind of file. New values may be added; treat unknown values as other.
One ofimagevideoaudiogif
urlstring urinullableDirect file URL; null when the platform withholds it, or when the link would only work from SocialTap's network or with a login. Often signed and expiring: see expires_at.
expires_atstring date-timenullableWhen url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire.
thumbnail_urlstring urinullablePoster or preview image URL.
widthintegernullableWidth in pixels.
heightintegernullableHeight in pixels.
duration_msintegernullableDuration in milliseconds (video and audio only).
alt_textstringnullableAccessibility text provided by the author or platform.
languagesstring[]BCP-47 languages of the ad; [] if not disclosed.
country_codesstring[]ISO 3166-1 alpha-2 countries where it was shown; [] if not disclosed.
is_politicalbooleannullableCategorized as a political or social-issue ad; false when the library files it under another category, null when it shows none.
impressionsobjectnullableImpressions or times shown range; null when not disclosed.
ShowHide 2 child fields
lower_boundintegerInclusive lower bound.
upper_boundintegernullableInclusive upper bound; null when open-ended (e.g. ">1M"). Equal to lower_bound when exact.
reachobjectnullableUnique users reached range; null when not disclosed.
ShowHide 2 child fields
lower_boundintegerInclusive lower bound.
upper_boundintegernullableInclusive upper bound; null when open-ended (e.g. ">1M"). Equal to lower_bound when exact.
audience_sizeobjectnullableEstimated target audience size range; null when not disclosed.
ShowHide 2 child fields
lower_boundintegerInclusive lower bound.
upper_boundintegernullableInclusive upper bound; null when open-ended (e.g. ">1M"). Equal to lower_bound when exact.
spendobjectnullableSpend range; null when not disclosed.
ShowHide 3 child fields
lower_boundintegerInclusive lower bound, in whole units of currency.
upper_boundintegernullableInclusive upper bound in whole units of currency; null when open-ended.
currencystringISO 4217 currency code, uppercase (USD).
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
ShowHide 1 child field
tiktokobjectnullableA TikTok ad's own fields.
ShowHide 12 child fields
is_removedbooleannullableTikTok took the ad down (its rules or local law), in some or all regions.
removal_reasonsstring[]TikTok's reasons for the takedown; [] when none (in unknown_fields when not shown).
categorystringnullableThe ad's topic as TikTok files it (Apps, Food & Beverage).
objectivestringnullableThe campaign objective (Reach, Traffic).
removal_country_codesstring[]Countries where TikTok took the ad down (ISO 3166-1 alpha-2); [] when it was not taken down (in unknown_fields when not shown).
targetingobjectnullableWhom the advertiser targeted and whom the ad reached, per country; null when not shown.
ShowHide 11 child fields
countriesobject[]Per country it ran in: the ages and genders targeted and the unique users reached.
ShowHide 5 child fields
country_codestringISO 3166-1 alpha-2 country code.
reachobjectnullableUnique users the ad reached there (rounded: approximate_fields); null when not shown.
ShowHide 2 child fields
lower_boundintegerInclusive lower bound.
upper_boundintegernullableInclusive upper bound; null when open-ended (e.g. ">1M"). Equal to lower_bound when exact.
age_rangesstring[]Age ranges targeted (13-17, 18-24, 25-34, 35-44, 45-54, 55+); [] when not shown.
gendersstring[]Genders targeted (female, male, unknown); [] when not shown.
breakdownobject[]Unique users reached there by age range and gender, the segments TikTok shows a number for; [] when none.
ShowHide 3 child fields
age_rangestringAge range (18-24, 55+).
genderstringfemale, male or unknown.
reachobjectUnique users reached (rounded: approximate_fields).
ShowHide 2 child fields
lower_boundintegerInclusive lower bound.
upper_boundintegernullableInclusive upper bound; null when open-ended (e.g. ">1M"). Equal to lower_bound when exact.
interestsstring[]Interest categories targeted; [] when none.
video_interactionsstring[]Video interaction categories targeted; [] when none.
creator_interactionsstring[]Creator interaction categories targeted; [] when none.
provincesstring[]Provinces or states targeted within the countries; [] when none.
citiesstring[]Cities targeted; [] when none.
device_modelsstring[]Device models targeted; [] when any.
operating_systemsstring[]Operating systems targeted; [] when any.
is_custom_audiencebooleannullableThe advertiser targeted a custom audience (its own customer list or a lookalike).
is_audience_excludedbooleannullableThe advertiser excluded a custom audience.
is_high_spending_powerbooleannullableTargeted at users TikTok rates as high spenders.
advertiser_business_idstringnullableThe advertiser's TikTok business ID (search_ads advertiser_id).
advertiser_registry_locationstringnullableWhere the advertiser is registered (Italy).
rankintegernullablePlace on Creative Center's Top Ads board, 1 first; null off the board.
like_countintegernullableLikes the ad drew, as Creative Center counts them; null off the board.
ctr_top_percentnumbernullableClick-through rate rank: the ad is in the top this many percent of ads (4 = top 4%); null off the board.
budgetstringnullableCreative Center's budget level; null off the board. New values may be added; treat unknown values as other.
One oflowmediumhigh
approximate_fieldsstring[]JSON paths of values that are rounded, date-only or parsed from display text. A list path (external_links) means the list may be incomplete. [] when all exact.
unknown_fieldsstring[]JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.
not_found is item-level: the request was fine, the item can't be returned.
400
400 Bad Request: 2 error codes. Free: errors cost nothing.
invalid_inputNo retryA parameter is missing or malformed, or the link is not one this endpoint takes.
Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.
invalid_cursorNo retryThe cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it.
Repeat the original request without cursor to start the list again.
401
401 Unauthorized: 1 error code. Free: errors cost nothing.
unauthorizedNo retryThe x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.
Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.
402
402 Payment Required: 2 error codes. Free: errors cost nothing.
insufficient_creditsNo retryThe account does not have enough credits for this request.
Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically.
spend_limit_reachedNo retryThe API key reached its spend limit for this period. The account may still have credits.
Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically.
403
403 Forbidden: 1 error code. Free: errors cost nothing.
forbiddenNo retryThe API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.
Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.
404
404 Not Found: 1 error code. Free: errors cost nothing.
not_foundNo retryThe item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).
Check the link or ID. Do not retry.
429
429 Too Many Requests: 1 error code. Free: errors cost nothing.
rate_limitedYes, laterThe account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.
Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.
500
500 Internal Error: 1 error code. Free: errors cost nothing.
internalYes, laterAn unexpected error on SocialTap's side.
Retry with backoff. If it keeps happening, contact support with the request_id.
502
502 Bad Gateway: 1 error code. Free: errors cost nothing.
upstream_errorYes, laterThe platform failed, or answered with something we could not read.
Retry with backoff. Failed requests are free.
503
503 Unavailable: 2 error codes. Free: errors cost nothing.
upstream_blockedYes, laterThe platform refused every attempt, our own retries included.
Retry later with backoff. Failed requests are free.
overloadedYes, laterSocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged.
Retry after the seconds in the retry-after header. Failed requests are free.
Items come in pages, relevance (keywords) or newest. To get the next page, send the same request plus cursor set to page.next_cursor from the previous response. Keep every other parameter the same (limit, max_age and fields may change); anything else that differs is rejected. When page.has_more is false the walk is over, and page.end_reason says why: only end means you have every item (the others say the platform or a page cap stopped the walk early).
The page object
has_morebooleanTrue when another page exists; then next_cursor is set. An empty page with has_more true is not the end.
next_cursorstringnullablePass as cursor, with the same other parameters, to get the next page; null at the end.
next_cursor_expires_atstring date-timenullableWhen next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.
end_reasonstringnullableWhy there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.
One ofendplatform_limitmax_pages
Next page
curl 'https://socialtap.dev/v1/tiktok/search_ads?query=coffee&cursor=c1.EXAMPLE_CURSOR' \
-H "x-api-key: $SOCIALTAP_API_KEY"- The price is per page: each successful page costs the same, whatever
limitis and however many items it has. Empty pages are charged too (an empty page withhas_more: trueis not the end). - A
limitbelow 12 doesn't save credits: the next request serves the rest of the same platform page, which is fetched again and charged as a page each time, and items can shift between those requests if the platform changes the list. Omittinglimitis the cheapest way to walk the list. - Errors are free, including a rejected cursor.
- Pages served from the cache are free.
- An expired or altered cursor, or one sent with different parameters, fails with
invalid_cursor(HTTP 400): Repeat the original request without cursor to start the list again.
From 1 credit per page. Charged per successful page, whatever its number of items. Errors are free. The price depends on the source that produced the result, reported as meta.source.
| Source | Price per successful page | Per 1,000 pages |
|---|---|---|
Platform API api | 1 credit | $0.75–$1.97 |
Balance, sources and what you were charged
Your balance must be at least 1 credit to start a request; with less, it is refused with insufficient_credits (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.
| meta.source | Source | What it means |
|---|---|---|
api | Platform API | The platform's public, logged-out API. |
meta.credits_charged and the x-credits-charged header show what you paid. How credits work · Packs
Endpoint ID tiktok.search_ads · operationId tiktok.search_ads.list · Product overview