> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bridgly.app/llms.txt
> Use this file to discover all available pages before exploring further.

# List profile highlights

> List saved story highlights on a public Instagram profile, including highlight IDs, titles and cover images. Use a highlight ID with the highlight endpoint to retrieve its stories. Continue with nextCursor. Costs 1 credit per result returned, with a minimum of 1 credit per request.



## OpenAPI

````yaml /openapi.json post /instagram/highlights
openapi: 3.1.0
info:
  title: Bridgly API
  description: >-
    Web scraping API for LinkedIn, X (Twitter), Reddit, GitHub, Instagram and
    TikTok. Authenticated endpoints accept a Bridgly API key (`bgly_…`) via
    `Authorization: Bearer <token>`.
  version: 1.0.0
servers:
  - url: https://api.bridgly.app
    description: Production
security: []
tags:
  - name: LinkedIn
    description: Scrape LinkedIn profiles, companies, posts, and search.
  - name: Reddit
    description: Scrape Reddit posts, subreddits, users, and search.
  - name: X (Twitter)
    description: Scrape tweets and search X.
  - name: GitHub
    description: >-
      Fetch GitHub profiles, pinned repos, contributions, repositories, stars,
      and projects via GitHub's GraphQL API.
  - name: Instagram
    description: Scrape Instagram profiles, posts, followers, and search.
  - name: TikTok
    description: Fetch TikTok profiles.
paths:
  /instagram/highlights:
    post:
      tags:
        - Instagram
      summary: List profile highlights
      description: >-
        List saved story highlights on a public Instagram profile, including
        highlight IDs, titles and cover images. Use a highlight ID with the
        highlight endpoint to retrieve its stories. Continue with nextCursor.
        Costs 1 credit per result returned, with a minimum of 1 credit per
        request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                  minLength: 1
                  description: >-
                    Instagram username, or the profile link, e.g. "instagram" or
                    "https://www.instagram.com/instagram/"
                count:
                  default: 10
                  description: Number of results to return (1–10). Defaults to 10.
                  type: integer
                  minimum: 1
                  maximum: 10
                cursor:
                  description: >-
                    The previous response's `nextCursor`, to fetch the next
                    page. Omit it for the first page.
                  type: string
              required:
                - username
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  timeMs:
                    type: number
                    description: >-
                      Wall-clock time the request took to complete, in
                      milliseconds.
                  creditsCost:
                    type: number
                    description: Number of account credits this request consumed.
                  data:
                    type: object
                    properties:
                      nextCursor:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: >-
                          Pass as `cursor` to fetch the next page; null when
                          there are no more results. A page can hold fewer
                          results than asked for, so keep paging until it is
                          null.
                      highlights:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Highlight ID. Pass this to getHighlight.
                            title:
                              anyOf:
                                - type: string
                                - type: 'null'
                            cover_url:
                              anyOf:
                                - type: string
                                - type: 'null'
                            owner_id:
                              anyOf:
                                - type: string
                                - type: 'null'
                            owner:
                              anyOf:
                                - type: object
                                  properties:
                                    id:
                                      type: string
                                    username:
                                      anyOf:
                                        - type: string
                                        - type: 'null'
                                    full_name:
                                      anyOf:
                                        - type: string
                                        - type: 'null'
                                    profile_pic_url:
                                      anyOf:
                                        - type: string
                                        - type: 'null'
                                    is_private:
                                      anyOf:
                                        - type: boolean
                                        - type: 'null'
                                    is_verified:
                                      anyOf:
                                        - type: boolean
                                        - type: 'null'
                                    profile_pic_id:
                                      anyOf:
                                        - type: string
                                        - type: 'null'
                                    latest_reel_media:
                                      description: >-
                                        Latest story publish time as Unix
                                        seconds; zero means no recent story.
                                      anyOf:
                                        - type: number
                                        - type: 'null'
                                    is_mentionable:
                                      anyOf:
                                        - type: boolean
                                        - type: 'null'
                                  required:
                                    - id
                                  additionalProperties: false
                                - type: 'null'
                            latest_story_at:
                              description: Latest story publish time as Unix seconds.
                              anyOf:
                                - type: number
                                - type: 'null'
                            username:
                              anyOf:
                                - type: string
                                - type: 'null'
                            url:
                              type: string
                          required:
                            - id
                            - url
                          additionalProperties: false
                    required:
                      - nextCursor
                      - highlights
                    additionalProperties: false
                required:
                  - timeMs
                  - creditsCost
                  - data
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '402':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '422':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                  message:
                    type: string
                    description: Human-readable description of what went wrong.
                required:
                  - status
                  - message
                additionalProperties: false
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: typescript
          label: Bridgly SDK
          source: |-
            import { Bridgly } from '@bridgly/sdk';

            const client = new Bridgly({ apiKey: process.env.BRIDGLY_API_KEY });

            const res = await client.instagram.getHighlights({
              username: "string",
              count: 10,
            });
            if (res.type === 'success') console.log(res.data);
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Bridgly API key (`bgly_…`). Metered endpoints deduct credits from the
        resolved account.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.