> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# Instagram Highlights

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

`GET|POST https://api.scrapier.io/api/v2/instagram-highlights/` · 1 credit per successful call · Cursor-paginated

## 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

- See how a brand organizes its highlights (products, FAQs, reviews).
- Collect highlight IDs for follow-up lookups.

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/instagram-highlights/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "usernames=mrbeast" \
  --max-time 210
```

```python
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"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `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. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `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

HTTP 200. Results are in `data.highlights`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "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
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `usernames` | string | `instagram` |  |
| `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

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.

```python
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

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- `usernames` takes one username per call.

## Related

- [Instagram Highlight Details](https://docs.scrapier.io/api-reference/instagram/instagram-highlight-details.md): Look up one Instagram story highlight by ID or URL and get its title, media count and owner.
- [Instagram Profile](https://docs.scrapier.io/api-reference/instagram/instagram-profile.md): 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](https://docs.scrapier.io/api-reference/instagram/instagram-profile-reels.md): List a public account's reels, a page at a time, with caption, like and comment counts and posting time, from the username.
