User Highlights

GET/v1/instagram/user/highlights1 credit

Lists an account's story highlights with their ids, titles and cover images.

01Query parameters

Name	Type	Description
user_idoptional	string	Numeric Instagram user id. Either `user_id` or `handle` is required. When both are given, `handle` is used.
handleoptional	string	Instagram username (a leading `@` or a profile URL also works). Either `user_id` or `handle` is required.

02Request

curl "https://api.scrapesocial.ai/v1/instagram/user/highlights?handle=instagram" \
  -H "x-api-key: $SCRAPESOCIAL_KEY"

03Responses

Real answers from the API. Lists are shortened to 2 items.

GET /v1/instagram/user/highlights?handle=instagram

{
  "success": true,
  "credits_remaining": 4980,
  "credits_charged": 1,
  "highlights": [
    {
      "__typename": "GraphHighlightReel",
      "id": "18223279177302854",
      "cover_media": {
        "thumbnail_src": "https://scontent.cdninstagram.com/v/t51.71878-15/756700225_1653985762331725_8429300849500507026_n.jpg?stp=dst-jpg_s150x150_tt6&_nc_cat=1&ccb=7-5&_nc_sid=acbce5&_nc_ohc=NLBVWHHV_vYQ7kNvwGGHwEx&_nc_oc=Adr3uvS5WO6OWrlMO1Qc3iycVnoudR5bTJg4n_AEDPI9Y-Dkk2QSXDFJKux_stJvlv8&_nc_zt=23&_nc_ht=scontent.cdninstagram.com&_nc_gid=GYMcAKoGsz0FnwnRbre5Xw&_nc_ss=7b689&oh=00_AQOFtNfOMv67J7CwkLWiN4HTZzBmLB8O71S7-Q-L…"
      },
      "cover_media_cropped_thumbnail": {
        "url": "https://scontent.cdninstagram.com/v/t51.71878-15/756700225_1653985762331725_8429300849500507026_n.jpg?stp=dst-jpg_s150x150_tt6&_nc_cat=1&ccb=7-5&_nc_sid=acbce5&_nc_ohc=NLBVWHHV_vYQ7kNvwGGHwEx&_nc_oc=Adr3uvS5WO6OWrlMO1Qc3iycVnoudR5bTJg4n_AEDPI9Y-Dkk2QSXDFJKux_stJvlv8&_nc_zt=23&_nc_ht=scontent.cdninstagram.com&_nc_gid=GYMcAKoGsz0FnwnRbre5Xw&_nc_ss=7b689&oh=00_AQOFtNfOMv67J7CwkLWiN4HTZzBmLB8O71S7-Q-L…"
      },
      "owner": {
        "__typename": "GraphUser",
        "id": "25025320",
        "profile_pic_url": "https://scontent.cdninstagram.com/v/t51.82787-19/550891366_18667771684001321_1383210656577177067_n.jpg?stp=dst-jpg_s150x150_tt6&_nc_cat=1&ccb=7-5&_nc_sid=f7ccc5&efg=eyJ2ZW5jb2RlX3RhZyI6InByb2ZpbGVfcGljLnd3dy4xMDgwLkMzIn0%3D&_nc_ohc=HyKV99xb1PwQ7kNvwFIkHCV&_nc_oc=AdpqW7T_F0jW_XB4Je8jF0eWGWAqcsQpcPLykkxWpz9IzPVja1ImLWcMMlVBt_DZAaA&_nc_zt=24&_nc_ht=scontent.cdninstagram.com&_nc_gid=GYMcAKoGsz0FnwnRbr…",
        "username": "instagram"
      },
      "title": "close friends"
    },
    {
      "__typename": "GraphHighlightReel",
      "id": "18612622252018257",
      "cover_media": {
        "thumbnail_src": "https://scontent.cdninstagram.com/v/t51.71878-15/755867844_1751720619182762_5430881549273743299_n.jpg?stp=dst-jpg_s150x150_tt6&_nc_cat=1&ccb=7-5&_nc_sid=acbce5&_nc_ohc=SmUVvSate6sQ7kNvwHZgjzW&_nc_oc=Adp2fAk_7EmplsYCQydDVJqnz1SE8xPb0IseBEJmtER6NOWdetuMuaQXbo0ZoEiBA_4&_nc_zt=23&_nc_ht=scontent.cdninstagram.com&_nc_gid=GYMcAKoGsz0FnwnRbre5Xw&_nc_ss=7b689&oh=00_AQOcQAmvIVXcX3aMDwNSbG4eBN6mTBtEDA_ogMiN…"
      },
      "cover_media_cropped_thumbnail": {
        "url": "https://scontent.cdninstagram.com/v/t51.71878-15/755867844_1751720619182762_5430881549273743299_n.jpg?stp=dst-jpg_s150x150_tt6&_nc_cat=1&ccb=7-5&_nc_sid=acbce5&_nc_ohc=SmUVvSate6sQ7kNvwHZgjzW&_nc_oc=Adp2fAk_7EmplsYCQydDVJqnz1SE8xPb0IseBEJmtER6NOWdetuMuaQXbo0ZoEiBA_4&_nc_zt=23&_nc_ht=scontent.cdninstagram.com&_nc_gid=GYMcAKoGsz0FnwnRbre5Xw&_nc_ss=7b689&oh=00_AQOcQAmvIVXcX3aMDwNSbG4eBN6mTBtEDA_ogMiN…"
      },
      "owner": {
        "__typename": "GraphUser",
        "id": "25025320",
        "profile_pic_url": "https://scontent.cdninstagram.com/v/t51.82787-19/550891366_18667771684001321_1383210656577177067_n.jpg?stp=dst-jpg_s150x150_tt6&_nc_cat=1&ccb=7-5&_nc_sid=f7ccc5&efg=eyJ2ZW5jb2RlX3RhZyI6InByb2ZpbGVfcGljLnd3dy4xMDgwLkMzIn0%3D&_nc_ohc=HyKV99xb1PwQ7kNvwFIkHCV&_nc_oc=AdpqW7T_F0jW_XB4Je8jF0eWGWAqcsQpcPLykkxWpz9IzPVja1ImLWcMMlVBt_DZAaA&_nc_zt=24&_nc_ht=scontent.cdninstagram.com&_nc_gid=GYMcAKoGsz0FnwnRbr…",
        "username": "instagram"
      },
      "title": "🎤🎶🎸"
    }
  ]
}

Common to every endpoint

Any route can answer these: a missing or wrong key, no credits left, the platform not answering, or a failure on our side. None of them costs credits.

GET /v1/cosmos/profile?handle=design

{
  "success": false,
  "message": "Invalid API key"
}

04Notes

Highlights are in `highlights`; use an id with User Highlight Detail to get its stories. The cover image is the small square crop. An account without highlights is an empty list for 0 credits. A private or age-restricted account is a free 403, an unknown one a free 404. A `user_id` whose account has never posted a reel cannot be resolved and is answered as unknown.

05Errors & credits

Every error has success: false, a real HTTP status and costs no credits.

400missing_parameter
A required parameter is missing or invalid.
403private_account
The account is private or age-restricted.
404not_found
No such account.
503upstream_error
The platform did not answer; retry shortly.