API Documentation

Instagram Highlights API

List public highlight collection IDs, names and covers; Story contents are not included.

Test API

List public highlight collection IDs, names and covers; Story contents are not included.

Open product page and API Tester

Endpoint and authentication

POST https://api.goanyapi.com/api/v1/instagram/user/highlights

Results return synchronously, without tasks or polling. Authenticate using Authorization: Bearer YOUR_API_KEY and send a JSON request body. There are no Path or Query parameters.

Input parameters

ParameterLocationTypeRequiredDefaultConstraints and meaning
AuthorizationHeaderstringYesโ€”Bearer YOUR_API_KEY
Content-TypeHeaderstringYesapplication/jsonapplication/json
usernameJSON bodystringYesโ€”Username, @username or full Instagram profile URL, optionally ending in /reels/ or /tagged/. URL parsing is local and adds no separate charge. Short links and other resource types are unsupported. maxLength=2048

Use the same resource parameter for a raw identifier or supported full resource URL; no prerequisite ID lookup is needed. URL parsing adds no request or separate charge. Short links and other resource types are unsupported.

Username, @username or full Instagram profile URL, optionally ending in /reels/ or /tagged/. URL parsing is local and adds no separate charge. Short links and other resource types are unsupported.

Request example

POST /api/v1/instagram/user/highlights
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "username": "https://www.instagram.com/instagram/"
}

Output fields

Success returns HTTP 200. Business results are in data.result. Null, empty strings, empty arrays and missing business fields are preserved; zero is a valid statistic. Empty display fields do not invalidate an otherwise successful request.

FieldTypeMeaning
codestringok on success; error code otherwise
messagestringStatus message
data.resultobject / nullBusiness data; null is preserved
data.creditsUsedintegerCredits charged using current configuration
data.remainingCreditsnumberBalance after settlement
data.result.usernamestringPublic business field; may be null, empty or absent
data.result.highlightsarrayRecords in this response
data.result.highlights[].idstringPublic business field; may be null, empty or absent
data.result.highlights[].titlestringPublic business field; may be null, empty or absent
data.result.highlights[].coverstringPublic business field; may be null, empty or absent
data.result.countintegerCount returned in this response, not a platform-wide total

This endpoint has no pagination parameters.

Real response example

Saved from a real successful response with public business fields. The example omits live data.creditsUsed and data.remainingCredits, which use current configuration and account balance. No list records are omitted. Media URLs may expire. Displaying the example sends no request or charge.

{
  "code": "ok",
  "message": "ok",
  "data": {
    "result": {
      "username": "instagram",
      "count": 7,
      "highlights": [
        {
          "id": "18142207969557132",
          "title": "creatives",
          "cover": "https://scontent-lga3-2.cdninstagram.com/v/t51.71878-15/756661521_3289512177887855_4009891805420027177_n.jpg?stp=dst-jpg_s150x150_tt6&_nc_cat=1&ccb=7-5&_nc_sid=acbce5&_nc_ohc=vxrwz-_XiHMQ7kNvwHNtU5P&_nc_oc=AdpCnaaIFbn_adTAcwAbPRBAQZ3akLLaO3WxaW-xKobRQDDfidcPICoHQh4IA9P54YE&_nc_zt=23&_nc_ht=scontent-lga3-2.cdninstagram.com&_nc_gid=xbeSfuS1PJ2fspWORs4Atw&_nc_ss=7fa8c&oh=00_AQRgG53CUGeGHag5RlRsydIHRWQuRIxk_5SnE56_KMYmEw&oe=6B0069D7"
        },
        {
          "id": "18032893448824228",
          "title": "๐ŸŽพ๐Ÿ€โšฝ๏ธ",
          "cover": "https://scontent-lga3-2.cdninstagram.com/v/t51.82787-15/575724433_18680673526001321_5945490939444494882_n.jpg?stp=c0.5x0.5f_dst-jpg_e35_p150x150_tt6_u&_nc_cat=1&ccb=7-5&_nc_sid=18de74&efg=eyJlZmdfdGFnIjoiU1RPUlkuYmVzdF9pbWFnZV91cmxnZW4uQzMifQ%3D%3D&_nc_ohc=1Pjv167aEE8Q7kNvwH4r3P2&_nc_oc=Adro1bnvxbWdE6m3ZVV-1jZ6EnkHB_JDFa_1K4isOrlS0LOCaqXKjcKE0uIdNswf7iI&_nc_zt=23&_nc_ht=scontent-lga3-2.cdninstagram.com&_nc_gid=xbeSfuS1PJ2fspWORs4Atw&_nc_ss=7fa8c&_nc_ct=RQosPBUKFQIAAAA&oh=00_AQRo-UheCT0uhfwdizDY-Oo54T0HoTv9VuYu54sBBqJT2Q&oe=6B007949"
        },
        {
          "id": "18612622252018257",
          "title": "๐ŸŽค๐ŸŽถ๐ŸŽธ",
          "cover": "https://scontent-lga3-2.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=igSFmvc0wB0Q7kNvwEPkZtx&_nc_oc=AdoZq-T1R42VPfW5E4BXX5bmaHlpS8uyqVNEWOe_AMAKVcaAfwEpjS81rNjWdeMyE44&_nc_zt=23&_nc_ht=scontent-lga3-2.cdninstagram.com&_nc_gid=xbeSfuS1PJ2fspWORs4Atw&_nc_ss=7fa8c&oh=00_AQQf3ZspFkzmUGx2joUncmMYgpHfsjWfs0cLE1g-3PoB1Q&oe=6B006AAF"
        },
        {
          "id": "18029499352961095",
          "title": "whatโ€™s new",
          "cover": "https://scontent-lga3-2.cdninstagram.com/v/t51.71878-15/755331856_1609699020573638_4426177467586352650_n.jpg?stp=dst-jpg_s150x150_tt6&_nc_cat=1&ccb=7-5&_nc_sid=acbce5&_nc_ohc=T-MIH3VDRDAQ7kNvwFKPlfn&_nc_oc=AdpQi6nr9XyjLEPx50k60REXmw7dP6pE0dmabjd21u5i5h0wxu7PsjBy9CruAJoCm7g&_nc_zt=23&_nc_ht=scontent-lga3-2.cdninstagram.com&_nc_gid=xbeSfuS1PJ2fspWORs4Atw&_nc_ss=7fa8c&oh=00_AQS80fbNh9bIESZkjWCInedCrgaKhzLUEdP-Wx3GQyNLxg&oe=6B005EF3"
        },
        {
          "id": "18223279177302854",
          "title": "close friends",
          "cover": "https://scontent-lga3-2.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=l981QBSTlAgQ7kNvwHK4QeF&_nc_oc=AdqAYDlFD_t732xxWd8sOHjmWbkKXNmFIgkK6XoihhNAHQfx5k8_cVmH4qSKEepDmb0&_nc_zt=23&_nc_ht=scontent-lga3-2.cdninstagram.com&_nc_gid=xbeSfuS1PJ2fspWORs4Atw&_nc_ss=7fa8c&oh=00_AQTsX8OjbleTTqC1i701u7IzTuBsgfG29fvyTLBFUDvQDA&oe=6B00667E"
        },
        {
          "id": "18125969650775954",
          "title": "๐Ÿš—๐Ÿš—๐Ÿš—",
          "cover": "https://scontent-lga3-1.cdninstagram.com/v/t51.71878-15/775233495_1033957092733525_6010470506239881158_n.jpg?stp=dst-jpg_s150x150_tt6&_nc_cat=105&_nc_map=urlgen_bucketless&ccb=7-5&_nc_sid=acbce5&_nc_ohc=ItGmn4Ry2GkQ7kNvwFNt0PL&_nc_oc=AdpppLefUBSeHcvZ34jM3YIMmBPda8woEMlPeOajs4AfItNsWaidlB5ygZA53OUMH60&_nc_zt=23&_nc_ht=scontent-lga3-1.cdninstagram.com&_nc_gid=xbeSfuS1PJ2fspWORs4Atw&_nc_ss=7fa8c&oh=00_AQRX3pQBfrnqrX42Uz7bCdNg77EJQ1ScBfU7XWNob65hig&oe=6B0066B9"
        },
        {
          "id": "18194686561332120",
          "title": "๐ŸŽฅ๐ŸŒŸ๐Ÿฟ",
          "cover": "https://scontent-lga3-1.cdninstagram.com/v/t51.71878-15/755264526_1764587937905767_5811150211834945970_n.jpg?stp=dst-jpg_s150x150_tt6&_nc_cat=107&_nc_map=urlgen_bucketless&ccb=7-5&_nc_sid=acbce5&_nc_ohc=NSpW5CwpckkQ7kNvwFRwG0K&_nc_oc=Adr6pafme4TxUKxuvExRoSQ8Q-u2jQIqC93bo1x5m9Hw0LTCd7FLp7kqtiIekKeXE54&_nc_zt=23&_nc_ht=scontent-lga3-1.cdninstagram.com&_nc_gid=xbeSfuS1PJ2fspWORs4Atw&_nc_ss=7fa8c&oh=00_AQRr0-iQGm7jCO_jkgSg1nrCaq7SN4UNDXixDkcInxEPmA&oe=6B007A39"
        }
      ]
    }
  }
}

Billing

With the current configuration, each successful request costs 1 credit.

Every successful request, including empty results, is settled at the current database-configured rate. Failures are free. Sufficient balance is required before querying; insufficient balance during concurrent settlement returns 402 without delivering unsettled results. URL parsing adds no separate charge.

Status codes and errors

HTTPMeaning
200Success, including empty results
400Invalid JSON or parameters
401Invalid authentication
402Insufficient credits
429Rate limit; wait for Retry-After
502Data request failed
503API or pricing not configured
{"code":"invalid_params","message":"Invalid parameter"}