Example
curl -G 'https://socialtap.dev/v1/instagram/embed' \
--data-urlencode 'url=https://www.instagram.com/p/DeuOR-CjKE9/' \
-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.instagram.embed.get({ url: "https://www.instagram.com/p/DeuOR-CjKE9/" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);const params = new URLSearchParams({
url: "https://www.instagram.com/p/DeuOR-CjKE9/",
});
const res = await fetch(`https://socialtap.dev/v1/instagram/embed?${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/instagram/embed",
params={"url": "https://www.instagram.com/p/DeuOR-CjKE9/"},
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("url", "https://www.instagram.com/p/DeuOR-CjKE9/")
req, err := http.NewRequest("GET", "https://socialtap.dev/v1/instagram/embed?"+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([
'url' => 'https://www.instagram.com/p/DeuOR-CjKE9/',
]);
$ch = curl_init('https://socialtap.dev/v1/instagram/embed?' . $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/instagram/embed")
uri.query = URI.encode_www_form('url' => 'https://www.instagram.com/p/DeuOR-CjKE9/')
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 = "url=" + encode("https://www.instagram.com/p/DeuOR-CjKE9/");
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://socialtap.dev/v1/instagram/embed?" + 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("&",
"url=" + Uri.EscapeDataString("https://www.instagram.com/p/DeuOR-CjKE9/"));
var res = await http.GetAsync("https://socialtap.dev/v1/instagram/embed?" + 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/instagram/embed")
.query(&[("url", "https://www.instagram.com/p/DeuOR-CjKE9/")])
.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": {
"author": {
"avatar_url": null,
"display_name": "National Geographic",
"id": "787132",
"is_verified": null,
"url": "https://www.instagram.com/natgeo/",
"username": "natgeo"
},
"embed_url": "https://www.instagram.com/p/DeuOR-CjKE9/embed/captioned/",
"height": null,
"html": "<blockquote class=\"instagram-media\" data-instgrm-captioned data-instgrm-permalink=\"https://www.instagram.com/p/DeuOR-CjKE9/?utm_source=ig_embed&utm_campaign=loading\" data-instgrm-version=\"14\" style=\" background:#FFF; border:0; border-radius:3px; box-shadow:0 0 1px 0 rgba(0,0,…",
"id": "DeuOR-CjKE9",
"platform": "instagram",
"platform_specific": {},
"thumbnail_height": 800,
"thumbnail_url": "https://scontent-atl3-1.cdninstagram.com/v/t51.82787-15/858921974_18710195065019133_277441153414192961_n.jpg?stp=dst-jpg_e35_p640x640_sh2.08_tt6&_nc_ht=scontent-atl3-1.cdninstagram.com&_nc_cat=109&_nc_oc=SCRUBBED&_nc_ohc=SCRUBBED&_nc_gid=SCRUBBED&edm=SCRUBBED&ccb=SCRUBBED&oh=SCRU…",
"thumbnail_width": 640,
"title": "Some of the best reasons to travel in 2027 are far from the usual destinations. 🌎\n\nNational Geographic’s picks for Best of the World 2027 are here and features 25 destinations across six continents. \n\nWhether you're drawn to places steeped in history or the thrill of exploring th…",
"type": "post",
"url": "https://www.instagram.com/p/DeuOR-CjKE9/",
"width": 658
},
"meta": {
"request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
"platform": "instagram",
"source": "api",
"is_cached": false,
"credits_charged": 1,
"latency_ms": 254,
"fetched_at": "2026-10-25T12:00:00Z",
"input": {
"kind": "post",
"id": "DeuOR-CjKE9",
"url": "https://www.instagram.com/p/DeuOR-CjKE9/"
},
"credits_remaining": 9999,
"client_request_id": null,
"warnings": []
}
}Long arrays and strings are shortened for display; real responses are complete.
Instagram post, reel or profile link (instagram.com/p/…, /reel/…, /reels/…, /tv/…, /<username>/p/…, share links, m.instagram.com, instagr.am, instagram.com/<username>/) or a post's raw shortcode. A username needs its profile link: a bare string is read as a shortcode.
Examplehttps://www.instagram.com/p/DeuOR-CjKE9/
Widest the embed may be laid out, in pixels (default and most: 658; a wider value is laid out at 658). Instagram's embeds are responsive below it.
hide_captionbooleanEmbed a post without its caption (Instagram's hidecaption). Profiles have none: ignored for a profile link.
omit_scriptbooleanLeave Instagram's embed.js script tag out of html, for a page that loads it once itself (then call window.instgrm.Embeds.process() after inserting the markup).
url takes Instagram post, video and 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 embed object; meta describes the request (meta). The fields are the embed schema.
platformstringPlatform ID (instagram, youtube, tiktok, …).
typestringWhat is embedded, named by its resource: post (any post: photo, carousel, video, reel), profile (an account), or playlist. New values may be added; treat unknown values as other.
One ofpostprofileplaylist
idstringThe ID the platform's embed is addressed by (as in embed_url): a post's ID (equals post.id), a playlist's ID, and for a profile the account's username on platforms whose profile embeds are addressed by it (Instagram, TikTok); the account's numeric ID, when known, is author.id.
urlstring uriCanonical public URL of what is embedded (post.url, profile.url): the link the embed opens.
htmlstringThe platform's embed code, ready to paste into an HTML page: its markup and, unless asked to leave it out, the script tag that turns it into the embedded post or profile. It loads the platform's script and content in the visitor's browser.
embed_urlstring urinullableThe platform's embed page alone, for an iframe's src (what html's script loads); null when the platform has none.
widthintegernullableWidth in pixels the embed is laid out for (its maximum when it is responsive); null when the platform does not say.
heightintegernullableHeight in pixels; null when the embed sizes itself to its content (Instagram's always do).
titlestringnullableThe title the platform gives the embed: a post's caption or a video's title, a profile's page title; null when it has none.
authorobjectThe account the embedded item belongs to: the post's author, the playlist's owner, or for a profile the account itself.
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.
thumbnail_urlstring urinullablePreview image URL the platform names for the embed (a post's image or cover, a profile's picture); platform CDN URLs can expire within hours.
thumbnail_widthintegernullableWidth of thumbnail_url in pixels; null when unknown.
thumbnail_heightintegernullableHeight of thumbnail_url in pixels; null when unknown.
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
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, 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.
From 1 credit per request. 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: Platform API → Public page.
| Source | Price per successful request | Per 1,000 requests |
|---|---|---|
Platform API api | 1 credit | $0.75–$1.97 |
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 |
|---|---|---|
api | Platform API | The platform's public, logged-out API. |
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 instagram.embed · operationId instagram.embed.get · Product overview