Social Fetch
Instagram

Get Instagram highlight

Get stories from a saved Instagram highlight.

Operation

GET/v1/instagram/highlights/{highlightId}
Cost: 1 credit

Headers

x-api-keystringrequired(header)

API key (`sfk_...`)

Parameters

highlightIdstringrequired

Numeric Instagram highlight id from a highlight URL.

pattern: ^\d+$

Response fields

data
objectrequired

Endpoint-specific response payload.

datalookupStatus
stringrequired

Whether the highlight was resolved: found when metadata and story items are available, or not_found when the highlight does not exist or cannot be accessed.

one of: found, not_found

datahighlight
objectrequirednullable

Highlight metadata when found.

datahighlightid
stringrequired

Instagram highlight id.

min 1 chars

datahighlighttitle
stringrequirednullable

Highlight title when available.

datahighlightcreatedAt
integerrequirednullable

Unix timestamp when the highlight was created, when available.

datahighlightlatestItemAt
integerrequirednullable

Unix timestamp of the latest story item in the highlight, when available.

datahighlightmediaCount
integerrequirednullable

Number of story items reported for the highlight.

≥ 0

datahighlightcover
objectrequirednullable

Highlight cover image when available.

datahighlightcovermediaId
string

Instagram media id for the cover.

datahighlightcoverurl
stringnullable

Cover image URL.

datahighlightcoverwidth
integernullable

Cover image width in pixels when available.

≥ 0

datahighlightcoverheight
integernullable

Cover image height in pixels when available.

≥ 0

datahighlightowner
objectrequirednullable

Highlight owner when available.

datahighlightownerplatformUserId
string

Instagram numeric user id.

datahighlightownerhandle
string

Instagram username without a leading @.

min 1 chars

datahighlightownerfullName
stringnullable

Display name when available.

datahighlightownerverified
boolean

Whether the account is verified.

datahighlightowneravatarUrl
stringnullable

Profile picture URL when available.

datahighlightownerprivateAccount
boolean

Whether the account is private when known.

dataitems
arrayrequired

Story items in the highlight when found. Empty when `lookupStatus` is `not_found`.

dataitems[]id
stringrequired

Instagram story item id.

min 1 chars

dataitems[]mediaId
string

Instagram media id when distinct from the item id.

dataitems[]mediaType
stringrequired

Normalized story media type.

one of: image, video, unknown

dataitems[]takenAt
integerrequirednullable

Unix timestamp when the story item was taken, when available.

dataitems[]displayUrl
stringnullable

Primary image URL when available.

dataitems[]thumbnailUrl
stringnullable

Thumbnail image URL when available.

dataitems[]videoUrl
stringnullable

Direct video URL when available.

dataitems[]videoDurationSec
numbernullable

Video duration in seconds when available.

≥ 0

dataitems[]hasAudio
booleannullable

Whether the video item has audio when known.

dataitems[]dimensions
object

Story media dimensions when available.

dataitems[]dimensionswidth
integerrequired

Media width in pixels.

≥ 0

dataitems[]dimensionsheight
integerrequired

Media height in pixels.

≥ 0

dataitems[]linkStickers
array

Link stickers attached to the story item when available.

dataitems[]linkStickers[]url
string

Link destination URL.

min 1 chars

dataitems[]linkStickers[]displayUrl
string

Human-readable link label when available.

min 1 chars

meta
objectrequired

Metadata describing the request and billing outcome.

metarequestId
stringrequired

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integerrequired

Credits charged for this request.

≥ 0

metaversion
stringrequired

Public API version that served the response.

one of: v1

Code example

Responses

Highlight details (found or not found in body).

Error codes

bad_requestinsufficient_creditsinternal_errorlookup_failedtemporarily_unavailableunauthorized

On this page