# GET /v1/user/highlights: Highlights API

An account's highlights: id, title and cover of each, and the number of stories in it and the date it was made when known (items_count and created_at are null when not). Empty when it has none.

- Call: `GET https://storiesfly.com/api/v1/user/highlights`
- Price **1 request**
- Answers up to **15 minutes** old

## Parameters

All parameters go in the query string.

| Name | Type | Sent | Description |
| --- | --- | --- | --- |
| `username` | string | one of | Instagram username. A leading @ is ignored. Send exactly one of username or id. |
| `id` | string | one of | Numeric Instagram id of the account. Send exactly one of username or id. |
| `cursor` | string | optional | The next_cursor of the page before. Leave it out for the first page. |

## Example request

Put your own key in the header.

### cURL

```bash
curl "https://storiesfly.com/api/v1/user/highlights?username=arianagrande" \
  -H "X-Api-Key: sf_live_your_key"
```

### JavaScript

```javascript
const res = await fetch(
  "https://storiesfly.com/api/v1/user/highlights?username=arianagrande",
  { headers: { "X-Api-Key": process.env.STORIESFLY_KEY } }
);
const data = await res.json();
```

### Python

```python
import os
import requests

r = requests.get(
    "https://storiesfly.com/api/v1/user/highlights",
    params={"username": "arianagrande"},
    headers={"X-Api-Key": os.environ["STORIESFLY_KEY"]},
)
data = r.json()
```

## Example response

200 OK · X-Units-Charged: 1

```json
{
  "user": {
    "id": "7719696",
    "username": "arianagrande"
  },
  "highlights": [
    {
      "id": "18103599704256781",
      "title": "｡˚ ♡",
      "cover_url": "https://scontent-ord5-2.cdninstagram.com/v/t51.71878-15/809450273_1103403688775264_8171408473185393758_n.jpg",
      "items_count": 82,
      "created_at": 1789616670,
      "created_at_iso": "2026-09-17T03:44:30.000Z"
    },
    {
      "id": "18395317474207519",
      "title": "∞",
      "cover_url": "https://scontent-ord5-2.cdninstagram.com/v/t51.71878-15/825324547_916327151322715_5436175684733082081_n.jpg",
      "items_count": 26,
      "created_at": 1790447346,
      "created_at_iso": "2026-09-26T18:29:06.000Z"
    }
  ],
  "next_cursor": "c1.ryg6VkAgkE2BcPyGM0q6ADwLG1KAGWvXyxXcleap6rtdnm6USXXD4rRRujLUjticHxS2vixe2jbdlG4LggGvIE1ISp6sYLXI6XWcb66UIrM_RMPDKCUhQylnCgNoMsPrfzM",
  "has_more": true
}
```

A real answer, shortened: lists are cut to two items and long texts to 160 characters.

## Price and freshness

A call takes 1 request. Free requests are spent first, then your balance. The [pricing](https://storiesfly.com/developers/pricing) page has the rates.

Answers are kept for up to 15 minutes. Asking again inside that time returns the same answer and takes 1 request again.

Page size follows Instagram and varies by endpoint.

## Errors

A failed call answers with an HTTP status and a body `{error, code}`. These are the codes this endpoint gives. [Errors and what is charged](https://storiesfly.com/developers/docs#errors) covers all of them.

| Status | Code | When |
| --- | --- | --- |
| `400` | `bad_request` | A parameter is missing or wrong, or not exactly one of `username` or `id` was sent. `fields` lists the names. Free. |
| `401` | `unauthorized` | The `X-Api-Key` header is missing or the key is wrong. Free. |
| `402` | `credits_exhausted` | The free requests and the balance are used up. Top up in the [dashboard](https://storiesfly.com/developers/dashboard). Free. |
| `403` | `telegram_required` | The account behind the key is not linked to Telegram. The answer has a `link_url` to do it. Free. |
| `403` | `private_account` | The account is private. Charged like an answer. |
| `404` | `not_found` | The account does not exist. Charged like an answer. |
| `429` | `rate_limited` | More requests in a second than your level allows. Wait for the `Retry-After` header. Free. |
| `500` | `internal_error` | A fault on our side. Retry shortly. Refunded. |
| `503` | `upstream_unavailable` | Our side failed or timed out. Retry shortly. Refunded. |

## Questions about this endpoint

### How do I get the stories inside a highlight?

This list gives the `id`, `title` and cover of each highlight. Send an `id` to [highlight](https://storiesfly.com/developers/docs/highlight) to get every story in it.

### Why are items_count and created_at sometimes null?

Instagram does not give them for every highlight. A value it does not give is `null`, not 0.

### What if the account has no highlights?

`highlights` is an empty list and the call takes 1 request. Use `cursor` only when `has_more` is `true`.

## Related endpoints

- [GET /v1/highlight](https://storiesfly.com/developers/docs/highlight): Every story in a highlight, by link or id
- [GET /v1/user/stories](https://storiesfly.com/developers/docs/user-stories): Stories live now, with the length of each video
- [GET /v1/user/profile](https://storiesfly.com/developers/docs/user-profile): Profile with verified badge, bio, link and counts

## Links

- [This page on the site](https://storiesfly.com/developers/docs/user-highlights)
- [Instagram data API](https://storiesfly.com/developers): what the API is and what it returns
- [Pricing](https://storiesfly.com/developers/pricing): rates, examples and billing rules
- [Documentation](https://storiesfly.com/developers/docs): quick start, authentication, errors and every endpoint
- [OpenAPI file](https://storiesfly.com/openapi.json): the whole API in one file
- [API dashboard](https://storiesfly.com/developers/dashboard): get a key and top up
- [Changelog](https://storiesfly.com/developers/changelog): what changed and when