Example
curl -G 'https://socialtap.dev/v1/linkedin/engagement' \
--data-urlencode 'handle=https://www.linkedin.com/company/microsoft/' \
-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.engagement.get({ handle: "https://www.linkedin.com/company/microsoft/" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);const params = new URLSearchParams({
handle: "https://www.linkedin.com/company/microsoft/",
});
const res = await fetch(`https://socialtap.dev/v1/linkedin/engagement?${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, meta } = body;
console.log(data, meta.credits_charged);import os
import requests
res = requests.get(
"https://socialtap.dev/v1/linkedin/engagement",
params={"handle": "https://www.linkedin.com/company/microsoft/"},
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, meta = body["data"], 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("handle", "https://www.linkedin.com/company/microsoft/")
req, err := http.NewRequest("GET", "https://socialtap.dev/v1/linkedin/engagement?"+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"`
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([
'handle' => 'https://www.linkedin.com/company/microsoft/',
]);
$ch = curl_init('https://socialtap.dev/v1/linkedin/engagement?' . $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/engagement")
uri.query = URI.encode_www_form('handle' => 'https://www.linkedin.com/company/microsoft/')
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 = "handle=" + encode("https://www.linkedin.com/company/microsoft/");
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://socialtap.dev/v1/linkedin/engagement?" + 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("&",
"handle=" + Uri.EscapeDataString("https://www.linkedin.com/company/microsoft/"));
var res = await http.GetAsync("https://socialtap.dev/v1/linkedin/engagement?" + 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/engagement")
.query(&[("handle", "https://www.linkedin.com/company/microsoft/")])
.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": {
"approximate_fields": [],
"bottom_post_id": "7523924879897772032",
"id": "1035",
"metrics": {
"comment_to_like_ratio": 0.108813,
"comments_per_post": 40.33,
"counted_post_count": 3,
"engagement_rate": 0.000014,
"engagement_rate_stddev": 0.000006,
"formats": [
{
"counted_post_count": 1,
"engagement_rate": 0.000023,
"interactions_per_post": 665,
"type": "image",
"views_per_post": null
},
{
"counted_post_count": 1,
"engagement_rate": 0.000011,
"interactions_per_post": 315,
"type": "text",
"views_per_post": null
},
{
"counted_post_count": 1,
"engagement_rate": 0.000009,
"interactions_per_post": 253,
"type": "video",
"views_per_post": null
}
],
"interactions_per_post": 411,
"likes_per_post": 370.67,
"median_engagement_rate": 0.000011,
"median_views_per_post": null,
"posts_per_week": 1.63,
"quotes_per_post": null,
"rated_post_count": 3,
"reposts_per_post": null,
"sampled_post_count": 10,
"saves_per_post": null,
"shares_per_post": null,
"view_engagement_rate": null,
"views_per_post": null
},
"newest_post_at": "2026-11-13T15:41:26Z",
"oldest_post_at": "2026-11-05T01:51:19Z",
"platform": "linkedin",
"platform_specific": {},
"posts": [
{
"engagement_rate": 0.000011,
"engagement_vs_median": 1,
"is_counted": true,
"post": {
"approximate_fields": [],
"author": {
"avatar_url": "https://media.licdn.com/dms/image/v2/D560BAQH32RJQCl3dDQ/company-logo_100_100/B56ZYQ0mrGGoAU-/0/1744038948046/microsoft_logo?e=2147483647&v=beta&t=rr_7_bFRKp6umQxIHErPOZHtR8dMPIYeTjlKFdotJBY",
"display_name": "Microsoft",
"id": null,
"is_verified": null,
"url": "https://www.linkedin.com/company/microsoft",
"username": "microsoft"
},
"coauthors": [],
"duration_ms": null,
"hashtags": [],
"id": "7527032890480656384",
"is_nsfw": null,
"is_pinned": null,
"is_sponsored": null,
"language": null,
"link_url": null,
"media": [],
"mentions": [],
"metrics": {
"comment_count": 24,
"like_count": 291,
"quote_count": null,
"repost_count": null,
"save_count": null,
"share_count": null,
"view_count": null
},
"platform": "linkedin",
"platform_specific": {
"linkedin": {
"author_follower_count": 29509552,
"author_headline": null,
"content_urn": "urn:li:share:7527032889637539841",
"document": null,
"hidden_image_count": null,
"is_author_influencer": false,
"is_edited": false,
"link": null,
"modified_at": null,
"more_articles": [],
"reaction": null,
"repost_activity_id": null,
"reshared_post": null,
"top_comments": []
}
},
"platform_type": "post",
"published_at": "2026-11-13T15:41:26Z",
"text": "We’re seeing encouraging recovery progress, with service availability and email delivery performance improving across a growing portion of affected infrastructure. We know our customers rely on our services to get important work done every day, and regret the impact these outages…",
"thumbnail_url": null,
"title": null,
"type": "text",
"unknown_fields": [
"platform_specific.linkedin.top_comments"
],
"url": "https://www.linkedin.com/feed/update/urn:li:activity:7527032890480656384"
},
"view_engagement_rate": null,
"views_vs_median": null
},
{
"engagement_rate": 0.00002,
"engagement_vs_median": 1.91,
"is_counted": false,
"post": {
"approximate_fields": [],
"author": {
"avatar_url": "https://media.licdn.com/dms/image/v2/C5603AQGnYfaUI8S0zQ/profile-displayphoto-shrink_400_400/profile-displayphoto-shrink_400_400/0/1516342848914?e=2147483647&v=beta&t=DxjyeHtTGI0kYUGuFk6NQZ_rZcz6OSwLhr-g9AmpOcg",
"display_name": "Brad Smith",
"id": null,
"is_verified": null,
"url": "https://www.linkedin.com/in/bradsmi",
"username": "bradsmi"
},
"coauthors": [],
"duration_ms": null,
"hashtags": [],
"id": "7525983004125478913",
"is_nsfw": null,
"is_pinned": null,
"is_sponsored": null,
"language": null,
"link_url": null,
"media": [
{
"alt_text": "A large group of Microsoft Community-First Grant recipients and event participants pose for a photo alongside Seattle Mariners representatives and the Mariner Moose mascot. Several people in the front row hold framed certificates, while colorful balloons and additional mascots ap…",
"duration_ms": null,
"expires_at": null,
"height": null,
"thumbnail_url": null,
"type": "image",
"url": "https://media.licdn.com/dms/image/v2/D4E22AQHiLQZfV3r5lw/feedshare-shrink_800/B4EaHGpqTbJwAo-/0/1794334173092?e=2147483647&v=beta&t=lsf5VnTE9Xg4C7UrcUOKWbwtzpXhhj28ieG_Z3huFrQ",
"width": null
}
],
"mentions": [
"jakewhittenberg",
"microsoft"
],
"metrics": {
"comment_count": 37,
"like_count": 564,
"quote_count": null,
"repost_count": null,
"save_count": null,
"share_count": null,
"view_count": null
},
"platform": "linkedin",
"platform_specific": {
"linkedin": {
"author_follower_count": null,
"author_headline": "Vice Chair and President at Microsoft Corporation",
"content_urn": "urn:li:share:7525983002573602816",
"document": null,
"hidden_image_count": null,
"is_author_influencer": true,
"is_edited": true,
"link": null,
"modified_at": null,
"more_articles": [],
"reaction": null,
"repost_activity_id": "7525990879568842752",
"reshared_post": null,
"top_comments": []
}
},
"platform_type": "reshare",
"published_at": "2026-11-10T18:09:34Z",
"text": "Yesterday, Cal Raleigh and Jake Whittenberg joined me to announce the first 25 nonprofits that will receive Microsoft Community-First Grants. What a great opportunity to celebrate local organizations making a real difference in our backyard. https://aka.ms/AA13pftp",
"thumbnail_url": "https://media.licdn.com/dms/image/v2/D4E22AQHiLQZfV3r5lw/feedshare-shrink_800/B4EaHGpqTbJwAo-/0/1794334173092?e=2147483647&v=beta&t=lsf5VnTE9Xg4C7UrcUOKWbwtzpXhhj28ieG_Z3huFrQ",
"title": null,
"type": "image",
"unknown_fields": [
"platform_specific.linkedin.top_comments"
],
"url": "https://www.linkedin.com/feed/update/urn:li:activity:7525983004125478913"
},
"view_engagement_rate": null,
"views_vs_median": null
},
{
"engagement_rate": 0.000023,
"engagement_vs_median": 2.11,
"is_counted": true,
"post": {
"approximate_fields": [],
"author": {
"avatar_url": "https://media.licdn.com/dms/image/v2/D560BAQH32RJQCl3dDQ/company-logo_100_100/B56ZYQ0mrGGoAU-/0/1744038948046/microsoft_logo?e=2147483647&v=beta&t=rr_7_bFRKp6umQxIHErPOZHtR8dMPIYeTjlKFdotJBY",
"display_name": "Microsoft",
"id": null,
"is_verified": null,
"url": "https://www.linkedin.com/company/microsoft",
"username": "microsoft"
},
"coauthors": [],
"duration_ms": null,
"hashtags": [],
"id": "7525637561919373312",
"is_nsfw": null,
"is_pinned": null,
"is_sponsored": null,
"language": 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/D4E10AQFXXgTlzv8-bg/image-shrink_800/B4EaHBvcusIIAs-/0/1794251804152?e=2147483647&v=beta&t=j5MQWQed5FFngQdQzQ-Ltck9S-NRB5JsrYOU3TkNQKc",
"width": null
}
],
"mentions": [
"northern-trust"
],
"metrics": {
"comment_count": 64,
"like_count": 601,
"quote_count": null,
"repost_count": null,
"save_count": null,
"share_count": null,
"view_count": null
},
"platform": "linkedin",
"platform_specific": {
"linkedin": {
"author_follower_count": 29509552,
"author_headline": null,
"content_urn": "urn:li:share:7525637560883146752",
"document": null,
"hidden_image_count": null,
"is_author_influencer": false,
"is_edited": true,
"link": null,
"modified_at": null,
"more_articles": [],
"reaction": null,
"repost_activity_id": null,
"reshared_post": null,
"top_comments": []
}
},
"platform_type": "post",
"published_at": "2026-11-09T19:16:54Z",
"text": "From 2.5 weeks to just 3 days. That's the difference Northern Trust is making in client onboarding. \n \nProcessing years of financial transactions across different formats is complex work, especially when accuracy is critical. By partnering with Microsoft Frontier Company, Northe…",
"thumbnail_url": "https://media.licdn.com/dms/image/v2/D4E10AQFXXgTlzv8-bg/image-shrink_800/B4EaHBvcusIIAs-/0/1794251804152?e=2147483647&v=beta&t=j5MQWQed5FFngQdQzQ-Ltck9S-NRB5JsrYOU3TkNQKc",
"title": null,
"type": "image",
"unknown_fields": [
"platform_specific.linkedin.top_comments"
],
"url": "https://www.linkedin.com/feed/update/urn:li:activity:7525637561919373312"
},
"view_engagement_rate": null,
"views_vs_median": null
}
],
"profile": {
"approximate_fields": [],
"avatar_url": "https://media.licdn.com/dms/image/v2/D560BAQH32RJQCl3dDQ/company-logo_200_200/B56ZYQ0mrGGoAM-/0/1744038948046/microsoft_logo?e=2147483647&v=beta&t=ts9MGrTk7Lz3R1bmAfzCL8euuuuPWPCoXfdiLA2_IzM",
"banner_url": "https://media.licdn.com/dms/image/v2/D4E3DAQGWOa_gAs1qXg/image-scale_325_1920/B4EZ8ZTX5SJEAI-/0/1782835937311/microsoft_cover?e=2147483647&v=beta&t=z_r5wUburw7hBaw0p2LprNAGNhvq22Evh-q5biHXpYM",
"bio": "Every company has a mission. What's ours? To empower every person and every organization to achieve more. We believe technology can and should be a force for good and that meaningful innovation contributes to a brighter world in the future and today. Our culture doesn’t just enco…",
"category": "Software Development",
"country_code": "US",
"created_at": null,
"display_name": "Microsoft",
"external_links": [
{
"title": null,
"url": "https://news.microsoft.com/"
}
],
"id": "1035",
"is_private": false,
"is_verified": null,
"location": "Redmond, Washington",
"metrics": {
"follower_count": 29509552,
"following_count": null,
"post_count": null,
"total_like_count": null,
"total_view_count": null
},
"platform": "linkedin",
"platform_specific": {
"linkedin": {
"affiliated_pages": [
{
"avatar_url": "https://media.licdn.com/dms/image/v2/D560BAQGxQRyEwD643g/company-logo_100_100/B56Z3045ErGgAQ-/0/1777930048179/github_logo?e=2147483647&v=beta&t=grtfSumirYwJo82_XDkJhWLUb80SL_0-pQut0U6Fa4I",
"category": "Software Development",
"display_name": "GitHub",
"id": null,
"is_verified": null,
"location": "San Francisco, CA",
"url": "https://www.linkedin.com/company/github",
"username": "github"
},
{
"avatar_url": "https://media.licdn.com/dms/image/v2/D4E0BAQHgSFh_G4-OUQ/company-logo_100_100/B4EZ7Vy.5ZIAAQ-/0/1781703372677/microsoftlearn_logo?e=2147483647&v=beta&t=Dp2xxr86fL7Lzz2t3qSHR2Hvqo0l8T8J613VFOFK-C8",
"category": "IT Services and IT Consulting",
"display_name": "Microsoft Learn",
"id": null,
"is_verified": null,
"location": "Redmond, Washington",
"url": "https://www.linkedin.com/showcase/microsoftlearn",
"username": "microsoftlearn"
},
{
"avatar_url": "https://media.licdn.com/dms/image/v2/D560BAQGtwKUNwBubxg/company-logo_100_100/company-logo_100_100/0/1688144190823/microsoft_azure_logo?e=2147483647&v=beta&t=Az-FdepnXVK9TPeJSGXl6mai3Hj7BGR_KQ2oRWQ6aYI",
"category": "Technology, Information and Internet",
"display_name": "Microsoft Azure",
"id": null,
"is_verified": null,
"location": null,
"url": "https://www.linkedin.com/showcase/microsoft-azure",
"username": "microsoft-azure"
}
],
"certifications": [],
"company_size": {
"lower_bound": 10001,
"upper_bound": null
},
"connection_count": null,
"courses": [],
"education": [],
"employee_count": 231109,
"employees": [
{
"avatar_url": "https://media.licdn.com/dms/image/v2/D5603AQHW7wKzPb3DAg/profile-displayphoto-shrink_100_100/profile-displayphoto-shrink_100_100/0/1718221341641?e=2147483647&v=beta&t=1Fuwf5T2Z3QNe6XvFlJRvkKQ88IFenXaxnHT-HdZvvI",
"display_name": "Reid Hoffman",
"id": null,
"is_verified": null,
"url": "https://www.linkedin.com/in/reidhoffman",
"username": "reidhoffman"
}
],
"experience": [],
"founded_year": null,
"headline": null,
"headquarters": {
"city": "Redmond",
"country_code": "US",
"postal_code": "98052",
"region": "Washington",
"street": "1 Microsoft Way"
},
"honors": [],
"is_creator": null,
"is_hiring": null,
"is_influencer": null,
"is_open_to_work": null,
"kind": "company",
"languages": [],
"locations": [
{
"address": "1 Microsoft Way, Redmond, Washington 98052, US",
"is_primary": true
},
{
"address": "1 Denison Street, North Sydney, NSW 2060, AU",
"is_primary": false
},
{
"address": "1950 Meadowvale Blvd, Mississauga, Ontario L5N 8L9, CA",
"is_primary": false
}
],
"organization_type": "Public Company",
"organizations": [],
"patents": [],
"projects": [],
"publication_frequency": null,
"publications": [],
"reaction_type": null,
"recommendation_count": null,
"recommendations": [],
"similar_pages": [
{
"avatar_url": "https://media.licdn.com/dms/image/v2/D4E0BAQGv3cqOuUMY7g/company-logo_100_100/B4EZmhegXHGcAU-/0/1759350753990/google_logo?e=2147483647&v=beta&t=zYekdwB_mnXarr4wa4kw8w3Jikm8YaakM5aiDyAyvP0",
"category": "Software Development",
"display_name": "Google",
"id": null,
"is_verified": null,
"location": "Mountain View, CA",
"url": "https://www.linkedin.com/company/google",
"username": "google"
},
{
"avatar_url": "https://media.licdn.com/dms/image/v2/D560BAQGDLy4STCnHbg/company-logo_100_100/B56ZnZxDipI0AQ-/0/1760295142304/amazon_logo?e=2147483647&v=beta&t=qIUP7OofXIuuuVACb5ToeWH9PHXrPYsS8jsTZ3Q0sUg",
"category": "Software Development",
"display_name": "Amazon",
"id": null,
"is_verified": null,
"location": null,
"url": "https://www.linkedin.com/company/amazon",
"username": "amazon"
},
{
"avatar_url": "https://media.licdn.com/dms/image/v2/C560BAQHdAaarsO-eyA/company-logo_100_100/company-logo_100_100/0/1630637844948/apple_logo?e=2147483647&v=beta&t=p0JNmv2WB0EMMQgvzl9R8TaXgzEaDraGS4MWR0IawjQ",
"category": "Computers and Electronics Manufacturing",
"display_name": "Apple",
"id": null,
"is_verified": null,
"location": "Cupertino, California",
"url": "https://www.linkedin.com/company/apple",
"username": "apple"
}
],
"similar_profiles": [],
"skills": [],
"specialties": [
"Business Software",
"Developer Tools",
"Home & Educational Software"
],
"tagline": null,
"test_scores": [],
"volunteering": []
}
},
"type": "organization",
"unknown_fields": [],
"url": "https://www.linkedin.com/company/microsoft",
"username": "microsoft"
},
"top_post_id": "7525637561919373312",
"unknown_fields": [],
"url": "https://www.linkedin.com/company/microsoft"
},
"meta": {
"request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
"platform": "linkedin",
"source": "page",
"is_cached": false,
"credits_charged": 1,
"latency_ms": 1000,
"fetched_at": "2026-10-25T12:00:00Z",
"input": {
"kind": "profile",
"id": "1035",
"url": "https://www.linkedin.com/company/microsoft"
},
"credits_remaining": 9999,
"client_request_id": null,
"warnings": []
}
}Long arrays and strings are shortened for display; real responses are complete.
The LinkedIn account: a Page's or a member's link (linkedin.com/company/<name>, /school/<name>, /showcase/<name> or /in/<name>, any tab of it), or its name with that prefix (company/microsoft, in/satyanadella). A bare name is a company's.
Examplehttps://www.linkedin.com/company/microsoft/
handle takes LinkedIn profile links; another kind of link, or another platform's, fails free with invalid_input. Unknown parameters are rejected with a suggestion, never ignored (Requests).
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, meta}. data is a engagement object; meta describes the request (meta). The fields are the shared engagement schema, the same on all 8 platforms that serve it.
platformstringPlatform ID (tiktok, instagram, …).
idstringPlatform-native account ID (equals profile.id).
urlstring uriCanonical profile URL (equals profile.url).
profileobjectThe account, as its profile endpoint returns it; its metrics.follower_count divides every engagement_rate.
ShowHide 20 child fields
postsobject[]The sampled recent posts in the profile's order, each with its own figures. [] when none; [] and in unknown_fields when unreadable (a private account, a failed posts request).
ShowHide 6 child fields
metricsobjectFigures over the counted posts (by the account, not pinned, no reposts); each null when no counted post has its inputs.
ShowHide 19 child fields
sampled_post_countintegernullablePosts in the sample, the length of posts; null when unreadable.
counted_post_countintegernullableSampled posts that enter the figures.
rated_post_countintegernullableCounted posts with known like and comment counts: what interaction figures and rates are over.
views_per_postnumbernullableMean views per counted post with a view count.
median_views_per_postnumbernullableMedian views per counted post: the typical post, unmoved by one viral hit.
likes_per_postnumbernullableMean likes per counted post with a like count.
comments_per_postnumbernullableMean comments per counted post with a comment count.
shares_per_postnumbernullableMean shares per counted post with a share count.
reposts_per_postnumbernullableMean reposts per counted post with a repost count.
quotes_per_postnumbernullableMean quote posts per counted post with a quote count.
saves_per_postnumbernullableMean saves per counted post with a save count.
interactions_per_postnumbernullableMean interactions (likes + comments) per rated post; known without a follower count.
engagement_ratenumbernullableMean of the rated posts' engagement_rate (interactions per follower), as a fraction (0.042 = 4.2%).
median_engagement_ratenumbernullableMedian of the rated posts' engagement_rate.
engagement_rate_stddevnumbernullablePopulation standard deviation of the rated posts' engagement_rate: how uneven they perform. Null under 2 rated posts.
view_engagement_ratenumbernullableMean of the rated posts' view_engagement_rate (interactions per view), as a fraction.
comment_to_like_rationumbernullableThe rated posts' comments over their likes.
posts_per_weeknumbernullablePosting cadence: intervals between counted posts per week from oldest_post_at to newest_post_at.
formatsobject[]The counted posts by post type, most posts first; [] when none are counted.
ShowHide 5 child fields
typestringPost type (post.type). New values may be added; treat unknown values as other.
One ofvideoimagecarouseltextlinkaudio
counted_post_countintegerCounted posts of this type.
views_per_postnumbernullableMean views per post of this type.
interactions_per_postnumbernullableMean interactions per rated post of this type.
engagement_ratenumbernullableMean engagement_rate of the rated posts of this type.
oldest_post_atstring date-timenullablePublish time of the oldest counted post, RFC 3339 UTC: where the sample starts.
newest_post_atstring date-timenullablePublish time of the newest counted post, RFC 3339 UTC: when the account last posted.
top_post_idstringnullableID of the rated post with the most interactions (likes + comments); the first on a tie.
bottom_post_idstringnullableID of the rated post with the fewest interactions; the first on a tie.
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
approximate_fieldsstring[]JSON paths of figures computed from an approximate input (a rounded follower or view count, a relative publish time); a posts[] path means at least one post's. [] when all exact.
unknown_fieldsstring[]JSON paths of lists whose [] means unknown rather than none (posts, metrics.formats). [] when every list is known.
not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.
400
400 Bad Request: 1 error code. 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.
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: 2 error codes. 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, 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_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.
451
451: 1 error code. Free: errors cost nothing.
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.
From 1 credit per request, up to 15 credits. Charged only for successful requests. Errors are free. The price depends on the source that produced the result, reported as meta.source; sources are tried cheapest first: Public page → Data partner.
| Source | Price per successful request | Per 1,000 requests |
|---|---|---|
Public page page | 1 credit | $0.75–$1.97 |
Data partner vendor | 15 credits | $11.24–$29.50 |
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. One request costs at most 15 credits, but that amount is never locked up in advance: right before costlier work, SocialTap sets aside more of your balance, the exact price when the size of the item is known beforehand, otherwise as much as your balance allows (and the work is limited to what that pays for). It then charges the actual price and releases the rest. If the result would cost more than your balance covers, the request is refused with insufficient_credits as well, and costs nothing.
| meta.source | Source | What it means |
|---|---|---|
page | Public page | Data embedded in the platform's public web page. |
vendor | Data partner | A public-data partner's copy of the item, where the platform hides it from logged-out visitors: read live by the partner at request time. |
meta.credits_charged and the x-credits-charged header show what you paid. How credits work · Packs
Endpoint ID linkedin.engagement · operationId linkedin.engagement.get · Product overview