Skip to content

List a public Instagram account’s story highlights, with title, cover image and media count, from the username.

GET · POST1 credit / successful callCursor-paginated
GEThttps://api.scrapier.io/api/v2/instagram-highlights/Open in Playground

Send a username in usernames and get back the account’s story highlights, each with its ID, title, cover image and media count.

Pass a highlight’s ID to instagram-highlight-details for more about it.

  • See how a brand organizes its highlights (products, FAQs, reviews).
  • Collect highlight IDs for follow-up lookups.
Terminal window
curl -G "https://api.scrapier.io/api/v2/instagram-highlights/" \
-H "X-API-Key: YOUR_API_KEY" \
--data-urlencode "usernames=mrbeast" \
--max-time 210
NameTypeRequiredDefaultDescription
X-API-Key headerstringyes—Your API key from the dashboard.
usernamesstringyese.g. mrbeastInstagram username.
cursorstringno—Pagination cursor returned in the previous response's next_cursor. Pass it back unchanged to fetch the next page. When next_cursor is null, you have reached the last page.
Advanced
NameTypeDefaultDescription
use_proxybooleantrueRoute the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise.
raw_databooleanfalseWhen true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under raw_responses, in place of the formatted items. When false (default) you get the formatted output. Pagination (cursor / next_cursor) works the same in both modes.
{
"success": true,
"data": {
"usernames": "instagram",
"page": 1,
"page_size": 10,
"highlights": [
{
"id": "highlight-1",
"title": "Behind the scenes",
"cover_image": "https://...",
"media_count": 12
}
],
"next_cursor": null
}
}

Sample from the live catalog; arrays trimmed to 3 items. Results are in data.highlights.

FieldTypeExampleDescription
usernamesstringinstagram—
pageinteger1—
page_sizeinteger10—
highlightsarray[1 item]The results.
next_cursornullnullPass back as cursor for the next page. null on the last page.
highlights[].idstringhighlight-1—
highlights[].titlestringBehind the scenes—
highlights[].cover_imagestringhttps://...—
highlights[].media_countinteger12—

Pass data.next_cursor back as cursor until it is null. Required inputs are ignored once a cursor is sent. Each page is one billed call. More in Pagination.

const url = "https://api.scrapier.io/api/v2/instagram-highlights/";
let params = { usernames: "mrbeast" };
const items = [];
for (let page = 0; page < 10; page++) { // each page is one billed call
const res = await fetch(`${url}?${new URLSearchParams(params)}`, {
headers: { "X-API-Key": "YOUR_API_KEY" },
signal: AbortSignal.timeout(210_000),
});
const body = await res.json();
if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
const data = body.data;
items.push(...(data.highlights ?? []));
if (!data.next_cursor) break; // null = last page
params = { cursor: data.next_cursor };
}

Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.

StatusMeaningRetry?Charged?
400Bad or missing input.No — fix the paramsNo
401 / 403Missing, invalid or revoked API key.No — fix the keyNo
402Out of credits (body has balance).No — top upNo
404Unknown endpoint slug.No — check the slugNo
429 / 503Busy or throttled.Yes — after Retry-AfterNo
5xxTarget site or upstream failure, or timeout.Yes — with backoffNo
  • usernames takes one username per call.
  • Instagram Highlight Details — Look up one Instagram story highlight by ID or URL and get its title, media count and owner.
  • Instagram Profile — Look up a public Instagram account by username, @handle or URL and get its bio, follower, following and post counts and verification status.
  • Instagram Profile Reels — List a public account’s reels, a page at a time, with caption, like and comment counts and posting time, from the username.