> 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 Highlight Details

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

`GET|POST https://api.scrapier.io/api/v2/instagram-highlight-details/` · 1 credit per successful call · Single lookup

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

- Resolve a highlight link someone shared into structured data.
- Check how many items a creator keeps in a highlight.

## Request

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

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

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. |
| `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. |
| `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.highlight`. Sample from the live catalog, arrays trimmed to 3 items.

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

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

Single lookup: everything comes back in one call and `next_cursor` is always `null`.

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

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

## Related

- [Instagram Highlights](https://docs.scrapier.io/api-reference/instagram/instagram-highlights.md): List a public Instagram account's story highlights, with title, cover image and media count, from the username.
- [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.
