Instagram API Capability

Get saved highlight items

Retrieves bounded public saved story items for a collection returned by highlights.list, with owner identity and truthful truncation metadata.

Capability ID instagram.highlights.items.get

Cost From $1.25 per 1,000 requests · 1 credit

Maximum runtime 120 seconds

View raw

# Get saved highlight items

Retrieves bounded public saved story items for a collection returned by highlights.list, with owner identity and truthful truncation metadata.

- Platform: [Instagram](https://docs.upscrape.com/docs/platforms/instagram)
- Capability ID: `instagram.highlights.items.get`
- 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 $UPSCRAPE_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "collection_id": "18195781759377100",
    "limit": 10,
    "username": "nasa"
  },
  "capability": "instagram.highlights.items.get"
}'
```

## Input


| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `collection_id` | `string` | Yes | Collection identifier. |
| `limit` | `integer` | No | Maximum number of results to return. From 1 to 100. Default: `100`. |
| `username` | `string` | Yes |  |

### Example input

```json
{
  "collection_id": "18195781759377100",
  "limit": 10,
  "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 example shows one response. Values and optional fields vary with the data available.

```json
{
  "items": [
    {
      "id": "3975089864169193671_528817151",
      "media_id": "3975089864169193671",
      "media_type": 2,
      "media_url": "https://example.invalid/reviewed-public-media.jpg",
      "taken_at": 1788087653
    }
  ],
  "summary": {
    "available_on_page": 1,
    "collection_id": "18195781759377100",
    "continuation_supported": false,
    "emitted": 1,
    "owner_id": "528817151",
    "owner_username": "nasa",
    "truncated": false
  }
}
```
### 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` | 1 items |
| `items` | `array` | 1 items |
| `summary` | `object` | 7 fields |
| `summary.available_on_page` | `integer` | 1 |
| `summary.collection_id` | `string` | 18195781759377100 |
| `summary.continuation_supported` | `boolean` | false |
| `summary.emitted` | `integer` | 1 |
| `summary.owner_id` | `string` | 528817151 |
| `summary.owner_username` | `string` | nasa |
| `summary.truncated` | `boolean` | false |

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

POST /execute Shared execution endpoint

Input parameters

collection_id string required

Collection identifier.

Example 18195781759377100

limit integer optional

Maximum number of results to return. From 1 to 100. Default: `100`.

Example 10

username string required

Example 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 The example response is shown in the response panel.

Illustrative output fields

Values illustrate one response. Read the guidance above for missing values and limits; fields can vary with the requested operation and the data available.

Path	Observed type	Example
`items`	`array`	1 items
`items`	`array`	1 items
`summary`	`object`	7 fields
`summary.available_on_page`	`integer`	1
`summary.collection_id`	`string`	18195781759377100
`summary.continuation_supported`	`boolean`	false
`summary.emitted`	`integer`	1
`summary.owner_id`	`string`	528817151
`summary.owner_username`	`string`	nasa
`summary.truncated`	`boolean`	false

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "collection_id": "18195781759377100", "limit": 10, "username": "nasa" }, "capability": "instagram.highlights.items.get" }'

import json import os import requests payload = json.loads(r'''{ "input": { "collection_id": "18195781759377100", "limit": 10, "username": "nasa" }, "capability": "instagram.highlights.items.get" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))

{ "items": [ { "id": "3975089864169193671_528817151", "media_id": "3975089864169193671", "media_type": 2, "media_url": "https://example.invalid/reviewed-public-media.jpg", "taken_at": 1788087653 } ], "summary": { "available_on_page": 1, "collection_id": "18195781759377100", "continuation_supported": false, "emitted": 1, "owner_id": "528817151", "owner_username": "nasa", "truncated": false } }