Instagram Highlights
List a public Instagram account’s story highlights, with title, cover image and media count, from the username.
Overview
Section titled “Overview”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.
Use cases
Section titled “Use cases”- See how a brand organizes its highlights (products, FAQs, reviews).
- Collect highlight IDs for follow-up lookups.
Request
Section titled “Request”curl -G "https://api.scrapier.io/api/v2/instagram-highlights/" \ -H "X-API-Key: YOUR_API_KEY" \ --data-urlencode "usernames=mrbeast" \ --max-time 210const params = new URLSearchParams({ usernames: "mrbeast" });
const res = await fetch(`https://api.scrapier.io/api/v2/instagram-highlights/?${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.highlights);import requests
resp = requests.get( "https://api.scrapier.io/api/v2/instagram-highlights/", headers={"X-API-Key": "YOUR_API_KEY"}, params={"usernames": "mrbeast"}, timeout=210,)body = resp.json()if not resp.ok: raise RuntimeError(body.get("error") or body.get("detail"))
print(body["data"]["highlights"])curl -X POST "https://api.scrapier.io/api/v2/instagram-highlights/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"usernames":"mrbeast"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
usernames | string | yes | e.g. mrbeast | Instagram username. |
cursor | string | no | — | 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
| 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": { "usernames": "instagram", "page": 1, "page_size": 10, "highlights": [ { "id": "highlight-1", "title": "Behind the scenes", "cover_image": "https://...", "media_count": 12 } ], "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.highlights.
Response fields
Section titled “Response fields”| Field | Type | Example | Description |
|---|---|---|---|
usernames | string | — | |
page | integer | 1 | — |
page_size | integer | 10 | — |
highlights | array | [1 item] | The results. |
next_cursor | null | null | Pass back as cursor for the next page. null on the last page. |
highlights[].id | string | highlight-1 | — |
highlights[].title | string | Behind the scenes | — |
highlights[].cover_image | string | https://... | — |
highlights[].media_count | integer | 12 | — |
Pagination
Section titled “Pagination”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 };}import requests
URL = "https://api.scrapier.io/api/v2/instagram-highlights/"HEADERS = {"X-API-Key": "YOUR_API_KEY"}params = {"usernames": "mrbeast"}items = []
for _ in range(10): # each page is one billed call resp = requests.get(URL, headers=HEADERS, params=params, timeout=210) resp.raise_for_status() data = resp.json()["data"] items.extend(data.get("highlights") or []) if not data.get("next_cursor"): # None = last page break params = {"cursor": data["next_cursor"]}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 |
usernamestakes one username per call.
Related
Section titled “Related”- 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.