# Instagram User Highlights (`instagram.user_highlights`)

Story highlight reels of a public Instagram account by handle: ids, titles, cover images and owner.

Docs: https://primaryapi.com/docs/api-reference/instagram/user_highlights

- Endpoint: `POST https://api.primaryapi.com/v1/run/instagram.user_highlights`
- Category: Social · Platform: `instagram` · Kind: list · Status: live
- Price: 3 credits per call. Every call costs the same, including calls that were retried automatically.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=instagram.user_highlights`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `handle` | string | yes |  | max 100 chars | Instagram username, with or without the leading @. |
| `userId` | string | no |  | pattern: ^\d{1,24}$ | Numeric Instagram user id (pk) of the same account (optional, faster than handle). |
| `limit` | integer | no | 100 | 1–100 | Maximum number of results to return (1-100, default 100). |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `highlights` | object[] |  |
| `highlights[].id` | string | Highlight reel id (digits, without the "highlight:" prefix) |
| `highlights[].title` | string \| null |  |
| `highlights[].coverUrl` | string \| null |  |
| `highlights[].mediaCount` | integer \| null |  |
| `highlights[].createdUtc` | integer \| null | Creation time, unix seconds (UTC) |
| `highlights[].userId` | string \| null |  |
| `highlights[].ownerHandle` | string \| null |  |
| `highlights[].avatarUrl` | string \| null |  |
| `nextCursor` | string \| null | Always null: one highlight tray per call |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/instagram.user_highlights" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"handle":"nasa"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "highlights": [
        {
          "id": "string",
          "title": "string",
          "coverUrl": "https://example.com",
          "mediaCount": 0,
          "createdUtc": 0,
          "userId": "string",
          "ownerHandle": "string",
          "avatarUrl": "https://example.com"
        }
      ],
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 3,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## Pricing and reliability

- Usual price: 3 credits per call
- Price ceiling: the usual price, even when a call is retried. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=instagram.user_highlights`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Use instagram.highlight_detail for the items inside a highlight.

