Instagram Highlight Details
Look up one Instagram story highlight by ID or URL and get its title, media count and owner.
Overview
Section titled “Overview”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.
Use cases
Section titled “Use cases”- Resolve a highlight link someone shared into structured data.
- Check how many items a creator keeps in a highlight.
Request
Section titled “Request”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 210const params = new URLSearchParams({ highlight_ids: "17975319242920589" });
const res = await fetch(`https://api.scrapier.io/api/v2/instagram-highlight-details/?${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}`);
console.log(body.data.highlight);import requests
resp = requests.get( "https://api.scrapier.io/api/v2/instagram-highlight-details/", headers={"X-API-Key": "YOUR_API_KEY"}, params={"highlight_ids": "17975319242920589"}, timeout=210,)body = resp.json()if not resp.ok: raise RuntimeError(body.get("error") or body.get("detail"))
print(body["data"]["highlight"])curl -X POST "https://api.scrapier.io/api/v2/instagram-highlight-details/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"highlight_ids":"17975319242920589"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
highlight_ids | string | yes | e.g. 17975319242920589 | Bare 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
| Name | Type | Default | Description |
|---|---|---|---|
use_proxy | boolean | true | Route the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise. |
raw_data | boolean | false | When 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. |
Response
Section titled “Response”{ "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 }}Bad input. The exact message varies by endpoint.
{ "success": false, "error": "…"}Balance below the endpoint’s price.
{ "error": "Insufficient credits. Buy more to scrape more.", "balance": 1, "required": 2}Invalid or unknown API key.
{ "detail": "Authentication service unavailable or invalid API key."}Throttled — wait for Retry-After.
{ "detail": "Request was throttled. Expected available in N seconds."}Sample from the live catalog; arrays trimmed to 3 items. Results are in data.highlight.
Response fields
Section titled “Response fields”| Field | Type | Example | Description |
|---|---|---|---|
highlight_ids | string | 17975319242920589 | — |
highlight | object | {…} | The results. |
next_cursor | null | null | Pass back as cursor for the next page. null on the last page. |
highlight.input_url | string | 17975319242920589 | — |
highlight.success | boolean | true | — |
highlight.id | string | highlight:17975319242920589 | — |
highlight.title | string | Just Do It | — |
highlight.media_count | integer | 48 | — |
highlight.user | object | {…} | — |
Pagination
Section titled “Pagination”Returns everything in one call; next_cursor is always null.
Errors
Section titled “Errors”Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.
| Status | Meaning | Retry? | Charged? |
|---|---|---|---|
400 | Bad or missing input. | No — fix the params | No |
401 / 403 | Missing, invalid or revoked API key. | No — fix the key | No |
402 | Out of credits (body has balance). | No — top up | No |
404 | Unknown endpoint slug. | No — check the slug | No |
429 / 503 | Busy or throttled. | Yes — after Retry-After | No |
5xx | Target site or upstream failure, or timeout. | Yes — with backoff | No |
- The response data carries its own
successfield from the scraper. The outersuccessis what counts: an HTTP 200 with outersuccess: trueis billed, even if the inner field says otherwise.
Related
Section titled “Related”- 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.