Instagram

Highlight

A story highlight and every story in it: their images, videos and times.

GET/v1/instagram/highlights1 credit

Headers

Get your API key

x-api-key*stringrequiredheader

Your API key, made in the dashboard.

Parameters

highlight_idstringoptionalquery

A highlight's id: the digits in its link, or an id from the profile highlights endpoint. Give highlight_id or url.

example: 17975319242920589

urlstringoptionalquery

A highlight's link: instagram.com/stories/highlights/<id>. Give highlight_id or url.

max 300 chars

Response fields

dataobject

The result: one object, or a list for the endpoints that return several.

data.idstring

The highlight's id: digits, for the highlights endpoint.

data.urlstring

Its link.

data.titlestringnullable

Its title.

data.coverstringnullable

Its cover image's link. It is signed, and expires after a while.

data.ownerstringnullable

Its owner's handle.

data.storiesarray

The stories in it, in order.

data.stories[].idstring

Instagram's id for the story.

data.stories[].typestringnullable

image or video.

data.stories[].imagestringnullable

Its image, or a video's cover. The link is signed, and expires after a while.

data.stories[].video_urlstringnullable

A video's file. The link is signed, and expires after a while.

data.stories[].duration_secondsnumbernullable

A video's length, in seconds.

data.stories[].widthintegernullable

Its width, in pixels.

data.stories[].heightintegernullable

Its height, in pixels.

data.stories[].created_atstringnullable

When it was posted.

format: date-time

pageobjectnullable

Paging, for the endpoints that page; null for the others.

page.next_cursorstringnullable

Send it as the cursor parameter, with the same other parameters, for the next page. Null on the last page.

page.has_morebooleanoptional

Whether another page follows.

default: false

metaobject

About this call.

meta.platformstring

The platform: reddit, threads, tiktok or youtube.

meta.endpointstring

The endpoint's name, such as channel_videos.

meta.paramsobject

The call's parameters, defaults included. Parameters without a value, and the cursor, are left out.

meta.request_idstring

This call's id. Quote it when you report a problem.

meta.api_versionstring

The API version that answered.

meta.fetched_atstring

When the data was fetched from the platform (UTC).

format: date-time

meta.cachedbooleanoptional

Whether it came from our cache; fetched_at says how old it is.

default: false

Code example

curl -X GET 'https://api.socialparse.dev/v1/instagram/highlights?highlight_id=17975319242920589' \  -H 'x-api-key: YOUR_API_KEY'

Responses

Successful Response

{  "data": {    "id": "string",    "url": "string",    "title": "string",    "cover": "string",    "owner": "string",    "stories": [      {        "id": "string",        "type": "string",        "image": "string",        "video_url": "string",        "duration_seconds": 0,        "width": 0,        "height": 0,        "created_at": "2019-08-24T14:15:22Z"      }    ]  },  "page": {    "next_cursor": "string",    "has_more": false  },  "meta": {    "platform": "string",    "endpoint": "string",    "params": {      "property1": "string",      "property2": "string"    },    "request_id": "string",    "api_version": "string",    "fetched_at": "2019-08-24T14:15:22Z",    "cached": false  }}

Profile highlights

A profile's story highlights: their titles and covers. Get a highlight's stories from the highlights endpoint. A private account answers LOGIN_REQUIRED.

Location

A place: its name, category, post count, coordinates and address.