Example
curl 'https://socialtap.dev/v1/linkedin/search_ads?query=hiring' \
-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.linkedin.searchAds.list({ query: "hiring" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);const params = new URLSearchParams({
query: "hiring",
});
const res = await fetch(`https://socialtap.dev/v1/linkedin/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/linkedin/search_ads",
params={"query": "hiring"},
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", "hiring")
req, err := http.NewRequest("GET", "https://socialtap.dev/v1/linkedin/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' => 'hiring',
]);
$ch = curl_init('https://socialtap.dev/v1/linkedin/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/linkedin/search_ads")
uri.query = URI.encode_www_form('query' => 'hiring')
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("hiring");
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://socialtap.dev/v1/linkedin/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("hiring"));
var res = await http.GetAsync("https://socialtap.dev/v1/linkedin/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/linkedin/search_ads")
.query(&[("query", "hiring")])
.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": "https://media.licdn.com/dms/image/v2/D560BAQEIaRrwk0U4rQ/company-logo_100_100/B56ZzvpVifGgAQ-/0/1773547118379?e=1795651200&v=beta&t=vVXt4dCbakReQkbQPJrw_QSQBARm52OsR5i2FLsj7IY",
"display_name": "Islands Business partners",
"id": null,
"is_verified": null,
"url": null,
"username": null
},
"approximate_fields": [
"creatives[].body"
],
"audience_size": null,
"country_codes": [],
"creatives": [
{
"body": "📢 𝐖𝐄’𝐑𝐄 𝐇𝐈𝐑𝐈𝐍𝐆: 𝐏𝐀𝐑𝐓-𝐓𝐈𝐌𝐄 𝐂𝐎𝐌𝐌𝐔𝐍𝐈𝐂𝐀𝐓𝐈𝐎𝐍𝐒 𝐄𝐍𝐀𝐁𝐋𝐄𝐑 The Pacific Feminist Fund (PFF…",
"cta_text": null,
"link_description": null,
"link_url": null,
"media": [
{
"alt_text": null,
"duration_ms": null,
"expires_at": null,
"height": null,
"thumbnail_url": null,
"type": "image",
"url": "https://media.licdn.com/dms/image/v2/D5622AQGoYNnaxFJk9w/feedshare-image-high-res/B56aGedhCvGgAU-/0/1793659900333?e=2147483647&v=beta&t=tIdGsaeRuhSzKZL_4B0AXHa4AlPH0G_pueTxmtkg3zw",
"width": null
}
],
"title": null
}
],
"first_shown_at": null,
"id": "1624871424",
"impressions": null,
"is_active": null,
"is_political": null,
"languages": [],
"last_shown_at": null,
"paid_by": null,
"platform": "linkedin",
"platform_specific": {
"linkedin": {
"company": null,
"creative_type": "SPONSORED_STATUS_UPDATE",
"document": null,
"event": null,
"format": "Single Image Ad",
"impressions_by_country": [],
"is_deleted": false,
"job": null,
"message": null,
"newsletter": null,
"poster": {
"avatar_url": "https://media.licdn.com/dms/image/v2/D560BAQEIaRrwk0U4rQ/company-logo_100_100/B56ZzvpVifGgAQ-/0/1773547118379?e=1795651200&v=beta&t=vVXt4dCbakReQkbQPJrw_QSQBARm52OsR5i2FLsj7IY",
"display_name": "Islands Business partners",
"id": null,
"is_verified": null,
"url": null,
"username": null
},
"poster_title": null,
"targeting": null
}
},
"publisher_platforms": [],
"reach": null,
"spend": null,
"type": "image",
"unknown_fields": [
"country_codes",
"languages",
"platform_specific.linkedin.impressions_by_country"
],
"url": "https://www.linkedin.com/ad-library/detail/1624871424"
},
{
"advertiser": {
"avatar_url": "https://media.licdn.com/dms/image/v2/D4D0BAQEoATmtfABDag/company-logo_100_100/B4DaGIY1kPKEAM-/0/1793289574883/useburhan_logo?e=1795651200&v=beta&t=Ki3wxQ09lYYE4V7ydEMx_SAoxn-u-wbIsLMqxvskQ2M",
"display_name": "Burhan",
"id": null,
"is_verified": null,
"url": null,
"username": null
},
"approximate_fields": [
"creatives[].body"
],
"audience_size": null,
"country_codes": [],
"creatives": [
{
"body": "Is it safe to release? Most teams answer with a feeling. Burhan answers with proof. It walks each journey of your web o…",
"cta_text": null,
"link_description": null,
"link_url": null,
"media": [
{
"alt_text": null,
"duration_ms": null,
"expires_at": null,
"height": null,
"thumbnail_url": "https://media.licdn.com/dms/image/v2/D4E10AQFNh6bkCLYxvA/videocover-high/B4EaGee1l_G8BI-/0/1793660247890?e=2147483647&v=beta&t=IHiqwgf_DYoUES10JT3_-iWDgCZEcymMvTFhz3PpUdA",
"type": "video",
"url": null,
"width": null
}
],
"title": "Release with proof"
}
],
"first_shown_at": null,
"id": "1624744724",
"impressions": null,
"is_active": null,
"is_political": null,
"languages": [],
"last_shown_at": null,
"paid_by": null,
"platform": "linkedin",
"platform_specific": {
"linkedin": {
"company": null,
"creative_type": "SPONSORED_VIDEO",
"document": null,
"event": null,
"format": "Video Ad",
"impressions_by_country": [],
"is_deleted": false,
"job": null,
"message": null,
"newsletter": null,
"poster": {
"avatar_url": "https://media.licdn.com/dms/image/v2/D4D0BAQEoATmtfABDag/company-logo_100_100/B4DaGIY1kPKEAM-/0/1793289574883/useburhan_logo?e=1795651200&v=beta&t=Ki3wxQ09lYYE4V7ydEMx_SAoxn-u-wbIsLMqxvskQ2M",
"display_name": "Burhan",
"id": null,
"is_verified": null,
"url": null,
"username": null
},
"poster_title": null,
"targeting": null
}
},
"publisher_platforms": [],
"reach": null,
"spend": null,
"type": "video",
"unknown_fields": [
"country_codes",
"languages",
"platform_specific.linkedin.impressions_by_country"
],
"url": "https://www.linkedin.com/ad-library/detail/1624744724"
},
{
"advertiser": {
"avatar_url": "https://media.licdn.com/dms/image/v2/D4E03AQEyCndQwhrggQ/profile-displayphoto-scale_100_100/B4EaBOhxICIoAY-/0/1788023870982?e=1795651200&v=beta&t=EEOax4ztSgJPzwXaetBUkgEL1PwhCJtCL8aPWHIbaH8",
"display_name": "Abdulrahman Mohamed",
"id": null,
"is_verified": null,
"url": null,
"username": null
},
"approximate_fields": [
"creatives[].body"
],
"audience_size": null,
"country_codes": [],
"creatives": [
{
"body": "🌍 READY FOR MY NEXT INTERNATIONAL HOSPITALITY CHAPTER Exceptional hospitality is not just about service — it is about …",
"cta_text": null,
"link_description": null,
"link_url": null,
"media": [],
"title": null
}
],
"first_shown_at": null,
"id": "1624659644",
"impressions": null,
"is_active": null,
"is_political": null,
"languages": [],
"last_shown_at": null,
"paid_by": null,
"platform": "linkedin",
"platform_specific": {
"linkedin": {
"company": null,
"creative_type": "SPONSORED_STATUS_UPDATE",
"document": null,
"event": null,
"format": "Single Image Ad",
"impressions_by_country": [],
"is_deleted": false,
"job": null,
"message": null,
"newsletter": null,
"poster": {
"avatar_url": "https://media.licdn.com/dms/image/v2/D4E03AQEyCndQwhrggQ/profile-displayphoto-scale_100_100/B4EaBOhxICIoAY-/0/1788023870982?e=1795651200&v=beta&t=EEOax4ztSgJPzwXaetBUkgEL1PwhCJtCL8aPWHIbaH8",
"display_name": "Abdulrahman Mohamed",
"id": null,
"is_verified": null,
"url": null,
"username": null
},
"poster_title": "Head Waiter | Luxury Hospitality & Fine Dining | VIP Guest Experience | F&B Professional | Open to International Opportunities",
"targeting": null
}
},
"publisher_platforms": [],
"reach": null,
"spend": null,
"type": "image",
"unknown_fields": [
"country_codes",
"languages",
"platform_specific.linkedin.impressions_by_country"
],
"url": "https://www.linkedin.com/ad-library/detail/1624659644"
}
],
"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": "linkedin",
"source": "page",
"is_cached": false,
"credits_charged": 1,
"latency_ms": 1102,
"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.
What to search for, as search_by says: words in the ad (keyword); words in the advertiser's name (advertiser), fuzzy, so other companies with those words come too; a company's numeric ID, or several with commas (advertiser_id), exact; words in the ad's "Paid for by" line (payer).
Examplehiring
search_bystringWhat query names. Default: keyword.
One ofkeywordadvertiseradvertiser_idpayer
Only ads of advertisers with these words in their name, for a keyword or payer search. Fuzzy, like search_by=advertiser: other companies with those words come too. Use this or advertiser_id, not both.
Only this company's ads, for a keyword or payer search: its numeric ID, several with commas, or its link by ID (advertiser.url from the LinkedIn Ad Library Ad API, linkedin.com/company/1035). Exact. The LinkedIn Profile API returns a company's ID from its name.
Example1035
Region: an ISO 3166-1 alpha-2 country code such as US or BR (case-insensitive). Only ads shown in this country. All countries when omitted.
ExampleUS
Only ads shown in any of these countries: ISO 3166-1 alpha-2 codes with commas. Use this or country, not both.
ExampleDE,FR
sortstringOrder of the results. newest: the ads that started most recently first, the library's default. oldest: the earliest first.
One ofnewestoldest
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. Ads count when they ran during the window: an ad that last ran before this day is left out. LinkedIn searches whole days from about a year ago to about two days ago: 364 days back and three days back are always accepted, and past the limit, which moves with the hour, it is refused with the exact date, not answered empty. A window ends yesterday or the day before, so the newest ads are only found without since and until.
Example2026-10-01
Only items before this time (exclusive): RFC 3339 or a date (midnight UTC). Ads count when they ran during the window: an ad that first ran on or after this day is left out. An until past the last day LinkedIn's dates reach, yesterday or the day before, reads as that day. Alone, it starts the window about a year back, as far as LinkedIn's dates reach, so an ad that last ran before then is left out.
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.
Example24
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 24 ad objects, most recently started first; page says how to get the next page; meta describes the request (meta). Fields only LinkedIn Ad Library has are under platform_specific.linkedin.
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
linkedinobjectnullableA LinkedIn Ad Library ad's own fields.
ShowHide 13 child fields
creative_typestringnullableLinkedIn's code for the ad's format (SPONSORED_STATUS_UPDATE, SPONSORED_VIDEO, SPONSORED_INMAILS, JOBS_V2, …), finer than type; null when the library shows none.
formatstringnullableThe ad's format as the library labels it (Single Image Ad, Message Ad, Company Discovery Ad, …); null when not shown.
is_deletedbooleannullableThe library says the ad was deleted; false when it shows no such notice.
posterobjectnullableThe account the ad appears from: the advertiser, or a member whose post it promotes; null when the preview names none.
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.
poster_titlestringnullableThe line under the poster's name (a member's headline); null when none.
impressions_by_countryobject[]Each country's share of the ad's impressions, as the library lists them; [] when not shown (in unknown_fields).
ShowHide 4 child fields
countrystringnullableThe country's name, as the library writes it.
country_codestringnullableISO 3166-1 alpha-2 country code; null when the name is none the library's country list has.
share_percentintegernullableShare of the ad's impressions, a whole percent as the library rounds it; null when under one percent.
is_under_one_percentbooleannullableThe library writes the share as less than one percent.
targetingobjectnullableWhom the advertiser selected; null when not disclosed.
ShowHide 8 child fields
languagesobjectnullableThe profile languages targeted or excluded; null when not shown.
ShowHide 2 child fields
includedstring[]Targeted; [] when none are listed.
excludedstring[]Excluded; [] when none are listed.
locationsobjectnullableThe locations targeted or excluded, in the language of the advertiser's account; null when not shown.
ShowHide 2 child fields
includedstring[]Targeted; [] when none are listed.
excludedstring[]Excluded; [] when none are listed.
audienceobjectnullableAudience criteria; null when not shown.
ShowHide 2 child fields
is_targetedbooleannullableThe advertiser targeted by this criterion.
is_excludedbooleannullableThe advertiser excluded by this criterion.
demographicobjectnullableDemographic criteria; null when not shown.
ShowHide 2 child fields
is_targetedbooleannullableThe advertiser targeted by this criterion.
is_excludedbooleannullableThe advertiser excluded by this criterion.
companyobjectnullableCompany criteria; null when not shown.
ShowHide 2 child fields
is_targetedbooleannullableThe advertiser targeted by this criterion.
is_excludedbooleannullableThe advertiser excluded by this criterion.
educationobjectnullableEducation criteria; null when not shown.
ShowHide 2 child fields
is_targetedbooleannullableThe advertiser targeted by this criterion.
is_excludedbooleannullableThe advertiser excluded by this criterion.
jobobjectnullableJob criteria; null when not shown.
ShowHide 2 child fields
is_targetedbooleannullableThe advertiser targeted by this criterion.
is_excludedbooleannullableThe advertiser excluded by this criterion.
member_interestsobjectnullableMember interests and traits criteria; null when not shown.
ShowHide 2 child fields
is_targetedbooleannullableThe advertiser targeted by this criterion.
is_excludedbooleannullableThe advertiser excluded by this criterion.
messageobjectnullableA message ad's sender and buttons; null on every other format.
ShowHide 3 child fields
sender_namestringnullableThe person the message is sent as; null when not shown.
sender_avatar_urlstring urinullableThe sender's picture; null when not shown.
buttonsstring[]The message's buttons, in order; [] when none.
jobobjectnullableThe job a job ad promotes; null on every other format.
ShowHide 2 child fields
companystringnullableThe company the job is at; null when not shown.
locationstringnullableThe job's location, as written; null when not shown.
eventobjectnullableThe event an event ad promotes; null on every other format.
ShowHide 4 child fields
organizerstringnullableWho hosts the event; null when not shown.
locationstringnullableWhere it happens, as written (Online); null when not shown.
starts_atstring date-timenullableWhen it starts, RFC 3339 UTC; null when not shown.
ends_atstring date-timenullableWhen it ends, RFC 3339 UTC; null when not shown.
documentobjectnullableThe document a document ad shows; null on every other format.
ShowHide 2 child fields
titlestringnullableThe document's title; null when not shown.
page_countintegernullableHow many pages it has; null when not shown.
newsletterstringnullableThe newsletter an article ad's article belongs to; null when none.
companyobjectnullableThe company a company discovery ad presents; null on every other format.
ShowHide 2 child fields
sizestringnullableThe company's size as the card writes it (10,001+ employees); null when not shown.
locationstringnullableWhere the company is, as the card writes it; null when not shown.
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, most recently started first. 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/linkedin/search_ads?query=hiring&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 24 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 |
|---|---|---|
Public page page | 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 |
|---|---|---|
page | Public page | Data embedded in the platform's public web page. |
meta.credits_charged and the x-credits-charged header show what you paid. How credits work · Packs
Endpoint ID linkedin.search_ads · operationId linkedin.search_ads.list · Product overview