Skip to content

Look up one Instagram story highlight by ID or URL and get its title, media count and owner.

GET · POST1 credit / successful callSingle lookup
GEThttps://api.scrapier.io/api/v2/instagram-highlight-details/Open in Playground

Send a highlight in highlight_ids, as a bare numeric ID, as “highlight:ID”, or as a stories/highlights URL. You get back the highlight’s ID, title, media count and owning user in one call.

To discover a profile’s highlight IDs first, use instagram-highlights.

  • Resolve a highlight link someone shared into structured data.
  • Check how many items a creator keeps in a highlight.
Terminal window
curl -G "https://api.scrapier.io/api/v2/instagram-highlight-details/" \
-H "X-API-Key: YOUR_API_KEY" \
--data-urlencode "highlight_ids=17975319242920589" \
--max-time 210
NameTypeRequiredDefaultDescription
X-API-Key headerstringyes—Your API key from the dashboard.
highlight_idsstringyese.g. 17975319242920589Bare numeric highlight id, "highlight:ID", or a stories/highlights URL. Lookup endpoint -- next_cursor null. Missing/deleted id -> 404, bad id -> 400, IG block -> 502.
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": {
"highlight_ids": "17975319242920589",
"highlight": {
"input_url": "17975319242920589",
"success": true,
"id": "highlight:17975319242920589",
"title": "Just Do It",
"media_count": 48,
"user": {
"pk": "13460080",
"username": "nike",
"is_verified": true
}
},
"next_cursor": null
}
}

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

FieldTypeExampleDescription
highlight_idsstring17975319242920589—
highlightobject{…}The results.
next_cursornullnullPass back as cursor for the next page. null on the last page.
highlight.input_urlstring17975319242920589—
highlight.successbooleantrue—
highlight.idstringhighlight:17975319242920589—
highlight.titlestringJust Do It—
highlight.media_countinteger48—
highlight.userobject{…}—

Returns everything in one call; next_cursor is always null.

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
  • The response data carries its own success field from the scraper. The outer success is what counts: an HTTP 200 with outer success: true is billed, even if the inner field says otherwise.
  • Instagram Highlights — List a public Instagram account’s story highlights, with title, cover image and media count, from the username.
  • 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.