# List Highlights

Lists up to 10 public highlight collection titles and covers from a profile tray. Returns collection metadata without further-page continuation.

- Platform: [Instagram](https://docs.upscrape.com/docs/platforms/instagram)
- Capability ID: `instagram.highlights.list`
- Cost: 1 credit per request
- Maximum runtime: 120 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "limit": 5,
    "username": "nasa"
  },
  "capability": "instagram.highlights.list"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | Maximum highlight collections from the public tray; this endpoint returns collection metadata without continuation |
| `username` | `string` | Yes | Public Instagram username |

### Example input

```json
{
  "limit": 5,
  "username": "nasa"
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

### Illustrative sample output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "items": [
    {
      "data": {
        "id": "18195781759377100",
        "owner_username": "nasa",
        "title": "Roman",
        "url": "https://www.instagram.com/stories/highlights/18195781759377100/"
      }
    },
    {
      "data": {
        "id": "18123023338592759",
        "owner_username": "nasa",
        "title": "Wallpapers",
        "url": "https://www.instagram.com/stories/highlights/18123023338592759/"
      }
    },
    {
      "data": {
        "id": "18201653992314974",
        "owner_username": "nasa",
        "title": "Artemis III",
        "url": "https://www.instagram.com/stories/highlights/18201653992314974/"
      }
    }
  ],
  "summary": {
    "available_on_page": 5,
    "continuation_supported": false,
    "emitted": 5,
    "upstream_has_more": false,
    "user_id": "528817151",
    "username": "nasa"
  }
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `items` | `array` | 3 items |
| `items` | `array` | 3 items |
| `summary` | `object` | 6 fields |
| `summary.available_on_page` | `integer` | 5 |
| `summary.continuation_supported` | `boolean` | false |
| `summary.emitted` | `integer` | 5 |
| `summary.upstream_has_more` | `boolean` | false |
| `summary.user_id` | `string` | 528817151 |
| `summary.username` | `string` | nasa |

## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)