openapi: 3.0.0
paths:
  /raw/ig/search:
    get:
      operationId: InstagramRawController_search
      summary: Search
      description: Search for users and hashtags.
      parameters:
        - name: keyword
          required: true
          in: query
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        position:
                          type: number
                        user:
                          type: object
                          properties:
                            pk:
                              type: string
                            is_verified:
                              default: false
                              type: boolean
                            profile_pic_url:
                              type: string
                            username:
                              type: string
                            full_name:
                              type: string
                            is_private:
                              default: false
                              type: boolean
                          required:
                            - pk
                            - username
                        hashtag:
                          type: object
                          properties:
                            name:
                              type: string
                            id:
                              type: number
                            media_count:
                              type: number
                            search_result_subtitle:
                              type: string
                          required:
                            - name
                            - id
                            - media_count
                            - search_result_subtitle
                      required:
                        - position
                required:
                  - list
      tags:
        - Instagram Raw Data
      security:
        - accessToken: []
  /raw/ig/user-info:
    get:
      operationId: InstagramRawController_userInfo
      summary: User Info
      description: Get details about the user profile
      parameters:
        - name: url
          required: true
          in: query
          description: Username (@handle) or user id
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                properties:
                  pk:
                    type: string
                  biography:
                    type: string
                  category:
                    type: string
                  external_url:
                    type: string
                  bio_links:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        lynx_url:
                          type: string
                        url:
                          type: string
                        link_type:
                          type: string
                      required:
                        - title
                        - lynx_url
                        - url
                        - link_type
                  fb_profile_biolink:
                    anyOf:
                      - type: 'null'
                      - type: object
                        properties:
                          url:
                            type: string
                          name:
                            type: string
                        required:
                          - url
                          - name
                  follower_count:
                    type: number
                  following_count:
                    type: number
                  full_name:
                    type: string
                  has_channel:
                    type: boolean
                  has_clips:
                    type: boolean
                  has_videos:
                    type: boolean
                  has_guides:
                    type: boolean
                  has_highlight_reels:
                    type: boolean
                  is_business:
                    type: boolean
                  is_private:
                    type: boolean
                  is_verified:
                    type: boolean
                  media_count:
                    type: number
                  profile_pic_url_hd:
                    type: string
                  profile_pic_url:
                    type: string
                  total_igtv_videos:
                    type: number
                  username:
                    type: string
                  address:
                    type: object
                    properties:
                      street_address:
                        type: string
                      city_id:
                        type: number
                      city_name:
                        type: string
                      latitude:
                        type: number
                      longitude:
                        type: number
                      zip_code:
                        type: string
                required:
                  - pk
                  - biography
                  - external_url
                  - follower_count
                  - following_count
                  - full_name
                  - is_business
                  - is_private
                  - is_verified
                  - media_count
                  - profile_pic_url_hd
                  - profile_pic_url
                  - username
                  - address
      tags:
        - Instagram Raw Data
      security:
        - accessToken: []
  /raw/ig/user-feed:
    get:
      operationId: InstagramRawController_userFeed
      summary: User Feed
      description: Get users media feed in a paginated manner. 12 posts on the page.
      parameters:
        - name: url
          required: true
          in: query
          description: Username (@handle) or user id
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `end_cursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        pk:
                          type: string
                        can_viewer_reshare:
                          type: boolean
                        pinned_for_users:
                          type: array
                          items:
                            type: string
                        caption:
                          type: object
                          properties:
                            text:
                              type: string
                        carousel_media_count:
                          type: number
                        carousel_media:
                          type: array
                          items:
                            type: object
                            properties:
                              pk:
                                type: string
                              display_url:
                                type: string
                              has_audio:
                                type: boolean
                              image_versions2:
                                type: object
                                properties:
                                  candidates:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        width:
                                          type: number
                                        height:
                                          type: number
                                        url:
                                          type: string
                                      required:
                                        - width
                                        - height
                                        - url
                                required:
                                  - candidates
                              is_dash_eligible:
                                type: boolean
                              number_of_qualities:
                                type: number
                              video_dash_manifest:
                                anyOf:
                                  - type: 'null'
                                  - type: string
                              video_url:
                                anyOf:
                                  - type: 'null'
                                  - type: string
                            required:
                              - pk
                              - display_url
                              - image_versions2
                        clips_metadata:
                          type: object
                          properties:
                            music_info:
                              anyOf:
                                - type: 'null'
                                - type: object
                                  properties:
                                    music_asset_info:
                                      type: object
                                      properties:
                                        audio_cluster_id:
                                          type: string
                                        display_artist:
                                          type: string
                                        id:
                                          type: string
                                        subtitle:
                                          type: string
                                        title:
                                          type: string
                                      required:
                                        - audio_cluster_id
                        coauthor_producers:
                          type: array
                          items:
                            type: object
                            properties:
                              pk:
                                type: string
                              is_verified:
                                default: false
                                type: boolean
                              profile_pic_url:
                                type: string
                              username:
                                type: string
                            required:
                              - pk
                              - profile_pic_url
                              - username
                        code:
                          type: string
                        comment_count:
                          type: number
                        display_url:
                          anyOf:
                            - type: 'null'
                            - type: string
                        has_audio:
                          type: boolean
                        image_versions2:
                          type: object
                          properties:
                            candidates:
                              type: array
                              items:
                                type: object
                                properties:
                                  width:
                                    type: number
                                  height:
                                    type: number
                                  url:
                                    type: string
                                required:
                                  - width
                                  - height
                                  - url
                          required:
                            - candidates
                        is_dash_eligible:
                          type: boolean
                        like_and_view_counts_disabled:
                          type: boolean
                        like_count:
                          type: number
                        location:
                          type: object
                          properties:
                            pk:
                              type: string
                            address:
                              type: string
                            city:
                              type: string
                            lat:
                              type: number
                            lng:
                              type: number
                            name:
                              type: string
                            profile_pic_url:
                              type: string
                          required:
                            - pk
                        media_type:
                          type: number
                        number_of_qualities:
                          type: number
                        play_count:
                          type: number
                        product_type:
                          anyOf:
                            - const: ad
                              type: string
                            - const: carousel_container
                              type: string
                            - const: carousel_item
                              type: string
                            - const: clips
                              type: string
                            - const: feed
                              type: string
                            - const: igtv
                              type: string
                            - const: story
                              type: string
                        sponsor_tags:
                          type: array
                          items:
                            type: object
                            properties:
                              sponsor:
                                type: object
                                allOf:
                                  - type: object
                                    properties:
                                      pk:
                                        type: string
                                      is_verified:
                                        default: false
                                        type: boolean
                                      profile_pic_url:
                                        type: string
                                      username:
                                        type: string
                                    required:
                                      - pk
                                      - profile_pic_url
                                      - username
                                  - type: object
                                    properties:
                                      full_name:
                                        type: string
                                      is_private:
                                        type: boolean
                                    required:
                                      - full_name
                                      - is_private
                            required:
                              - sponsor
                        taken_at:
                          type: number
                        title:
                          type: string
                        user:
                          type: object
                          properties:
                            pk:
                              type: string
                            username:
                              type: string
                          required:
                            - pk
                            - username
                        usertags:
                          type: object
                          properties:
                            in:
                              type: array
                              items:
                                type: object
                                properties:
                                  user:
                                    type: object
                                    allOf:
                                      - type: object
                                        properties:
                                          pk:
                                            type: string
                                          is_verified:
                                            default: false
                                            type: boolean
                                          profile_pic_url:
                                            type: string
                                          username:
                                            type: string
                                        required:
                                          - pk
                                          - profile_pic_url
                                          - username
                                      - type: object
                                        properties:
                                          full_name:
                                            type: string
                                          is_private:
                                            type: boolean
                                        required:
                                          - full_name
                                          - is_private
                                  position:
                                    type: array
                                    items:
                                      - type: number
                                      - type: number
                                    additionalItems: false
                                    minItems: 2
                                    maxItems: 2
                                required:
                                  - user
                                  - position
                          required:
                            - in
                        video_dash_manifest:
                          anyOf:
                            - type: 'null'
                            - type: string
                        video_duration:
                          type: number
                        video_url:
                          anyOf:
                            - type: 'null'
                            - type: string
                        view_count:
                          type: number
                      required:
                        - pk
                        - caption
                        - code
                        - comment_count
                        - like_count
                        - media_type
                        - product_type
                        - taken_at
                        - user
                  more_available:
                    type: boolean
                  end_cursor:
                    type: string
                required:
                  - items
                  - more_available
                  - end_cursor
      tags:
        - Instagram Raw Data
      security:
        - accessToken: []
  /raw/ig/user-reels:
    get:
      operationId: InstagramRawController_userReels
      summary: User Reels
      description: Get users reels
      parameters:
        - name: url
          required: true
          in: query
          description: Username (@handle) or user id
          schema:
            type: string
        - name: after
          required: true
          in: query
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        pk:
                          type: string
                        can_viewer_reshare:
                          type: boolean
                        pinned_for_users:
                          type: array
                          items:
                            type: string
                        caption:
                          anyOf:
                            - type: 'null'
                            - type: object
                              properties:
                                text:
                                  type: string
                        carousel_media_count:
                          type: number
                        carousel_media:
                          type: array
                          items:
                            type: object
                            properties:
                              pk:
                                type: string
                              display_url:
                                type: string
                              has_audio:
                                type: boolean
                              image_versions2:
                                type: object
                                properties:
                                  candidates:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        width:
                                          type: number
                                        height:
                                          type: number
                                        url:
                                          type: string
                                      required:
                                        - width
                                        - height
                                        - url
                                required:
                                  - candidates
                              is_dash_eligible:
                                type: boolean
                              number_of_qualities:
                                type: number
                              video_dash_manifest:
                                anyOf:
                                  - type: 'null'
                                  - type: string
                              video_url:
                                anyOf:
                                  - type: 'null'
                                  - type: string
                            required:
                              - pk
                              - display_url
                              - image_versions2
                        clips_metadata:
                          type: object
                          properties:
                            music_info:
                              anyOf:
                                - type: 'null'
                                - type: object
                                  properties:
                                    music_asset_info:
                                      type: object
                                      properties:
                                        audio_cluster_id:
                                          type: string
                                        display_artist:
                                          type: string
                                        id:
                                          type: string
                                        subtitle:
                                          type: string
                                        title:
                                          type: string
                                      required:
                                        - audio_cluster_id
                        coauthor_producers:
                          type: array
                          items:
                            type: object
                            properties:
                              pk:
                                type: string
                              is_verified:
                                default: false
                                type: boolean
                              profile_pic_url:
                                type: string
                              username:
                                type: string
                            required:
                              - pk
                              - profile_pic_url
                              - username
                        code:
                          type: string
                        comment_count:
                          type: number
                        display_url:
                          anyOf:
                            - type: 'null'
                            - type: string
                        has_audio:
                          type: boolean
                        image_versions2:
                          type: object
                          properties:
                            candidates:
                              type: array
                              items:
                                type: object
                                properties:
                                  width:
                                    type: number
                                  height:
                                    type: number
                                  url:
                                    type: string
                                required:
                                  - width
                                  - height
                                  - url
                          required:
                            - candidates
                        is_dash_eligible:
                          type: string
                        like_and_view_counts_disabled:
                          type: boolean
                        like_count:
                          type: number
                        location:
                          anyOf:
                            - type: 'null'
                            - type: object
                              properties:
                                pk:
                                  type: string
                                address:
                                  type: string
                                city:
                                  type: string
                                lat:
                                  type: number
                                lng:
                                  type: number
                                name:
                                  type: string
                                profile_pic_url:
                                  type: string
                              required:
                                - pk
                        media_type:
                          type: number
                        number_of_qualities:
                          type: number
                        play_count:
                          anyOf:
                            - type: 'null'
                            - type: number
                        product_type:
                          anyOf:
                            - const: ad
                              type: string
                            - const: carousel_container
                              type: string
                            - const: carousel_item
                              type: string
                            - const: clips
                              type: string
                            - const: feed
                              type: string
                            - const: igtv
                              type: string
                            - const: story
                              type: string
                        sponsor_tags:
                          anyOf:
                            - type: 'null'
                            - type: array
                              items:
                                type: object
                                properties:
                                  sponsor:
                                    type: object
                                    properties:
                                      pk:
                                        type: string
                                      username:
                                        type: string
                                    required:
                                      - pk
                                      - username
                                required:
                                  - sponsor
                        taken_at:
                          anyOf:
                            - type: string
                            - type: number
                        title:
                          anyOf:
                            - type: 'null'
                            - type: string
                        user:
                          type: object
                          properties:
                            pk:
                              type: string
                            is_verified:
                              default: false
                              type: boolean
                            profile_pic_url:
                              type: string
                            username:
                              type: string
                            full_name:
                              type: string
                            is_private:
                              default: false
                              type: boolean
                          required:
                            - pk
                            - username
                        usertags:
                          type: object
                          properties:
                            in:
                              type: array
                              items:
                                type: object
                                properties:
                                  user:
                                    type: object
                                    allOf:
                                      - type: object
                                        properties:
                                          pk:
                                            type: string
                                          is_verified:
                                            default: false
                                            type: boolean
                                          profile_pic_url:
                                            type: string
                                          username:
                                            type: string
                                        required:
                                          - pk
                                          - profile_pic_url
                                          - username
                                      - type: object
                                        properties:
                                          full_name:
                                            type: string
                                          is_private:
                                            type: boolean
                                        required:
                                          - full_name
                                          - is_private
                                  position:
                                    type: array
                                    items:
                                      - type: number
                                      - type: number
                                    additionalItems: false
                                    minItems: 2
                                    maxItems: 2
                                required:
                                  - user
                                  - position
                          required:
                            - in
                        video_dash_manifest:
                          anyOf:
                            - type: 'null'
                            - type: string
                        video_duration:
                          type: number
                        video_url:
                          anyOf:
                            - type: 'null'
                            - type: string
                        view_count:
                          type: number
                      required:
                        - pk
                        - code
                        - comment_count
                        - like_count
                        - media_type
                        - product_type
                        - taken_at
                        - user
                  more_available:
                    type: boolean
                  end_cursor:
                    type: string
                required:
                  - items
                  - more_available
                  - end_cursor
      tags:
        - Instagram Raw Data
      security:
        - accessToken: []
  /raw/ig/user-tags-feed:
    get:
      operationId: InstagramRawController_userTagsFeed
      summary: User Tags Feed
      description: Get users tags feed
      parameters:
        - name: url
          required: true
          in: query
          description: Username (@handle) or user id
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `end_cursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        pk:
                          type: string
                        can_viewer_reshare:
                          type: boolean
                        pinned_for_users:
                          type: array
                          items:
                            type: string
                        caption:
                          anyOf:
                            - type: 'null'
                            - type: object
                              properties:
                                text:
                                  type: string
                        carousel_media_count:
                          type: number
                        carousel_media:
                          type: array
                          items:
                            type: object
                            properties:
                              pk:
                                type: string
                              display_url:
                                type: string
                              has_audio:
                                type: boolean
                              image_versions2:
                                type: object
                                properties:
                                  candidates:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        width:
                                          type: number
                                        height:
                                          type: number
                                        url:
                                          type: string
                                      required:
                                        - width
                                        - height
                                        - url
                                required:
                                  - candidates
                              is_dash_eligible:
                                type: boolean
                              number_of_qualities:
                                type: number
                              video_dash_manifest:
                                anyOf:
                                  - type: 'null'
                                  - type: string
                              video_url:
                                anyOf:
                                  - type: 'null'
                                  - type: string
                            required:
                              - pk
                              - display_url
                              - image_versions2
                        clips_metadata:
                          type: object
                          properties:
                            music_info:
                              anyOf:
                                - type: 'null'
                                - type: object
                                  properties:
                                    music_asset_info:
                                      type: object
                                      properties:
                                        audio_cluster_id:
                                          type: string
                                        display_artist:
                                          type: string
                                        id:
                                          type: string
                                        subtitle:
                                          type: string
                                        title:
                                          type: string
                                      required:
                                        - audio_cluster_id
                        coauthor_producers:
                          type: array
                          items:
                            type: object
                            properties:
                              pk:
                                type: string
                              is_verified:
                                default: false
                                type: boolean
                              profile_pic_url:
                                type: string
                              username:
                                type: string
                            required:
                              - pk
                              - profile_pic_url
                              - username
                        code:
                          type: string
                        comment_count:
                          type: number
                        display_url:
                          anyOf:
                            - type: 'null'
                            - type: string
                        has_audio:
                          type: boolean
                        image_versions2:
                          type: object
                          properties:
                            candidates:
                              type: array
                              items:
                                type: object
                                properties:
                                  width:
                                    type: number
                                  height:
                                    type: number
                                  url:
                                    type: string
                                required:
                                  - width
                                  - height
                                  - url
                          required:
                            - candidates
                        is_dash_eligible:
                          type: string
                        like_and_view_counts_disabled:
                          type: boolean
                        like_count:
                          type: number
                        location:
                          anyOf:
                            - type: 'null'
                            - type: object
                              properties:
                                pk:
                                  type: string
                                address:
                                  type: string
                                city:
                                  type: string
                                lat:
                                  type: number
                                lng:
                                  type: number
                                name:
                                  type: string
                                profile_pic_url:
                                  type: string
                              required:
                                - pk
                        media_type:
                          type: number
                        number_of_qualities:
                          type: number
                        play_count:
                          anyOf:
                            - type: 'null'
                            - type: number
                        product_type:
                          anyOf:
                            - const: ad
                              type: string
                            - const: carousel_container
                              type: string
                            - const: carousel_item
                              type: string
                            - const: clips
                              type: string
                            - const: feed
                              type: string
                            - const: igtv
                              type: string
                            - const: story
                              type: string
                        sponsor_tags:
                          anyOf:
                            - type: 'null'
                            - type: array
                              items:
                                type: object
                                properties:
                                  sponsor:
                                    type: object
                                    properties:
                                      pk:
                                        type: string
                                      username:
                                        type: string
                                    required:
                                      - pk
                                      - username
                                required:
                                  - sponsor
                        taken_at:
                          anyOf:
                            - type: string
                            - type: number
                        title:
                          anyOf:
                            - type: 'null'
                            - type: string
                        user:
                          type: object
                          properties:
                            pk:
                              type: string
                            is_verified:
                              default: false
                              type: boolean
                            profile_pic_url:
                              type: string
                            username:
                              type: string
                            full_name:
                              type: string
                            is_private:
                              default: false
                              type: boolean
                          required:
                            - pk
                            - username
                        usertags:
                          type: object
                          properties:
                            in:
                              type: array
                              items:
                                type: object
                                properties:
                                  user:
                                    type: object
                                    allOf:
                                      - type: object
                                        properties:
                                          pk:
                                            type: string
                                          is_verified:
                                            default: false
                                            type: boolean
                                          profile_pic_url:
                                            type: string
                                          username:
                                            type: string
                                        required:
                                          - pk
                                          - profile_pic_url
                                          - username
                                      - type: object
                                        properties:
                                          full_name:
                                            type: string
                                          is_private:
                                            type: boolean
                                        required:
                                          - full_name
                                          - is_private
                                  position:
                                    type: array
                                    items:
                                      - type: number
                                      - type: number
                                    additionalItems: false
                                    minItems: 2
                                    maxItems: 2
                                required:
                                  - user
                                  - position
                          required:
                            - in
                        video_dash_manifest:
                          anyOf:
                            - type: 'null'
                            - type: string
                        video_duration:
                          type: number
                        video_url:
                          anyOf:
                            - type: 'null'
                            - type: string
                        view_count:
                          type: number
                      required:
                        - pk
                        - code
                        - comment_count
                        - like_count
                        - media_type
                        - product_type
                        - taken_at
                        - user
                  more_available:
                    type: boolean
                  end_cursor:
                    type: string
                required:
                  - items
                  - more_available
                  - end_cursor
      tags:
        - Instagram Raw Data
      security:
        - accessToken: []
  /raw/ig/hashtag-feed:
    get:
      operationId: InstagramRawController_hashtagFeed
      summary: Hashtag Feed
      description: Get hashtag feed
      parameters:
        - name: hashtag
          required: true
          in: query
          schema:
            type: string
        - name: type
          required: false
          in: query
          description: >-
            Type of feed to return. Recent posts (`recent`) or Top posts
            (`top`).
          schema:
            default: recent
            enum:
              - recent
              - top
            type: string
        - name: after
          required: false
          in: query
          description: Use `end_cursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        pk:
                          type: string
                        can_viewer_reshare:
                          type: boolean
                        pinned_for_users:
                          type: array
                          items:
                            type: string
                        caption:
                          anyOf:
                            - type: 'null'
                            - type: object
                              properties:
                                text:
                                  type: string
                        carousel_media_count:
                          type: number
                        carousel_media:
                          type: array
                          items:
                            type: object
                            properties:
                              pk:
                                type: string
                              display_url:
                                type: string
                              has_audio:
                                type: boolean
                              image_versions2:
                                type: object
                                properties:
                                  candidates:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        width:
                                          type: number
                                        height:
                                          type: number
                                        url:
                                          type: string
                                      required:
                                        - width
                                        - height
                                        - url
                                required:
                                  - candidates
                              is_dash_eligible:
                                type: boolean
                              number_of_qualities:
                                type: number
                              video_dash_manifest:
                                anyOf:
                                  - type: 'null'
                                  - type: string
                              video_url:
                                anyOf:
                                  - type: 'null'
                                  - type: string
                            required:
                              - pk
                              - display_url
                              - image_versions2
                        clips_metadata:
                          type: object
                          properties:
                            music_info:
                              anyOf:
                                - type: 'null'
                                - type: object
                                  properties:
                                    music_asset_info:
                                      type: object
                                      properties:
                                        audio_cluster_id:
                                          type: string
                                        display_artist:
                                          type: string
                                        id:
                                          type: string
                                        subtitle:
                                          type: string
                                        title:
                                          type: string
                                      required:
                                        - audio_cluster_id
                        coauthor_producers:
                          type: array
                          items:
                            type: object
                            properties:
                              pk:
                                type: string
                              is_verified:
                                default: false
                                type: boolean
                              profile_pic_url:
                                type: string
                              username:
                                type: string
                            required:
                              - pk
                              - profile_pic_url
                              - username
                        code:
                          type: string
                        comment_count:
                          type: number
                        display_url:
                          anyOf:
                            - type: 'null'
                            - type: string
                        has_audio:
                          type: boolean
                        image_versions2:
                          type: object
                          properties:
                            candidates:
                              type: array
                              items:
                                type: object
                                properties:
                                  width:
                                    type: number
                                  height:
                                    type: number
                                  url:
                                    type: string
                                required:
                                  - width
                                  - height
                                  - url
                          required:
                            - candidates
                        is_dash_eligible:
                          type: string
                        like_and_view_counts_disabled:
                          type: boolean
                        like_count:
                          type: number
                        location:
                          anyOf:
                            - type: 'null'
                            - type: object
                              properties:
                                pk:
                                  type: string
                                address:
                                  type: string
                                city:
                                  type: string
                                lat:
                                  type: number
                                lng:
                                  type: number
                                name:
                                  type: string
                                profile_pic_url:
                                  type: string
                              required:
                                - pk
                        media_type:
                          type: number
                        number_of_qualities:
                          type: number
                        play_count:
                          anyOf:
                            - type: 'null'
                            - type: number
                        product_type:
                          anyOf:
                            - const: ad
                              type: string
                            - const: carousel_container
                              type: string
                            - const: carousel_item
                              type: string
                            - const: clips
                              type: string
                            - const: feed
                              type: string
                            - const: igtv
                              type: string
                            - const: story
                              type: string
                        sponsor_tags:
                          anyOf:
                            - type: 'null'
                            - type: array
                              items:
                                type: object
                                properties:
                                  sponsor:
                                    type: object
                                    properties:
                                      pk:
                                        type: string
                                      username:
                                        type: string
                                    required:
                                      - pk
                                      - username
                                required:
                                  - sponsor
                        taken_at:
                          anyOf:
                            - type: string
                            - type: number
                        title:
                          anyOf:
                            - type: 'null'
                            - type: string
                        user:
                          type: object
                          properties:
                            pk:
                              type: string
                            is_verified:
                              default: false
                              type: boolean
                            profile_pic_url:
                              type: string
                            username:
                              type: string
                            full_name:
                              type: string
                            is_private:
                              default: false
                              type: boolean
                          required:
                            - pk
                            - username
                        usertags:
                          type: object
                          properties:
                            in:
                              type: array
                              items:
                                type: object
                                properties:
                                  user:
                                    type: object
                                    allOf:
                                      - type: object
                                        properties:
                                          pk:
                                            type: string
                                          is_verified:
                                            default: false
                                            type: boolean
                                          profile_pic_url:
                                            type: string
                                          username:
                                            type: string
                                        required:
                                          - pk
                                          - profile_pic_url
                                          - username
                                      - type: object
                                        properties:
                                          full_name:
                                            type: string
                                          is_private:
                                            type: boolean
                                        required:
                                          - full_name
                                          - is_private
                                  position:
                                    type: array
                                    items:
                                      - type: number
                                      - type: number
                                    additionalItems: false
                                    minItems: 2
                                    maxItems: 2
                                required:
                                  - user
                                  - position
                          required:
                            - in
                        video_dash_manifest:
                          anyOf:
                            - type: 'null'
                            - type: string
                        video_duration:
                          type: number
                        video_url:
                          anyOf:
                            - type: 'null'
                            - type: string
                        view_count:
                          type: number
                      required:
                        - pk
                        - code
                        - comment_count
                        - like_count
                        - media_type
                        - product_type
                        - taken_at
                        - user
                  more_available:
                    type: boolean
                  end_cursor:
                    type: string
                required:
                  - items
                  - more_available
                  - end_cursor
      tags:
        - Instagram Raw Data
      security:
        - accessToken: []
  /raw/ig/media-info:
    get:
      operationId: InstagramRawController_mediaInfo
      summary: Media Info
      description: Get media info
      parameters:
        - name: code
          required: true
          in: query
          description: >-
            Instagram post shortcode (digits and letters after
            https://www.instagram.com/p/)
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        pk:
                          type: string
                        can_viewer_reshare:
                          type: boolean
                        pinned_for_users:
                          type: array
                          items:
                            type: string
                        caption:
                          anyOf:
                            - type: 'null'
                            - type: object
                              properties:
                                text:
                                  type: string
                        carousel_media_count:
                          type: number
                        carousel_media:
                          type: array
                          items:
                            type: object
                            properties:
                              pk:
                                type: string
                              display_url:
                                type: string
                              has_audio:
                                type: boolean
                              image_versions2:
                                type: object
                                properties:
                                  candidates:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        width:
                                          type: number
                                        height:
                                          type: number
                                        url:
                                          type: string
                                      required:
                                        - width
                                        - height
                                        - url
                                required:
                                  - candidates
                              is_dash_eligible:
                                type: boolean
                              number_of_qualities:
                                type: number
                              video_dash_manifest:
                                anyOf:
                                  - type: 'null'
                                  - type: string
                              video_url:
                                anyOf:
                                  - type: 'null'
                                  - type: string
                            required:
                              - pk
                              - display_url
                              - image_versions2
                        clips_metadata:
                          type: object
                          properties:
                            music_info:
                              anyOf:
                                - type: 'null'
                                - type: object
                                  properties:
                                    music_asset_info:
                                      type: object
                                      properties:
                                        audio_cluster_id:
                                          type: string
                                        display_artist:
                                          type: string
                                        id:
                                          type: string
                                        subtitle:
                                          type: string
                                        title:
                                          type: string
                                      required:
                                        - audio_cluster_id
                        coauthor_producers:
                          type: array
                          items:
                            type: object
                            properties:
                              pk:
                                type: string
                              is_verified:
                                default: false
                                type: boolean
                              profile_pic_url:
                                type: string
                              username:
                                type: string
                            required:
                              - pk
                              - profile_pic_url
                              - username
                        code:
                          type: string
                        comment_count:
                          type: number
                        display_url:
                          anyOf:
                            - type: 'null'
                            - type: string
                        has_audio:
                          type: boolean
                        image_versions2:
                          type: object
                          properties:
                            candidates:
                              type: array
                              items:
                                type: object
                                properties:
                                  width:
                                    type: number
                                  height:
                                    type: number
                                  url:
                                    type: string
                                required:
                                  - width
                                  - height
                                  - url
                          required:
                            - candidates
                        is_dash_eligible:
                          type: string
                        like_and_view_counts_disabled:
                          type: boolean
                        like_count:
                          type: number
                        location:
                          anyOf:
                            - type: 'null'
                            - type: object
                              properties:
                                pk:
                                  type: string
                                address:
                                  type: string
                                city:
                                  type: string
                                lat:
                                  type: number
                                lng:
                                  type: number
                                name:
                                  type: string
                                profile_pic_url:
                                  type: string
                              required:
                                - pk
                        media_type:
                          type: number
                        number_of_qualities:
                          type: number
                        play_count:
                          anyOf:
                            - type: 'null'
                            - type: number
                        product_type:
                          anyOf:
                            - const: ad
                              type: string
                            - const: carousel_container
                              type: string
                            - const: carousel_item
                              type: string
                            - const: clips
                              type: string
                            - const: feed
                              type: string
                            - const: igtv
                              type: string
                            - const: story
                              type: string
                        sponsor_tags:
                          anyOf:
                            - type: 'null'
                            - type: array
                              items:
                                type: object
                                properties:
                                  sponsor:
                                    type: object
                                    properties:
                                      pk:
                                        type: string
                                      username:
                                        type: string
                                    required:
                                      - pk
                                      - username
                                required:
                                  - sponsor
                        taken_at:
                          anyOf:
                            - type: string
                            - type: number
                        title:
                          anyOf:
                            - type: 'null'
                            - type: string
                        user:
                          type: object
                          properties:
                            pk:
                              type: string
                            is_verified:
                              default: false
                              type: boolean
                            profile_pic_url:
                              type: string
                            username:
                              type: string
                            full_name:
                              type: string
                            is_private:
                              default: false
                              type: boolean
                          required:
                            - pk
                            - username
                        usertags:
                          type: object
                          properties:
                            in:
                              type: array
                              items:
                                type: object
                                properties:
                                  user:
                                    type: object
                                    allOf:
                                      - type: object
                                        properties:
                                          pk:
                                            type: string
                                          is_verified:
                                            default: false
                                            type: boolean
                                          profile_pic_url:
                                            type: string
                                          username:
                                            type: string
                                        required:
                                          - pk
                                          - profile_pic_url
                                          - username
                                      - type: object
                                        properties:
                                          full_name:
                                            type: string
                                          is_private:
                                            type: boolean
                                        required:
                                          - full_name
                                          - is_private
                                  position:
                                    type: array
                                    items:
                                      - type: number
                                      - type: number
                                    additionalItems: false
                                    minItems: 2
                                    maxItems: 2
                                required:
                                  - user
                                  - position
                          required:
                            - in
                        video_dash_manifest:
                          anyOf:
                            - type: 'null'
                            - type: string
                        video_duration:
                          type: number
                        video_url:
                          anyOf:
                            - type: 'null'
                            - type: string
                        view_count:
                          type: number
                      required:
                        - pk
                        - code
                        - comment_count
                        - like_count
                        - media_type
                        - product_type
                        - taken_at
                        - user
                required:
                  - items
      tags:
        - Instagram Raw Data
      security:
        - accessToken: []
  /raw/ig/media-comments:
    get:
      operationId: InstagramRawController_commentFeed
      summary: Media Comments
      description: Get media comments
      parameters:
        - name: code
          required: true
          in: query
          description: >-
            Instagram post shortcode (digits and letters after
            https://www.instagram.com/p/)
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `end_cursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  comments_disabled:
                    type: boolean
                  comments:
                    type: array
                    items:
                      type: object
                      properties:
                        pk:
                          type: string
                        user:
                          type: object
                          properties:
                            pk:
                              type: string
                            is_verified:
                              default: false
                              type: boolean
                            profile_pic_url:
                              type: string
                            username:
                              type: string
                            full_name:
                              type: string
                            is_private:
                              default: false
                              type: boolean
                          required:
                            - pk
                            - username
                        created_at:
                          type: number
                        text:
                          type: string
                        comment_like_count:
                          type: number
                        child_comment_count:
                          type: number
                      required:
                        - pk
                        - user
                        - created_at
                        - text
                        - comment_like_count
                        - child_comment_count
                  comment_count:
                    type: number
                  more_available:
                    type: boolean
                  end_cursor:
                    type: string
                required:
                  - comments_disabled
                  - comments
                  - comment_count
                  - more_available
                  - end_cursor
      tags:
        - Instagram Raw Data
      security:
        - accessToken: []
  /raw/ig/media-comment-replies:
    get:
      operationId: InstagramRawController_childCommentFeed
      summary: Media Comment Replies
      description: Get comment replies
      parameters:
        - name: code
          required: true
          in: query
          description: >-
            Instagram post shortcode (digits and letters after
            https://www.instagram.com/p/)
          schema:
            type: string
        - name: comment_id
          required: true
          in: query
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `end_cursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  child_comments:
                    type: array
                    items:
                      type: object
                      properties:
                        pk:
                          type: string
                        user:
                          type: object
                          properties:
                            pk:
                              type: string
                            is_verified:
                              default: false
                              type: boolean
                            profile_pic_url:
                              type: string
                            username:
                              type: string
                            full_name:
                              type: string
                            is_private:
                              default: false
                              type: boolean
                          required:
                            - pk
                            - username
                        created_at:
                          type: number
                        text:
                          type: string
                        comment_like_count:
                          type: number
                        child_comment_count:
                          type: number
                      required:
                        - pk
                        - user
                        - created_at
                        - text
                        - comment_like_count
                        - child_comment_count
                  more_available:
                    type: boolean
                  end_cursor:
                    type: string
                required:
                  - child_comments
                  - more_available
                  - end_cursor
      tags:
        - Instagram Raw Data
      security:
        - accessToken: []
  /raw/ig/audio-info:
    get:
      operationId: InstagramRawController_audioInfo
      summary: Audio Info
      description: Get audio info and feed. Similar to searching by original audio.
      parameters:
        - name: url
          required: true
          in: query
          description: >-
            Instagram reel audio full url or identifier (digits and letters
            after https://www.instagram.com/reels/audio/)
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `end_cursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    additionalProperties: true
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            media:
                              type: object
                              properties:
                                taken_at:
                                  type: integer
                                pk:
                                  anyOf:
                                    - type: string
                                    - type: number
                                id:
                                  type: string
                                fbid:
                                  type: string
                                device_timestamp:
                                  anyOf:
                                    - type: number
                                    - type: string
                                caption_is_edited:
                                  type: boolean
                                strong_id__:
                                  type: string
                                deleted_reason:
                                  type: integer
                                has_shared_to_fb:
                                  type: integer
                                has_delayed_metadata:
                                  type: boolean
                                view_state_item_type:
                                  type: integer
                                logging_info_token:
                                  type: string
                                mezql_token:
                                  type: string
                                share_count_disabled:
                                  type: boolean
                                is_visual_reply_commenter_notice_enabled:
                                  type: boolean
                                like_and_view_counts_disabled:
                                  type: boolean
                                is_post_live_clips_media:
                                  type: boolean
                                clips_delivery_parameters:
                                  type: object
                                  properties: {}
                                comment_threading_enabled:
                                  type: boolean
                                is_unified_video:
                                  type: boolean
                                has_privately_liked:
                                  type: boolean
                                commerciality_status:
                                  type: string
                                filter_type:
                                  type: integer
                                client_cache_key:
                                  type: string
                                integrity_review_decision:
                                  type: string
                                should_request_ads:
                                  type: boolean
                                is_reshare_of_text_post_app_media_in_ig:
                                  type: boolean
                                usertags:
                                  type: object
                                  properties:
                                    in:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          categories:
                                            type: 'null'
                                          duration_in_video_in_sec:
                                            type: 'null'
                                          position:
                                            type: array
                                            items:
                                              - type: number
                                              - type: number
                                            additionalItems: false
                                            minItems: 2
                                            maxItems: 2
                                          show_category_of_user:
                                            type: boolean
                                          start_time_in_video_in_sec:
                                            type: 'null'
                                          user:
                                            additionalProperties: true
                                            type: object
                                            properties:
                                              pk:
                                                anyOf:
                                                  - type: string
                                                  - type: number
                                              pk_id:
                                                type: string
                                              full_name:
                                                type: string
                                              is_private:
                                                type: boolean
                                              id:
                                                type: string
                                              strong_id__:
                                                type: string
                                              username:
                                                type: string
                                              is_verified:
                                                type: boolean
                                              profile_pic_id:
                                                type: string
                                              profile_pic_url:
                                                type: string
                                              friendship_status:
                                                type: object
                                                properties:
                                                  blocking:
                                                    type: boolean
                                                  followed_by:
                                                    type: boolean
                                                  following:
                                                    type: boolean
                                                  incoming_request:
                                                    type: boolean
                                                  is_bestie:
                                                    type: boolean
                                                  is_feed_favorite:
                                                    type: boolean
                                                  is_private:
                                                    type: boolean
                                                  is_restricted:
                                                    type: boolean
                                                  muting:
                                                    type: boolean
                                                  outgoing_request:
                                                    type: boolean
                                photo_of_you:
                                  type: boolean
                                can_see_insights_as_brand:
                                  type: boolean
                                media_type:
                                  type: integer
                                code:
                                  type: string
                                caption: {}
                                fundraiser_tag:
                                  type: object
                                  properties:
                                    has_standalone_fundraiser:
                                      type: boolean
                                sharing_friction_info:
                                  type: object
                                  properties:
                                    should_have_sharing_friction:
                                      type: boolean
                                    bloks_app_url:
                                      anyOf:
                                        - type: 'null'
                                        - type: string
                                    sharing_friction_payload:
                                      anyOf:
                                        - type: 'null'
                                        - type: string
                                  required:
                                    - should_have_sharing_friction
                                    - bloks_app_url
                                    - sharing_friction_payload
                                play_count:
                                  type: number
                                fb_play_count:
                                  type: number
                                original_media_has_visual_reply_media:
                                  type: boolean
                                creator_viewer_insights:
                                  type: array
                                  items: {}
                                fb_user_tags:
                                  type: object
                                  properties:
                                    in:
                                      type: array
                                      items: {}
                                  required:
                                    - in
                                coauthor_producers:
                                  type: array
                                  items: {}
                                invited_coauthor_producers:
                                  type: array
                                  items: {}
                                is_in_profile_grid:
                                  type: boolean
                                profile_grid_control_enabled:
                                  type: boolean
                                media_cropping_info:
                                  type: object
                                  properties:
                                    square_crop:
                                      type: object
                                      properties:
                                        crop_left:
                                          anyOf:
                                            - type: number
                                            - type: string
                                        crop_right:
                                          anyOf:
                                            - type: number
                                            - type: string
                                        crop_top:
                                          anyOf:
                                            - type: number
                                            - type: string
                                        crop_bottom:
                                          anyOf:
                                            - type: number
                                            - type: string
                                      required:
                                        - crop_left
                                        - crop_right
                                        - crop_top
                                        - crop_bottom
                                  required:
                                    - square_crop
                                user:
                                  type: object
                                  properties:
                                    fbid_v2:
                                      type: string
                                    feed_post_reshare_disabled:
                                      type: boolean
                                    full_name:
                                      type: string
                                    id:
                                      type: string
                                    is_private:
                                      type: boolean
                                    is_unpublished:
                                      type: boolean
                                    pk:
                                      anyOf:
                                        - type: string
                                        - type: number
                                    pk_id:
                                      type: string
                                    show_account_transparency_details:
                                      type: boolean
                                    strong_id__:
                                      type: string
                                    third_party_downloads_enabled:
                                      type: integer
                                    account_badges:
                                      type: array
                                      items: {}
                                    fan_club_info:
                                      type: object
                                      properties:
                                        autosave_to_exclusive_highlight:
                                          anyOf:
                                            - type: 'null'
                                            - type: boolean
                                        connected_member_count:
                                          anyOf:
                                            - type: 'null'
                                            - type: number
                                        fan_club_id:
                                          anyOf:
                                            - type: 'null'
                                            - type: string
                                            - type: number
                                        fan_club_name:
                                          anyOf:
                                            - type: 'null'
                                            - type: string
                                        has_enough_subscribers_for_ssc:
                                          anyOf:
                                            - type: 'null'
                                            - type: boolean
                                        is_fan_club_gifting_eligible:
                                          anyOf:
                                            - type: 'null'
                                            - type: boolean
                                        is_fan_club_referral_eligible:
                                          anyOf:
                                            - type: 'null'
                                            - type: boolean
                                        subscriber_count:
                                          anyOf:
                                            - type: 'null'
                                            - type: number
                                        fan_consideration_page_revamp_eligiblity:
                                          anyOf:
                                            - type: 'null'
                                            - {}
                                      required:
                                        - autosave_to_exclusive_highlight
                                        - connected_member_count
                                        - fan_club_id
                                        - fan_club_name
                                        - has_enough_subscribers_for_ssc
                                        - is_fan_club_gifting_eligible
                                        - is_fan_club_referral_eligible
                                        - subscriber_count
                                        - fan_consideration_page_revamp_eligiblity
                                    friendship_status:
                                      type: object
                                      properties:
                                        following:
                                          type: boolean
                                        is_bestie:
                                          type: boolean
                                        is_feed_favorite:
                                          type: boolean
                                        is_restricted:
                                          type: boolean
                                      required:
                                        - following
                                        - is_bestie
                                        - is_feed_favorite
                                        - is_restricted
                                    has_anonymous_profile_picture:
                                      type: boolean
                                    is_favorite:
                                      type: boolean
                                    is_verified:
                                      type: boolean
                                    profile_pic_id:
                                      type: string
                                    profile_pic_url:
                                      type: string
                                    transparency_product_enabled:
                                      type: boolean
                                    username:
                                      type: string
                                    latest_reel_media:
                                      type: integer
                                    eligible_for_text_app_activation_badge:
                                      type: boolean
                                  required:
                                    - feed_post_reshare_disabled
                                    - is_unpublished
                                    - pk
                                    - pk_id
                                    - show_account_transparency_details
                                    - strong_id__
                                    - third_party_downloads_enabled
                                    - account_badges
                                    - fan_club_info
                                    - has_anonymous_profile_picture
                                    - is_verified
                                    - profile_pic_url
                                    - transparency_product_enabled
                                    - username
                                    - eligible_for_text_app_activation_badge
                                owner:
                                  type: object
                                  properties:
                                    fbid_v2:
                                      type: string
                                    feed_post_reshare_disabled:
                                      type: boolean
                                    full_name:
                                      type: string
                                    id:
                                      type: string
                                    is_private:
                                      type: boolean
                                    is_unpublished:
                                      type: boolean
                                    pk:
                                      anyOf:
                                        - type: string
                                        - type: number
                                    pk_id:
                                      type: string
                                    show_account_transparency_details:
                                      type: boolean
                                    strong_id__:
                                      type: string
                                    third_party_downloads_enabled:
                                      type: integer
                                    account_badges:
                                      type: array
                                      items: {}
                                    fan_club_info:
                                      type: object
                                      properties:
                                        autosave_to_exclusive_highlight:
                                          anyOf:
                                            - type: 'null'
                                            - type: boolean
                                        connected_member_count:
                                          anyOf:
                                            - type: 'null'
                                            - type: number
                                        fan_club_id:
                                          anyOf:
                                            - type: 'null'
                                            - type: string
                                            - type: number
                                        fan_club_name:
                                          anyOf:
                                            - type: 'null'
                                            - type: string
                                        has_enough_subscribers_for_ssc:
                                          anyOf:
                                            - type: 'null'
                                            - type: boolean
                                        is_fan_club_gifting_eligible:
                                          anyOf:
                                            - type: 'null'
                                            - type: boolean
                                        is_fan_club_referral_eligible:
                                          anyOf:
                                            - type: 'null'
                                            - type: boolean
                                        subscriber_count:
                                          anyOf:
                                            - type: 'null'
                                            - type: number
                                        fan_consideration_page_revamp_eligiblity:
                                          anyOf:
                                            - type: 'null'
                                            - {}
                                      required:
                                        - autosave_to_exclusive_highlight
                                        - connected_member_count
                                        - fan_club_id
                                        - fan_club_name
                                        - has_enough_subscribers_for_ssc
                                        - is_fan_club_gifting_eligible
                                        - is_fan_club_referral_eligible
                                        - subscriber_count
                                        - fan_consideration_page_revamp_eligiblity
                                    friendship_status:
                                      type: object
                                      properties:
                                        following:
                                          type: boolean
                                        is_bestie:
                                          type: boolean
                                        is_feed_favorite:
                                          type: boolean
                                        is_restricted:
                                          type: boolean
                                      required:
                                        - following
                                        - is_bestie
                                        - is_feed_favorite
                                        - is_restricted
                                    has_anonymous_profile_picture:
                                      type: boolean
                                    is_favorite:
                                      type: boolean
                                    is_verified:
                                      type: boolean
                                    profile_pic_id:
                                      type: string
                                    profile_pic_url:
                                      type: string
                                    transparency_product_enabled:
                                      type: boolean
                                    username:
                                      type: string
                                    latest_reel_media:
                                      type: integer
                                  required:
                                    - feed_post_reshare_disabled
                                    - full_name
                                    - id
                                    - is_private
                                    - is_unpublished
                                    - pk
                                    - pk_id
                                    - show_account_transparency_details
                                    - strong_id__
                                    - third_party_downloads_enabled
                                    - account_badges
                                    - fan_club_info
                                    - has_anonymous_profile_picture
                                    - is_verified
                                    - profile_pic_url
                                    - transparency_product_enabled
                                    - username
                                image_versions2:
                                  type: object
                                  properties:
                                    candidates:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          width:
                                            type: integer
                                          height:
                                            type: integer
                                          url:
                                            type: string
                                          scans_profile:
                                            type: string
                                        required:
                                          - width
                                          - height
                                          - url
                                    additional_candidates:
                                      type: object
                                      properties:
                                        igtv_first_frame:
                                          type: object
                                          properties:
                                            width:
                                              type: integer
                                            height:
                                              type: integer
                                            url:
                                              type: string
                                            scans_profile:
                                              type: string
                                          required:
                                            - width
                                            - height
                                            - url
                                        first_frame:
                                          type: object
                                          properties:
                                            width:
                                              type: integer
                                            height:
                                              type: integer
                                            url:
                                              type: string
                                            scans_profile:
                                              type: string
                                          required:
                                            - width
                                            - height
                                            - url
                                        smart_frame:
                                          type: 'null'
                                      required:
                                        - igtv_first_frame
                                        - first_frame
                                        - smart_frame
                                    smart_thumbnail_enabled:
                                      type: boolean
                                    animated_thumbnail_spritesheet_info_candidates:
                                      type: object
                                      properties:
                                        default:
                                          type: object
                                          properties:
                                            video_length:
                                              type: number
                                            thumbnail_width:
                                              type: integer
                                            thumbnail_height:
                                              type: integer
                                            thumbnail_duration:
                                              anyOf:
                                                - type: string
                                                - type: number
                                            sprite_urls:
                                              type: array
                                              items:
                                                type: string
                                            thumbnails_per_row:
                                              type: integer
                                            total_thumbnail_num_per_sprite:
                                              type: integer
                                            max_thumbnails_per_sprite:
                                              type: integer
                                            sprite_width:
                                              type: integer
                                            sprite_height:
                                              type: integer
                                            rendered_width:
                                              type: integer
                                            file_size_kb:
                                              type: integer
                                          required:
                                            - video_length
                                            - thumbnail_width
                                            - thumbnail_height
                                            - thumbnail_duration
                                            - sprite_urls
                                            - thumbnails_per_row
                                            - total_thumbnail_num_per_sprite
                                            - max_thumbnails_per_sprite
                                            - sprite_width
                                            - sprite_height
                                            - rendered_width
                                            - file_size_kb
                                  required:
                                    - candidates
                                    - additional_candidates
                                original_width:
                                  type: integer
                                original_height:
                                  type: integer
                                is_artist_pick:
                                  type: boolean
                                enable_media_notes_production:
                                  type: boolean
                                product_type:
                                  type: string
                                is_paid_partnership:
                                  type: boolean
                                inventory_source:
                                  type: string
                                music_metadata:
                                  type: 'null'
                                social_context:
                                  type: array
                                  items: {}
                                organic_tracking_token:
                                  type: string
                                is_third_party_downloads_eligible:
                                  type: boolean
                                ig_media_sharing_disabled:
                                  type: boolean
                                are_remixes_crosspostable:
                                  type: boolean
                                boost_unavailable_identifier:
                                  type: 'null'
                                boost_unavailable_reason:
                                  type: 'null'
                                subscribe_cta_visible:
                                  type: boolean
                                is_cutout_sticker_allowed:
                                  type: boolean
                                is_reuse_allowed:
                                  type: boolean
                                recommendation_data:
                                  type: string
                                gen_ai_detection_method:
                                  type: object
                                  properties:
                                    detection_method:
                                      type: string
                                  required:
                                    - detection_method
                                fb_aggregated_like_count:
                                  type: integer
                                fb_aggregated_comment_count:
                                  type: integer
                                has_high_risk_gen_ai_inform_treatment:
                                  type: boolean
                                open_carousel_show_follow_button:
                                  type: boolean
                                is_tagged_media_shared_to_viewer_profile_grid:
                                  type: boolean
                                should_show_author_pog_for_tagged_media_shared_to_profile_grid:
                                  type: boolean
                                is_eligible_for_media_note_recs_nux:
                                  type: boolean
                                is_social_ufi_disabled:
                                  type: boolean
                                is_eligible_for_meta_ai_share:
                                  type: boolean
                                can_view_more_preview_comments:
                                  type: boolean
                                comment_count:
                                  type: integer
                                hide_view_all_comment_entrypoint:
                                  type: boolean
                                is_comments_gif_composer_enabled:
                                  type: boolean
                                comment_inform_treatment:
                                  type: object
                                  properties:
                                    action_type:
                                      anyOf:
                                        - type: 'null'
                                        - type: string
                                    should_have_inform_treatment:
                                      type: boolean
                                    text:
                                      type: string
                                    url:
                                      anyOf:
                                        - type: 'null'
                                        - type: string
                                  required:
                                    - action_type
                                    - should_have_inform_treatment
                                    - text
                                    - url
                                fb_like_count:
                                  type: integer
                                has_liked:
                                  type: boolean
                                like_count:
                                  type: integer
                                facepile_top_likers:
                                  type: array
                                  items: {}
                                top_likers:
                                  type: array
                                  items: {}
                                is_dash_eligible:
                                  type: integer
                                video_dash_manifest:
                                  type: string
                                video_codec:
                                  type: string
                                number_of_qualities:
                                  type: integer
                                video_versions:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      height:
                                        type: integer
                                      id:
                                        type: string
                                      type:
                                        type: integer
                                      url:
                                        type: string
                                      width:
                                        type: integer
                                    required:
                                      - height
                                      - type
                                      - url
                                      - width
                                video_duration:
                                  type: number
                                has_audio:
                                  type: boolean
                                clips_tab_pinned_user_ids:
                                  type: array
                                  items: {}
                                clips_demotion_control:
                                  type: object
                                  properties:
                                    title:
                                      type: string
                                    enable_word_wrapping:
                                      type: boolean
                                    confirmation_icon:
                                      type: string
                                    title_style:
                                      type: string
                                    confirmation_title:
                                      type: string
                                    confirmation_body:
                                      type: string
                                    confirmation_title_style:
                                      type: string
                                    undo_style:
                                      type: string
                                    confirmation_style:
                                      type: string
                                    followup_options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          text:
                                            type: string
                                          style:
                                            anyOf:
                                              - type: 'null'
                                              - type: string
                                          id:
                                            type: string
                                          data:
                                            anyOf:
                                              - type: 'null'
                                              - type: string
                                          show_icon:
                                            type: boolean
                                          demotion_control:
                                            type: object
                                            properties:
                                              confirmation_style:
                                                type: string
                                              confirmation_icon:
                                                type: string
                                              confirmation_body:
                                                type: string
                                              undo_style:
                                                type: string
                                        required:
                                          - text
                                          - style
                                          - id
                                          - data
                                          - show_icon
                                  required:
                                    - title
                                    - enable_word_wrapping
                                    - confirmation_icon
                                    - title_style
                                    - confirmation_title
                                    - confirmation_body
                                    - confirmation_title_style
                                    - undo_style
                                    - confirmation_style
                                clips_metadata: {}
                                can_viewer_save:
                                  type: boolean
                                can_viewer_reshare:
                                  type: boolean
                                reshare_count:
                                  type: integer
                                shop_routing_user_id:
                                  type: 'null'
                                is_organic_product_tagging_eligible:
                                  type: boolean
                                igbio_product:
                                  type: 'null'
                                product_suggestions:
                                  type: array
                                  items: {}
                                commerce_integrity_review_decision:
                                  type: string
                                has_more_comments:
                                  type: boolean
                                max_num_visible_preview_comments:
                                  type: integer
                                explore_hide_comments:
                                  type: boolean
                                is_open_to_public_submission:
                                  type: boolean
                              required:
                                - taken_at
                                - pk
                                - id
                                - device_timestamp
                                - caption_is_edited
                                - strong_id__
                                - deleted_reason
                                - has_shared_to_fb
                                - has_delayed_metadata
                                - view_state_item_type
                                - logging_info_token
                                - mezql_token
                                - share_count_disabled
                                - is_visual_reply_commenter_notice_enabled
                                - like_and_view_counts_disabled
                                - is_post_live_clips_media
                                - clips_delivery_parameters
                                - has_privately_liked
                                - filter_type
                                - client_cache_key
                                - integrity_review_decision
                                - should_request_ads
                                - is_reshare_of_text_post_app_media_in_ig
                                - can_see_insights_as_brand
                                - media_type
                                - code
                                - caption
                                - sharing_friction_info
                                - play_count
                                - fb_user_tags
                                - invited_coauthor_producers
                                - is_in_profile_grid
                                - profile_grid_control_enabled
                                - media_cropping_info
                                - user
                                - owner
                                - image_versions2
                                - original_width
                                - original_height
                                - is_artist_pick
                                - enable_media_notes_production
                                - product_type
                                - is_paid_partnership
                                - inventory_source
                                - music_metadata
                                - organic_tracking_token
                                - is_third_party_downloads_eligible
                                - ig_media_sharing_disabled
                                - are_remixes_crosspostable
                                - boost_unavailable_identifier
                                - boost_unavailable_reason
                                - subscribe_cta_visible
                                - is_cutout_sticker_allowed
                                - gen_ai_detection_method
                                - fb_aggregated_like_count
                                - fb_aggregated_comment_count
                                - has_high_risk_gen_ai_inform_treatment
                                - open_carousel_show_follow_button
                                - is_tagged_media_shared_to_viewer_profile_grid
                                - >-
                                  should_show_author_pog_for_tagged_media_shared_to_profile_grid
                                - is_eligible_for_media_note_recs_nux
                                - is_social_ufi_disabled
                                - is_eligible_for_meta_ai_share
                                - comment_count
                                - hide_view_all_comment_entrypoint
                                - is_comments_gif_composer_enabled
                                - comment_inform_treatment
                                - has_liked
                                - like_count
                                - video_versions
                                - video_duration
                                - has_audio
                                - clips_tab_pinned_user_ids
                                - clips_metadata
                                - can_viewer_save
                                - can_viewer_reshare
                                - shop_routing_user_id
                                - is_organic_product_tagging_eligible
                                - igbio_product
                                - product_suggestions
                                - is_open_to_public_submission
                          required:
                            - media
                      paging_info:
                        type: object
                        properties:
                          max_id:
                            type: string
                          more_available:
                            type: boolean
                        required:
                          - more_available
                      music_canonical_id:
                        type: string
                      audio_page_reporting_id:
                        type: string
                      formatted_media_count:
                        type: string
                      metadata:
                        type: object
                        properties:
                          music_info:
                            anyOf:
                              - type: object
                                properties:
                                  music_canonical_id:
                                    anyOf:
                                      - {}
                                      - type: string
                                  music_asset_info: {}
                                  music_consumption_info: {}
                              - type: 'null'
                          nux_info: {}
                          originality_info: {}
                          reusable_text_attribute_string: {}
                          reusable_text_info: {}
                          shopping_info: {}
                          show_achievements:
                            type: boolean
                          template_info: {}
                          viewer_interaction_settings: {}
                        required:
                          - music_info
                    required:
                      - items
                      - paging_info
                      - music_canonical_id
                      - audio_page_reporting_id
                      - formatted_media_count
                      - metadata
                  end_cursor:
                    type: string
                  more_available:
                    type: boolean
                required:
                  - data
                  - more_available
      tags:
        - Instagram Raw Data
      security:
        - accessToken: []
  /raw/youtube/channel-info:
    get:
      operationId: YoutubeRawController_channelInfo
      summary: Channel Info
      description: Returns details about the YouTube channel.
      parameters:
        - name: url
          required: true
          in: query
          description: >-
            YouTube url to channel's page, i.e.
            https://www.youtube.com/@{channelName}
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  channel_info:
                    type: object
                    properties:
                      channel_id:
                        type: string
                      custom_url:
                        type: string
                      username:
                        type: string
                      is_removed:
                        type: boolean
                      is_hidden:
                        type: boolean
                      is_verified:
                        type: boolean
                      fullname:
                        type: string
                      picture:
                        type: string
                      description:
                        type: string
                      country:
                        type: string
                      followers:
                        type: number
                      joined_at:
                        type: string
                      has_join:
                        type: boolean
                      total_views:
                        type: number
                      links:
                        type: array
                        items:
                          type: string
                      handle:
                        type: string
                    required:
                      - channel_id
                      - is_removed
                      - is_hidden
                      - is_verified
                      - fullname
                  success:
                    type: boolean
                required:
                  - channel_info
                  - success
      tags:
        - YouTube Raw Data
      security:
        - accessToken: []
  /raw/youtube/uploaded-videos:
    get:
      operationId: YoutubeRawController_uploadedVideos
      summary: Uploaded Videos
      description: >-
        Returns a list of 30 uploaded YouTube videos to the channel with a
        limited list of details.
      parameters:
        - name: url
          required: true
          in: query
          description: >-
            YouTube url to channel's page, i.e.
            https://www.youtube.com/@{channelName}
          schema:
            type: string
        - name: sorted_by
          required: false
          in: query
          description: >-
            Sorted by a passed parameter: `"dd"` by Date in descending order
            (default) or `"p"` by Popularity
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `cursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  videos_list:
                    type: object
                    properties:
                      total:
                        type: number
                      videos:
                        type: array
                        items:
                          type: object
                          properties:
                            video_id:
                              type: string
                            thumbnail:
                              type: string
                            title:
                              type: string
                            time:
                              type: string
                            published_ago:
                              type: string
                            views:
                              type: number
                          required:
                            - video_id
                            - thumbnail
                            - title
                            - time
                      cursor:
                        type: string
                    required:
                      - total
                      - videos
                      - cursor
                  success:
                    type: boolean
                required:
                  - videos_list
                  - success
      tags:
        - YouTube Raw Data
      security:
        - accessToken: []
  /raw/youtube/uploaded-shorts:
    get:
      operationId: YoutubeRawController_uploadedShorts
      summary: Uploaded Shorts
      description: >-
        Returns a list of 30 uploaded YouTube shorts to the channel with a
        limited list of details.
      parameters:
        - name: url
          required: true
          in: query
          description: >-
            YouTube url to channel's page, i.e.
            https://www.youtube.com/@{channelName}
          schema:
            type: string
        - name: sorted_by
          required: false
          in: query
          description: >-
            Sorted by a passed parameter: `"dd"` by Date in descending order
            (default) or `"p"` by Popularity
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `cursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  shorts_list:
                    type: object
                    properties:
                      shorts:
                        type: array
                        items:
                          type: object
                          properties:
                            short_id:
                              type: string
                            thumbnail:
                              type: string
                            title:
                              type: string
                            views:
                              type: number
                          required:
                            - short_id
                            - thumbnail
                            - title
                      cursor:
                        type: string
                    required:
                      - shorts
                      - cursor
                  success:
                    type: boolean
                required:
                  - shorts_list
                  - success
      tags:
        - YouTube Raw Data
      security:
        - accessToken: []
  /raw/youtube/uploaded-lives:
    get:
      operationId: YoutubeRawController_uploadedLives
      summary: Uploaded Lives
      description: >-
        Returns a list of 30 uploaded YouTube lives to the channel with a
        limited list of details.
      parameters:
        - name: url
          required: true
          in: query
          description: >-
            YouTube url to channel's page, i.e.
            https://www.youtube.com/@{channelName}
          schema:
            type: string
        - name: sorted_by
          required: false
          in: query
          description: >-
            Sorted by a passed parameter: `"dd"` by Date in descending order
            (default) or `"p"` by Popularity
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `cursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  lives_list:
                    type: object
                    properties:
                      lives:
                        type: array
                        items:
                          type: object
                          properties:
                            live_id:
                              type: string
                            thumbnail:
                              type: string
                            title:
                              type: string
                            time:
                              type: string
                            published_ago:
                              type: string
                            views:
                              type: number
                          required:
                            - live_id
                            - thumbnail
                            - title
                            - time
                      cursor:
                        type: string
                    required:
                      - lives
                      - cursor
                  success:
                    type: boolean
                required:
                  - lives_list
                  - success
      tags:
        - YouTube Raw Data
      security:
        - accessToken: []
  /raw/youtube/playlist-videos:
    get:
      operationId: YoutubeRawController_playlistVideos
      summary: Playlist Videos
      description: Returns a list of 100 videos from a YouTube playlist.
      parameters:
        - name: url
          required: true
          in: query
          description: >-
            YouTube url to playlist's page, i.e.
            https://www.youtube.com/playlist?list={playlistId}
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `cursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  videos_list:
                    type: object
                    properties:
                      total:
                        type: number
                      videos:
                        type: array
                        items:
                          type: object
                          properties:
                            video_id:
                              type: string
                            thumbnail:
                              type: string
                            title:
                              type: string
                            time:
                              type: string
                            published_ago:
                              type: string
                            views:
                              type: number
                          required:
                            - video_id
                            - thumbnail
                            - title
                            - time
                      cursor:
                        type: string
                    required:
                      - total
                      - videos
                      - cursor
                  success:
                    type: boolean
                required:
                  - videos_list
                  - success
      tags:
        - YouTube Raw Data
      security:
        - accessToken: []
  /raw/youtube/video-info:
    get:
      operationId: YoutubeRawController_videoInfo
      summary: Video Info
      description: Returns a YouTube video or live information.
      parameters:
        - name: url
          required: true
          in: query
          description: >-
            YouTube video page url i.e.
            https://www.youtube.com/watch?v={videoId}
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  video_info:
                    type: object
                    properties:
                      video_id:
                        type: string
                      channel_id:
                        type: string
                      title:
                        type: string
                      published_at:
                        type: string
                      duration:
                        anyOf:
                          - type: string
                          - type: number
                      views:
                        type: number
                      likes:
                        type: number
                      dislikes:
                        type: number
                      comments:
                        type: number
                      genre:
                        type: string
                      thumbnail:
                        type: string
                      description:
                        type: string
                      keywords:
                        type: array
                        items:
                          type: string
                      subtitles:
                        type: array
                        items:
                          type: object
                          properties:
                            vss_id:
                              type: string
                            language_code:
                              type: string
                            name:
                              type: string
                            fetch_url:
                              type: string
                          required:
                            - vss_id
                            - language_code
                            - name
                            - fetch_url
                      comments_tabs:
                        type: array
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                            cursor:
                              type: string
                          required:
                            - type
                            - cursor
                      includes_paid_promotion:
                        type: boolean
                    required:
                      - video_id
                      - channel_id
                      - title
                      - published_at
                      - duration
                      - comments
                      - genre
                      - thumbnail
                      - description
                      - keywords
                  success:
                    type: boolean
                required:
                  - video_info
                  - success
      tags:
        - YouTube Raw Data
      security:
        - accessToken: []
  /raw/youtube/video-subtitles:
    get:
      operationId: YoutubeRawController_videoSubtitles
      summary: Video Subtitles
      description: Returns a YouTube video subtitles.
      parameters:
        - name: url
          required: true
          in: query
          description: >-
            YouTube video page url i.e.
            https://www.youtube.com/watch?v={videoId}
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    vss_id:
                      type: string
                    language_code:
                      type: string
                    name:
                      type: string
                    fetch_url:
                      type: string
                  required:
                    - vss_id
                    - language_code
                    - name
                    - fetch_url
      tags:
        - YouTube Raw Data
      security:
        - accessToken: []
  /raw/youtube/short-info:
    get:
      operationId: YoutubeRawController_shortInfo
      summary: Short Info
      description: Returns a YouTube short information.
      parameters:
        - name: url
          required: true
          in: query
          description: YouTube short page url i.e. https://www.youtube.com/shorts/{shortId}
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  short_info:
                    type: object
                    properties:
                      short_id:
                        type: string
                      channel_id:
                        type: string
                      title:
                        type: string
                      published_at:
                        type: string
                      duration:
                        anyOf:
                          - type: string
                          - type: number
                      views:
                        type: number
                      likes:
                        type: number
                      dislikes:
                        type: number
                      comments:
                        type: number
                      genre:
                        type: string
                      thumbnail:
                        type: string
                      description:
                        type: string
                      subtitles:
                        type: array
                        items:
                          type: object
                          properties:
                            vss_id:
                              type: string
                            language_code:
                              type: string
                            name:
                              type: string
                            fetch_url:
                              type: string
                          required:
                            - vss_id
                            - language_code
                            - name
                            - fetch_url
                      keywords:
                        type: array
                        items:
                          type: string
                      includes_paid_promotion:
                        type: boolean
                    required:
                      - short_id
                      - channel_id
                      - title
                      - published_at
                      - duration
                      - comments
                      - genre
                      - thumbnail
                      - description
                      - keywords
                      - includes_paid_promotion
                  success:
                    type: boolean
                required:
                  - short_info
                  - success
      tags:
        - YouTube Raw Data
      security:
        - accessToken: []
  /raw/youtube/video-comments:
    get:
      operationId: YoutubeRawController_videoComments
      summary: Video Comments
      description: >-
        Returns a list of 20 YouTube video or live comments. To obtain the first
        comments page use `cursor` from Video Info endpoint.
      parameters:
        - name: url
          required: true
          in: query
          description: >-
            YouTube video page url i.e.
            https://www.youtube.com/watch?v={videoId}
          schema:
            type: string
        - name: after
          required: true
          in: query
          description: Use `cursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  comments_list:
                    type: object
                    properties:
                      comments:
                        type: array
                        items:
                          type: object
                          properties:
                            comment_id:
                              type: string
                            author_channel_id:
                              type: string
                            author_name:
                              type: string
                            author_picture:
                              type: string
                            published_at:
                              type: string
                            author_is_channel_owner:
                              type: boolean
                            likes:
                              type: number
                            liked_by_creator:
                              type: boolean
                            text:
                              type: string
                            reply_count:
                              type: number
                            replies_cursor:
                              type: string
                          required:
                            - comment_id
                            - author_channel_id
                            - author_name
                            - author_picture
                            - published_at
                            - author_is_channel_owner
                            - likes
                            - text
                      cursor:
                        type: string
                    required:
                      - comments
                      - cursor
                  success:
                    type: boolean
                required:
                  - comments_list
                  - success
      tags:
        - YouTube Raw Data
      security:
        - accessToken: []
  /raw/youtube/video-comment-replies:
    get:
      operationId: YoutubeRawController_videoCommentReplies
      summary: Video Comment Replies
      description: >-
        Returns a list of 20 YouTube video or live comment replies. To obtain
        the first replies page use `replies_cursor` from Video Comments
        endpoint.
      parameters:
        - name: url
          required: true
          in: query
          description: >-
            YouTube video page url i.e.
            https://www.youtube.com/watch?v={videoId}
          schema:
            type: string
        - name: after
          required: true
          in: query
          description: Use `cursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  replies_list:
                    type: object
                    properties:
                      comments:
                        type: array
                        items:
                          type: object
                          properties:
                            comment_id:
                              type: string
                            author_channel_id:
                              type: string
                            author_name:
                              type: string
                            author_picture:
                              type: string
                            published_at:
                              type: string
                            author_is_channel_owner:
                              type: boolean
                            likes:
                              type: number
                            liked_by_creator:
                              type: boolean
                            text:
                              type: string
                            reply_count:
                              type: number
                            replies_cursor:
                              type: string
                          required:
                            - comment_id
                            - author_channel_id
                            - author_name
                            - author_picture
                            - published_at
                            - author_is_channel_owner
                            - likes
                            - text
                      cursor:
                        type: string
                    required:
                      - comments
                      - cursor
                  success:
                    type: boolean
                required:
                  - replies_list
                  - success
      tags:
        - YouTube Raw Data
      security:
        - accessToken: []
  /raw/tiktok/user-info:
    get:
      operationId: TiktokRawController_userInfo
      summary: TikTok User Info
      description: Returns details about the TikTok user profile
      parameters:
        - name: url
          required: true
          in: query
          description: Username (@handle) or user id, or url
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_info:
                    type: object
                    properties:
                      userInfo:
                        type: object
                        properties:
                          user:
                            type: object
                            properties:
                              id:
                                type: string
                              uniqueId:
                                type: string
                              nickname:
                                type: string
                              avatarThumb:
                                type: string
                              avatarMedium:
                                type: string
                              avatarLarger:
                                type: string
                              signature:
                                type: string
                              verified:
                                type: boolean
                              secUid:
                                type: string
                              secret:
                                type: boolean
                              ftc:
                                type: boolean
                              openFavorite:
                                type: boolean
                              bioLink:
                                type: object
                                properties:
                                  link:
                                    type: string
                                  risk:
                                    type: number
                              privateAccount:
                                type: boolean
                            required:
                              - id
                              - uniqueId
                              - nickname
                              - secUid
                          stats:
                            type: object
                            properties:
                              followingCount:
                                type: number
                              followerCount:
                                type: number
                              heartCount:
                                type: number
                              videoCount:
                                type: number
                              diggCount:
                                type: number
                              heart:
                                type: number
                            required:
                              - followingCount
                              - followerCount
                              - heartCount
                              - videoCount
                              - diggCount
                              - heart
                          shareMeta:
                            type: object
                            properties:
                              title:
                                type: string
                              desc:
                                type: string
                        required:
                          - user
                          - stats
                    required:
                      - userInfo
                  success:
                    type: boolean
                required:
                  - user_info
                  - success
      tags:
        - TikTok Raw Data
      security:
        - accessToken: []
  /raw/tiktok/user-feed:
    get:
      operationId: TiktokRawController_userFeed
      summary: TikTok User Feed
      description: >-
        Returns user feed information of a TikTok user by userId or username.
        The number of posts returned per page is not fixed and may vary per
        user.
      parameters:
        - name: url
          required: true
          in: query
          description: Username (@handle) or user id, or url
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `maxCursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_feed:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            desc:
                              type: string
                            createTime:
                              type: number
                            video:
                              type: object
                              properties:
                                id:
                                  type: string
                                height:
                                  type: number
                                width:
                                  type: number
                                duration:
                                  type: number
                                ratio:
                                  type: string
                                cover:
                                  type: string
                                originCover:
                                  type: string
                                dynamicCover:
                                  type: string
                                playAddr:
                                  type: string
                                downloadAddr:
                                  type: string
                                shareCover:
                                  type: array
                                  items:
                                    type: string
                                reflowCover:
                                  type: string
                              required:
                                - id
                            author:
                              type: object
                              properties:
                                id:
                                  type: string
                                uniqueId:
                                  type: string
                                nickname:
                                  type: string
                                avatarThumb:
                                  type: string
                                avatarMedium:
                                  type: string
                                avatarLarger:
                                  type: string
                                signature:
                                  type: string
                                verified:
                                  type: boolean
                                secUid:
                                  type: string
                                secret:
                                  type: boolean
                                ftc:
                                  type: boolean
                                openFavorite:
                                  type: boolean
                                commentSetting:
                                  type: number
                                duetSetting:
                                  type: number
                                stitchSetting:
                                  type: number
                                privateAccount:
                                  type: boolean
                              required:
                                - id
                            music:
                              type: object
                              properties:
                                id:
                                  type: string
                                title:
                                  type: string
                                playUrl:
                                  type: string
                                coverThumb:
                                  type: string
                                coverMedium:
                                  type: string
                                coverLarge:
                                  type: string
                                authorName:
                                  type: string
                                original:
                                  type: boolean
                              required:
                                - id
                            challenges:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  title:
                                    type: string
                                  desc:
                                    type: string
                                  profileThumb:
                                    type: string
                                  profileMedium:
                                    type: string
                                  profileLarger:
                                    type: string
                                  coverThumb:
                                    type: string
                                  coverMedium:
                                    type: string
                                  coverLarger:
                                    type: string
                                required:
                                  - id
                            stats:
                              type: object
                              properties:
                                diggCount:
                                  type: number
                                shareCount:
                                  type: number
                                commentCount:
                                  type: number
                                playCount:
                                  type: number
                                collectCount:
                                  type: number
                            originalItem:
                              type: boolean
                            officalItem:
                              type: boolean
                            textExtra:
                              type: array
                              items:
                                type: object
                                properties:
                                  awemeId:
                                    type: string
                                  start:
                                    type: number
                                  end:
                                    type: number
                                  hashtagName:
                                    type: string
                                  hashtagId:
                                    type: string
                                  type:
                                    type: number
                                  userId:
                                    type: string
                                  isCommerce:
                                    type: boolean
                                  userUniqueId:
                                    type: string
                                  secUid:
                                    type: string
                            secret:
                              type: boolean
                            forFriend:
                              type: boolean
                            showNotPass:
                              type: boolean
                            vl1:
                              type: boolean
                            itemMute:
                              type: boolean
                            authorStats:
                              type: object
                              properties:
                                followingCount:
                                  type: number
                                followerCount:
                                  type: number
                                heartCount:
                                  type: number
                                videoCount:
                                  type: number
                                diggCount:
                                  type: number
                                heart:
                                  type: number
                              required:
                                - followingCount
                                - followerCount
                                - heartCount
                                - videoCount
                                - diggCount
                                - heart
                            privateItem:
                              type: boolean
                            duetEnabled:
                              type: boolean
                            stitchEnabled:
                              type: boolean
                            shareEnabled:
                              type: boolean
                            isAd:
                              type: boolean
                          required:
                            - id
                            - video
                            - author
                            - music
                            - stats
                            - authorStats
                    required:
                      - items
                  success:
                    type: boolean
                  hasMore:
                    type: boolean
                  maxCursor:
                    type: string
                required:
                  - user_feed
                  - success
                  - hasMore
                  - maxCursor
      tags:
        - TikTok Raw Data
      security:
        - accessToken: []
  /raw/tiktok/challenge-feed:
    get:
      operationId: TiktokRawController_challengeFeed
      summary: TikTok Challenge Feed
      description: Returns TikTok challenge (tag) feed based on challenge id
      parameters:
        - name: url
          required: true
          in: query
          description: TikTok challengeId
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `maxCursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  challenge_feed:
                    type: object
                    properties:
                      itemList:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            desc:
                              type: string
                            createTime:
                              type: number
                            video:
                              type: object
                              properties:
                                id:
                                  type: string
                                height:
                                  type: number
                                width:
                                  type: number
                                duration:
                                  type: number
                                ratio:
                                  type: string
                                cover:
                                  type: string
                                originCover:
                                  type: string
                                dynamicCover:
                                  type: string
                                playAddr:
                                  type: string
                                downloadAddr:
                                  type: string
                                shareCover:
                                  type: array
                                  items:
                                    type: string
                                reflowCover:
                                  type: string
                              required:
                                - id
                            author:
                              type: object
                              properties:
                                id:
                                  type: string
                                uniqueId:
                                  type: string
                                nickname:
                                  type: string
                                avatarThumb:
                                  type: string
                                avatarMedium:
                                  type: string
                                avatarLarger:
                                  type: string
                                signature:
                                  type: string
                                verified:
                                  type: boolean
                                secUid:
                                  type: string
                                secret:
                                  type: boolean
                                ftc:
                                  type: boolean
                                openFavorite:
                                  type: boolean
                                commentSetting:
                                  type: number
                                duetSetting:
                                  type: number
                                stitchSetting:
                                  type: number
                                privateAccount:
                                  type: boolean
                              required:
                                - id
                            music:
                              type: object
                              properties:
                                id:
                                  type: string
                                title:
                                  type: string
                                playUrl:
                                  type: string
                                coverThumb:
                                  type: string
                                coverMedium:
                                  type: string
                                coverLarge:
                                  type: string
                                authorName:
                                  type: string
                                original:
                                  type: boolean
                              required:
                                - id
                            challenges:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  title:
                                    type: string
                                  desc:
                                    type: string
                                  profileThumb:
                                    type: string
                                  profileMedium:
                                    type: string
                                  profileLarger:
                                    type: string
                                  coverThumb:
                                    type: string
                                  coverMedium:
                                    type: string
                                  coverLarger:
                                    type: string
                                required:
                                  - id
                            stats:
                              type: object
                              properties:
                                diggCount:
                                  type: number
                                shareCount:
                                  type: number
                                commentCount:
                                  type: number
                                playCount:
                                  type: number
                                collectCount:
                                  type: number
                            originalItem:
                              type: boolean
                            officalItem:
                              type: boolean
                            textExtra:
                              type: array
                              items:
                                type: object
                                properties:
                                  awemeId:
                                    type: string
                                  start:
                                    type: number
                                  end:
                                    type: number
                                  hashtagName:
                                    type: string
                                  hashtagId:
                                    type: string
                                  type:
                                    type: number
                                  userId:
                                    type: string
                                  isCommerce:
                                    type: boolean
                                  userUniqueId:
                                    type: string
                                  secUid:
                                    type: string
                            secret:
                              type: boolean
                            forFriend:
                              type: boolean
                            showNotPass:
                              type: boolean
                            vl1:
                              type: boolean
                            itemMute:
                              type: boolean
                            authorStats:
                              type: object
                              properties:
                                followingCount:
                                  type: number
                                followerCount:
                                  type: number
                                heartCount:
                                  type: number
                                videoCount:
                                  type: number
                                diggCount:
                                  type: number
                                heart:
                                  type: number
                              required:
                                - followingCount
                                - followerCount
                                - heartCount
                                - videoCount
                                - diggCount
                                - heart
                            privateItem:
                              type: boolean
                            duetEnabled:
                              type: boolean
                            stitchEnabled:
                              type: boolean
                            shareEnabled:
                              type: boolean
                            isAd:
                              type: boolean
                          required:
                            - id
                            - video
                            - author
                            - music
                            - stats
                            - authorStats
                      stickersOnItem:
                        type: object
                        properties:
                          stickerType:
                            type: number
                          stickerText:
                            type: array
                            items:
                              type: string
                      hasMore:
                        type: boolean
                      maxCursor:
                        type: string
                    required:
                      - itemList
                      - hasMore
                      - maxCursor
                  success:
                    type: boolean
                required:
                  - challenge_feed
                  - success
      tags:
        - TikTok Raw Data
      security:
        - accessToken: []
  /raw/tiktok/challenge-info:
    get:
      operationId: TiktokRawController_challengeInfo
      summary: TikTok Challenge Info
      description: Returns TikTok challenge info based on challenge id
      parameters:
        - name: url
          required: true
          in: query
          description: TikTok challengeId or challenge hashtag
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  challenge:
                    type: object
                    properties:
                      challengeInfo:
                        type: object
                        properties:
                          challenge:
                            type: object
                            properties:
                              id:
                                type: string
                              title:
                                type: string
                              desc:
                                type: string
                              profileLarger:
                                type: string
                              profileMedium:
                                type: string
                              profileThumb:
                                type: string
                              coverLarger:
                                type: string
                              coverMedium:
                                type: string
                              coverThumb:
                                type: string
                              isCommerce:
                                type: boolean
                              splitTitle:
                                type: string
                            required:
                              - id
                              - title
                              - desc
                              - profileLarger
                              - profileMedium
                              - profileThumb
                              - coverLarger
                              - coverMedium
                              - coverThumb
                              - isCommerce
                              - splitTitle
                          stats:
                            type: object
                            properties:
                              videoCount:
                                type: number
                              viewCount:
                                type: number
                            required:
                              - videoCount
                              - viewCount
                        required:
                          - challenge
                          - stats
                    required:
                      - challengeInfo
                  success:
                    type: boolean
                required:
                  - challenge
                  - success
      tags:
        - TikTok Raw Data
      security:
        - accessToken: []
  /raw/tiktok/comments:
    get:
      operationId: TiktokRawController_comments
      summary: TikTok Comments
      description: Returns TikTok comments list based on media id
      parameters:
        - name: url
          required: true
          in: query
          description: TikTok media ID
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `maxCursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  comments:
                    type: object
                    properties:
                      comments:
                        type: array
                        items:
                          type: object
                          properties:
                            cid:
                              type: string
                            text:
                              type: string
                            aweme_id:
                              type: string
                            create_time:
                              type: number
                            digg_count:
                              type: number
                            status:
                              type: number
                            user:
                              type: object
                              properties:
                                nickname:
                                  type: string
                                avatar_thumb:
                                  type: object
                                  properties:
                                    uri:
                                      type: string
                                    url_list:
                                      type: array
                                      items:
                                        type: string
                                custom_verify:
                                  type: string
                                unique_id:
                                  type: string
                                enterprise_verify_reason:
                                  type: string
                                sec_uid:
                                  type: string
                              required:
                                - nickname
                                - avatar_thumb
                                - sec_uid
                            reply_id:
                              type: string
                            text_extra:
                              type: array
                              items:
                                type: object
                                properties:
                                  start:
                                    type: number
                                  end:
                                    type: number
                                  user_id:
                                    type: string
                                  hashtag_name:
                                    type: string
                                  hashtag_id:
                                    type: string
                                  sec_uid:
                                    type: string
                            label_text:
                              type: string
                            label_type:
                              type: number
                            reply_comment_total:
                              type: number
                            reply_to_reply_id:
                              type: string
                            reply_to_userid:
                              type: string
                            reply_to_username:
                              type: string
                            is_author_digged:
                              type: boolean
                            reply_comment:
                              type: array
                              items:
                                type: object
                                properties:
                                  cid:
                                    type: string
                                  text:
                                    type: string
                                  aweme_id:
                                    type: string
                                  create_time:
                                    type: number
                                  digg_count:
                                    type: number
                                  status:
                                    type: number
                                  user:
                                    type: object
                                    properties:
                                      nickname:
                                        type: string
                                      avatar_thumb:
                                        type: object
                                        properties:
                                          uri:
                                            type: string
                                          url_list:
                                            type: array
                                            items:
                                              type: string
                                      custom_verify:
                                        type: string
                                      unique_id:
                                        type: string
                                      enterprise_verify_reason:
                                        type: string
                                      sec_uid:
                                        type: string
                                    required:
                                      - nickname
                                      - avatar_thumb
                                      - sec_uid
                                  reply_id:
                                    type: string
                                  text_extra:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        start:
                                          type: number
                                        end:
                                          type: number
                                        user_id:
                                          type: string
                                        hashtag_name:
                                          type: string
                                        hashtag_id:
                                          type: string
                                        sec_uid:
                                          type: string
                                  label_text:
                                    type: string
                                  label_type:
                                    type: number
                                  reply_comment_total:
                                    type: number
                                  reply_to_reply_id:
                                    type: string
                                  reply_to_userid:
                                    type: string
                                  reply_to_username:
                                    type: string
                                  is_author_digged:
                                    type: boolean
                                required:
                                  - cid
                                  - text
                                  - user
                                  - is_author_digged
                          required:
                            - cid
                            - text
                            - user
                            - text_extra
                            - is_author_digged
                            - reply_comment
                      hasMore:
                        type: boolean
                      maxCursor:
                        type: string
                    required:
                      - comments
                      - hasMore
                      - maxCursor
                  success:
                    type: boolean
                required:
                  - comments
                  - success
      tags:
        - TikTok Raw Data
      security:
        - accessToken: []
  /raw/tiktok/comments-replies:
    get:
      operationId: TiktokRawController_commentsReplies
      summary: TikTok Comments Replies
      description: Returns TikTok comment replies list based on comment id
      parameters:
        - name: url
          required: true
          in: query
          description: TikTok media ID
          schema:
            type: string
        - name: comment_id
          required: true
          in: query
          description: TikTok comment ID (cid)
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `maxCursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  comments:
                    type: object
                    properties:
                      comments:
                        type: array
                        items:
                          type: object
                          properties:
                            cid:
                              type: string
                            text:
                              type: string
                            aweme_id:
                              type: string
                            create_time:
                              type: number
                            digg_count:
                              type: number
                            status:
                              type: number
                            user:
                              type: object
                              properties:
                                nickname:
                                  type: string
                                avatar_thumb:
                                  type: object
                                  properties:
                                    uri:
                                      type: string
                                    url_list:
                                      type: array
                                      items:
                                        type: string
                                custom_verify:
                                  type: string
                                unique_id:
                                  type: string
                                enterprise_verify_reason:
                                  type: string
                                sec_uid:
                                  type: string
                              required:
                                - nickname
                                - avatar_thumb
                                - sec_uid
                            reply_id:
                              type: string
                            text_extra:
                              type: array
                              items:
                                type: object
                                properties:
                                  start:
                                    type: number
                                  end:
                                    type: number
                                  user_id:
                                    type: string
                                  hashtag_name:
                                    type: string
                                  hashtag_id:
                                    type: string
                                  sec_uid:
                                    type: string
                            label_text:
                              type: string
                            label_type:
                              type: number
                            reply_comment_total:
                              type: number
                            reply_to_reply_id:
                              type: string
                            reply_to_userid:
                              type: string
                            reply_to_username:
                              type: string
                            is_author_digged:
                              type: boolean
                            reply_comment:
                              type: array
                              items:
                                type: object
                                properties:
                                  cid:
                                    type: string
                                  text:
                                    type: string
                                  aweme_id:
                                    type: string
                                  create_time:
                                    type: number
                                  digg_count:
                                    type: number
                                  status:
                                    type: number
                                  user:
                                    type: object
                                    properties:
                                      nickname:
                                        type: string
                                      avatar_thumb:
                                        type: object
                                        properties:
                                          uri:
                                            type: string
                                          url_list:
                                            type: array
                                            items:
                                              type: string
                                      custom_verify:
                                        type: string
                                      unique_id:
                                        type: string
                                      enterprise_verify_reason:
                                        type: string
                                      sec_uid:
                                        type: string
                                    required:
                                      - nickname
                                      - avatar_thumb
                                      - sec_uid
                                  reply_id:
                                    type: string
                                  text_extra:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        start:
                                          type: number
                                        end:
                                          type: number
                                        user_id:
                                          type: string
                                        hashtag_name:
                                          type: string
                                        hashtag_id:
                                          type: string
                                        sec_uid:
                                          type: string
                                  label_text:
                                    type: string
                                  label_type:
                                    type: number
                                  reply_comment_total:
                                    type: number
                                  reply_to_reply_id:
                                    type: string
                                  reply_to_userid:
                                    type: string
                                  reply_to_username:
                                    type: string
                                  is_author_digged:
                                    type: boolean
                                required:
                                  - cid
                                  - text
                                  - user
                                  - is_author_digged
                          required:
                            - cid
                            - text
                            - user
                            - text_extra
                            - is_author_digged
                            - reply_comment
                      hasMore:
                        type: boolean
                      maxCursor:
                        type: string
                    required:
                      - comments
                      - hasMore
                      - maxCursor
                  success:
                    type: boolean
                required:
                  - comments
                  - success
      tags:
        - TikTok Raw Data
      security:
        - accessToken: []
  /raw/tiktok/music-info:
    get:
      operationId: TiktokRawController_musicInfo
      summary: TikTok Music Info
      description: Returns music info by id
      parameters:
        - name: url
          required: true
          in: query
          description: TikTok music ID
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `maxCursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  music:
                    type: object
                    properties:
                      musicInfo:
                        type: object
                        properties:
                          music:
                            type: object
                            properties:
                              id:
                                type: string
                              title:
                                type: string
                              playUrl:
                                type: string
                              coverThumb:
                                type: string
                              coverMedium:
                                type: string
                              coverLarge:
                                type: string
                              authorName:
                                type: string
                              original:
                                type: boolean
                              duration:
                                type: number
                              album:
                                type: string
                            required:
                              - id
                              - title
                              - playUrl
                              - coverThumb
                              - coverMedium
                              - coverLarge
                              - authorName
                              - original
                              - duration
                              - album
                          author:
                            type: object
                            properties:
                              id:
                                type: string
                              uniqueId:
                                type: string
                              nickname:
                                type: string
                              avatarThumb:
                                type: string
                              avatarMedium:
                                type: string
                              avatarLarger:
                                type: string
                              signature:
                                type: string
                              verified:
                                type: boolean
                              secUid:
                                type: string
                              secret:
                                type: boolean
                              ftc:
                                type: boolean
                              openFavorite:
                                type: boolean
                              commentSetting:
                                type: number
                              duetSetting:
                                type: number
                              stitchSetting:
                                type: number
                              privateAccount:
                                type: boolean
                            required:
                              - id
                              - uniqueId
                              - nickname
                              - avatarThumb
                              - avatarMedium
                              - avatarLarger
                              - signature
                              - verified
                              - secUid
                              - secret
                              - ftc
                              - openFavorite
                              - commentSetting
                              - duetSetting
                              - stitchSetting
                              - privateAccount
                          stats:
                            type: object
                            properties:
                              videoCount:
                                type: number
                            required:
                              - videoCount
                          artist:
                            type: object
                            properties:
                              id:
                                type: string
                              uniqueId:
                                type: string
                              nickname:
                                type: string
                              avatarThumb:
                                type: string
                              avatarMedium:
                                type: string
                              avatarLarger:
                                type: string
                              signature:
                                type: string
                              verified:
                                type: boolean
                              secUid:
                                type: string
                              secret:
                                type: boolean
                              ftc:
                                type: boolean
                              openFavorite:
                                type: boolean
                              commentSetting:
                                type: number
                              duetSetting:
                                type: number
                              stitchSetting:
                                type: number
                              privateAccount:
                                type: boolean
                            required:
                              - id
                              - uniqueId
                              - nickname
                              - avatarThumb
                              - avatarMedium
                              - avatarLarger
                              - signature
                              - verified
                              - secUid
                              - secret
                              - ftc
                              - openFavorite
                              - commentSetting
                              - duetSetting
                              - stitchSetting
                              - privateAccount
                          artists:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                uniqueId:
                                  type: string
                                nickname:
                                  type: string
                                avatarThumb:
                                  type: string
                                avatarMedium:
                                  type: string
                                avatarLarger:
                                  type: string
                                signature:
                                  type: string
                                verified:
                                  type: boolean
                                secUid:
                                  type: string
                                secret:
                                  type: boolean
                                ftc:
                                  type: boolean
                                openFavorite:
                                  type: boolean
                                commentSetting:
                                  type: number
                                duetSetting:
                                  type: number
                                stitchSetting:
                                  type: number
                                privateAccount:
                                  type: boolean
                              required:
                                - id
                                - uniqueId
                                - nickname
                                - avatarThumb
                                - avatarMedium
                                - avatarLarger
                                - signature
                                - verified
                                - secUid
                                - secret
                                - ftc
                                - openFavorite
                                - commentSetting
                                - duetSetting
                                - stitchSetting
                                - privateAccount
                        required:
                          - music
                          - stats
                          - artist
                          - artists
                    required:
                      - musicInfo
                  success:
                    type: boolean
                required:
                  - music
                  - success
      tags:
        - TikTok Raw Data
      security:
        - accessToken: []
  /raw/tiktok/music-feed:
    get:
      operationId: TiktokRawController_musicFeed
      summary: TikTok Music Feed
      description: Returns TikTok music feed by id. Up to 30 posts per page
      parameters:
        - name: url
          required: true
          in: query
          description: TikTok music ID
          schema:
            type: string
        - name: after
          required: false
          in: query
          description: Use `maxCursor` from the last page to get the next page
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  music_feed:
                    type: object
                    properties:
                      itemList:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            desc:
                              type: string
                            createTime:
                              type: number
                            video:
                              type: object
                              properties:
                                id:
                                  type: string
                                height:
                                  type: number
                                width:
                                  type: number
                                duration:
                                  type: number
                                ratio:
                                  type: string
                                cover:
                                  type: string
                                originCover:
                                  type: string
                                dynamicCover:
                                  type: string
                                playAddr:
                                  type: string
                                downloadAddr:
                                  type: string
                                shareCover:
                                  type: array
                                  items:
                                    type: string
                                reflowCover:
                                  type: string
                              required:
                                - id
                            author:
                              type: object
                              properties:
                                id:
                                  type: string
                                uniqueId:
                                  type: string
                                nickname:
                                  type: string
                                avatarThumb:
                                  type: string
                                avatarMedium:
                                  type: string
                                avatarLarger:
                                  type: string
                                signature:
                                  type: string
                                verified:
                                  type: boolean
                                secUid:
                                  type: string
                                secret:
                                  type: boolean
                                ftc:
                                  type: boolean
                                openFavorite:
                                  type: boolean
                                commentSetting:
                                  type: number
                                duetSetting:
                                  type: number
                                stitchSetting:
                                  type: number
                                privateAccount:
                                  type: boolean
                              required:
                                - id
                            music:
                              type: object
                              properties:
                                id:
                                  type: string
                                title:
                                  type: string
                                playUrl:
                                  type: string
                                coverThumb:
                                  type: string
                                coverMedium:
                                  type: string
                                coverLarge:
                                  type: string
                                authorName:
                                  type: string
                                original:
                                  type: boolean
                              required:
                                - id
                            challenges:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  title:
                                    type: string
                                  desc:
                                    type: string
                                  profileThumb:
                                    type: string
                                  profileMedium:
                                    type: string
                                  profileLarger:
                                    type: string
                                  coverThumb:
                                    type: string
                                  coverMedium:
                                    type: string
                                  coverLarger:
                                    type: string
                                required:
                                  - id
                            stats:
                              type: object
                              properties:
                                diggCount:
                                  type: number
                                shareCount:
                                  type: number
                                commentCount:
                                  type: number
                                playCount:
                                  type: number
                                collectCount:
                                  type: number
                            originalItem:
                              type: boolean
                            officalItem:
                              type: boolean
                            textExtra:
                              type: array
                              items:
                                type: object
                                properties:
                                  awemeId:
                                    type: string
                                  start:
                                    type: number
                                  end:
                                    type: number
                                  hashtagName:
                                    type: string
                                  hashtagId:
                                    type: string
                                  type:
                                    type: number
                                  userId:
                                    type: string
                                  isCommerce:
                                    type: boolean
                                  userUniqueId:
                                    type: string
                                  secUid:
                                    type: string
                            secret:
                              type: boolean
                            forFriend:
                              type: boolean
                            showNotPass:
                              type: boolean
                            vl1:
                              type: boolean
                            itemMute:
                              type: boolean
                            authorStats:
                              type: object
                              properties:
                                followingCount:
                                  type: number
                                followerCount:
                                  type: number
                                heartCount:
                                  type: number
                                videoCount:
                                  type: number
                                diggCount:
                                  type: number
                                heart:
                                  type: number
                              required:
                                - followingCount
                                - followerCount
                                - heartCount
                                - videoCount
                                - diggCount
                                - heart
                            privateItem:
                              type: boolean
                            duetEnabled:
                              type: boolean
                            stitchEnabled:
                              type: boolean
                            shareEnabled:
                              type: boolean
                            isAd:
                              type: boolean
                          required:
                            - id
                            - video
                            - author
                            - music
                            - stats
                            - authorStats
                    required:
                      - itemList
                  hasMore:
                    type: boolean
                  maxCursor:
                    type: string
                required:
                  - success
                  - music_feed
                  - hasMore
                  - maxCursor
      tags:
        - TikTok Raw Data
      security:
        - accessToken: []
  /raw/tiktok/search-users:
    get:
      operationId: TiktokRawController_searchUsers
      summary: TikTok Search Users
      description: Returns TikTok users' search result by a given keyword
      parameters:
        - name: keyword
          required: true
          in: query
          description: Search keyword
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      user_list:
                        type: array
                        items:
                          type: object
                          properties:
                            user_info:
                              type: object
                              properties:
                                uid:
                                  type: string
                                nickname:
                                  type: string
                                signature:
                                  type: string
                                avatar_thumb:
                                  type: object
                                  properties:
                                    uri:
                                      type: string
                                    url_list:
                                      type: array
                                      items:
                                        type: string
                                    width:
                                      type: number
                                    height:
                                      type: number
                                  required:
                                    - uri
                                    - url_list
                                    - width
                                    - height
                                follower_count:
                                  type: number
                                custom_verify:
                                  type: string
                                unique_id:
                                  type: string
                                enterprise_verify_reason:
                                  type: string
                                sec_uid:
                                  type: string
                              required:
                                - uid
                                - nickname
                                - signature
                                - avatar_thumb
                                - follower_count
                                - custom_verify
                                - unique_id
                                - enterprise_verify_reason
                                - sec_uid
                          required:
                            - user_info
                    required:
                      - user_list
                  success:
                    type: boolean
                required:
                  - result
                  - success
      tags:
        - TikTok Raw Data
      security:
        - accessToken: []
  /raw/tiktok/media-info:
    get:
      operationId: TiktokRawController_mediaInfo
      summary: TikTok Media Info
      description: Returns TikTok media info by id
      parameters:
        - name: url
          required: true
          in: query
          description: TikTok media/post ID
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  media:
                    type: object
                    properties:
                      itemInfo:
                        type: object
                        properties:
                          itemStruct:
                            type: object
                            properties:
                              id:
                                type: string
                              desc:
                                type: string
                              createTime:
                                type: number
                              video:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  height:
                                    type: number
                                  width:
                                    type: number
                                  duration:
                                    type: number
                                  ratio:
                                    type: string
                                  cover:
                                    type: string
                                  originCover:
                                    type: string
                                  dynamicCover:
                                    type: string
                                  playAddr:
                                    type: string
                                  downloadAddr:
                                    type: string
                                  shareCover:
                                    type: array
                                    items:
                                      type: string
                                  reflowCover:
                                    type: string
                                required:
                                  - id
                              author:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  uniqueId:
                                    type: string
                                  nickname:
                                    type: string
                                  avatarThumb:
                                    type: string
                                  avatarMedium:
                                    type: string
                                  avatarLarger:
                                    type: string
                                  signature:
                                    type: string
                                  verified:
                                    type: boolean
                                  secUid:
                                    type: string
                                  secret:
                                    type: boolean
                                  ftc:
                                    type: boolean
                                  openFavorite:
                                    type: boolean
                                  commentSetting:
                                    type: number
                                  duetSetting:
                                    type: number
                                  stitchSetting:
                                    type: number
                                  privateAccount:
                                    type: boolean
                                required:
                                  - id
                              music:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  title:
                                    type: string
                                  playUrl:
                                    type: string
                                  coverThumb:
                                    type: string
                                  coverMedium:
                                    type: string
                                  coverLarge:
                                    type: string
                                  authorName:
                                    type: string
                                  original:
                                    type: boolean
                                  duration:
                                    type: number
                                  album:
                                    type: string
                                required:
                                  - id
                              challenges:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                    title:
                                      type: string
                                    desc:
                                      type: string
                                    profileThumb:
                                      type: string
                                    profileMedium:
                                      type: string
                                    profileLarger:
                                      type: string
                                    coverThumb:
                                      type: string
                                    coverMedium:
                                      type: string
                                    coverLarger:
                                      type: string
                                    isCommerce:
                                      type: boolean
                                  required:
                                    - id
                              stats:
                                type: object
                                properties:
                                  diggCount:
                                    type: number
                                  shareCount:
                                    type: number
                                  commentCount:
                                    type: number
                                  playCount:
                                    type: number
                                  collectCount:
                                    type: number
                              isActivityItem:
                                type: boolean
                              duetInfo:
                                type: object
                                properties:
                                  duetFromId:
                                    type: string
                              textExtra:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    awemeId:
                                      type: string
                                    start:
                                      type: number
                                    end:
                                      type: number
                                    hashtagName:
                                      type: string
                                    hashtagId:
                                      type: string
                                    type:
                                      type: number
                                    userId:
                                      type: string
                                    isCommerce:
                                      type: boolean
                                    userUniqueId:
                                      type: string
                                    secUid:
                                      type: string
                              secret:
                                type: boolean
                              showNotPass:
                                type: boolean
                              vl1:
                                type: boolean
                              itemMute:
                                type: boolean
                              privateItem:
                                type: boolean
                              duetEnabled:
                                type: boolean
                              stitchEnabled:
                                type: boolean
                              shareEnabled:
                                type: boolean
                              stickersOnItem:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    stickerType:
                                      type: number
                                    stickerText:
                                      type: array
                                      items:
                                        type: string
                              isAd:
                                type: boolean
                              location:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  name:
                                    type: string
                                  address:
                                    type: string
                                  city:
                                    type: string
                                  cityCode:
                                    type: string
                                  countryCode:
                                    type: string
                            required:
                              - id
                          shareMeta:
                            type: object
                            properties:
                              title:
                                type: string
                              desc:
                                type: string
                        required:
                          - itemStruct
                    required:
                      - itemInfo
                  success:
                    type: boolean
                required:
                  - media
                  - success
      tags:
        - TikTok Raw Data
      security:
        - accessToken: []
  /raw/tiktok/media-download:
    get:
      operationId: TiktokRawController_mediaDownload
      summary: TikTok Media Download
      description: Returns TikTok media downloaded video by id
      parameters:
        - name: url
          required: true
          in: query
          description: TikTok media/post ID
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
                format: binary
      tags:
        - TikTok Raw Data
      security:
        - accessToken: []
  /user/info:
    get:
      operationId: UserController_info
      summary: Get User Account Info
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    description: If there is an error
                    type: boolean
                  user:
                    type: object
                    properties:
                      name:
                        examples: Jane Doe
                        type: string
                      email:
                        examples: janedoe@example.com
                        type: string
                    required:
                      - name
                      - email
                  billing:
                    type: object
                    properties:
                      credits:
                        examples: 500.5
                        type: number
                      rawRequests:
                        example: 4500
                        type: number
                    required:
                      - rawRequests
                  rateLimits:
                    type: object
                    properties:
                      discoveryRatelimit:
                        example: 500
                        type: number
                      rawRatelimit:
                        example: 500
                        type: number
                      rawHourlyRatelimit:
                        type: object
                        properties:
                          instagram:
                            example: 100
                            type: number
                          tiktok:
                            example: 100
                            type: number
                          youtube:
                            example: 100
                            type: number
                        required:
                          - instagram
                          - tiktok
                          - youtube
                    required:
                      - discoveryRatelimit
                      - rawRatelimit
                required:
                  - error
                  - user
                  - billing
                  - rateLimits
      tags:
        - User Account
      security:
        - accessToken: []
info:
  title: Overview
  description: >
    RAW API endpoints return **real-time, unfiltered data** data from public
    social media profiles on Instagram, TikTok, and YouTube. Use them to access
    profiles, content, comments, tags, and hashtag feeds — exactly as they
    appear on the platforms.


    These endpoints are ideal for custom analytics, live monitoring, or building
    your own enrichment workflows.


    > ⚠️ Data is returned as-is, without filtering. Handle rate limits and
    pagination as needed.


    <a
    href="https://help.modash.io/en/articles/10871299-raw-api-best-practices-onboarding-for-developers"
    target="_blank">Read the Raw API Best Practices guide →</a>
  version: null
  contact:
    name: API Support
    url: https://www.modash.io
    email: hello@modash.io
  termsOfService: https://www.modash.io/legal/terms-of-service
tags:
  - name: Instagram Raw Data
    description: >-
      Instagram Raw Data API allows you to get public data anonymously from
      Instagram.


      Access to this API is restricted. To get access to this API contact our
      support at [hello@modash.io](mailto:hello@modash.io).


      Our RAW API subscriptions come with a monthly limit for requests, every
      successful request consumes one from the limit. A 404 status code is
      treated as a successful request, indicating that the requested content
      could not be found.
  - name: TikTok Raw Data
    description: >-
      TikTok Raw Data API allows you to get public data anonymously from Tiktok.


      Access to this API is restricted. To get access to this API contact our
      support at [hello@modash.io](mailto:hello@modash.io).


      Our RAW API subscriptions come with a monthly limit for requests, every
      successful request consumes one from the limit. A 404 status code is
      treated as a successful request, indicating that the requested content
      could not be found.
  - name: YouTube Raw Data
    description: >-
      YouTube Raw Data API allows you to get public data anonymously from
      YouTube.


      Access to this API is restricted. To get access to this API contact our
      support at [hello@modash.io](mailto:hello@modash.io).


      Our RAW API subscriptions come with a monthly limit for requests, every
      successful request consumes one from the limit. A 404 status code is
      treated as a successful request, indicating that the requested content
      could not be found.
  - name: User Account
    description: API for Modash user account management
servers:
  - url: https://api.modash.io/v1
components:
  securitySchemes:
    accessToken:
      scheme: bearer
      bearerFormat: token
      description: 'Please enter token in following format: Bearer \<APIToken\>'
      name: Authorization
      type: http
      in: header
  schemas:
    HealthDetail:
      type: object
      properties:
        endpoint:
          type: string
          description: Endpoint path
        status:
          type: string
          description: Endpoint status
      required:
        - endpoint
        - status
    Health:
      type: object
      properties:
        status:
          type: string
          description: >-
            API health status:<br/><ul><li>`healthy` indicates that the system
            is operating normally.</li><li>`degraded` indicates a moderate level
            of failures or slow responses in one or more
            endpoints.</li><li>`unhealthy` indicates a high level of failures or
            significant performance issues in one or more endpoints.</li></ul>
          example: healthy
          enum:
            - healthy
            - degraded
            - unhealthy
        details:
          description: Health details by endpoint
          example:
            - endpoint: email-search
              status: healthy
          type: array
          items:
            $ref: '#/components/schemas/HealthDetail'
      required:
        - status
        - details
    InstagramSort:
      type: object
      properties:
        field:
          type: string
          example: followers
          default: followers
          description: "Note: The following sort options are available only when the corresponding filter is applied: `keywords` `audienceGeo` `audienceLang` `audienceGender` `audienceAge` `audienceInterest` `followersGrowth`. <br />\n\t\tSorting field in which order you want to get the results."
          enum:
            - engagements
            - followers
            - engagementRate
            - keywords
            - audienceGeo
            - audienceLang
            - audienceGender
            - audienceAge
            - audienceRelevance
            - relevance
            - followersGrowth
            - audienceInterest
            - reelsPlays
        value:
          type: number
          example: 123
          description: >-
            Only required for ```audienceGeo``` and ```audienceInterest```
            sorting.
        direction:
          type: string
          example: desc
          default: desc
          description: Sorting direction
          enum:
            - asc
            - desc
      required:
        - field
    FollowersCount:
      type: object
      properties:
        min:
          type: number
          example: 20000
          description: Minimum follower count.
        max:
          type: number
          example: 70000
          description: Maximum follower count.
    InfluencerAgeRange:
      type: object
      properties:
        min:
          type: number
          example: 18
          description: Minimum influencer age.
          enum:
            - 18
            - 25
            - 35
            - 45
            - 65
        max:
          type: number
          example: 25
          description: Maximum influencer age.
          enum:
            - 18
            - 25
            - 35
            - 45
            - 65
    GrowthFilter:
      type: object
      properties:
        interval:
          type: string
          description: Specifies the interval of time in which growth occurred.
          enum:
            - i1month
            - i2months
            - i3months
            - i4months
            - i5months
            - i6months
          example: i1month
        value:
          type: number
          description: Weight of growth rate.
          example: 0.4
        operator:
          type: string
          description: Operator used for comparison.
          example: gt
          enum:
            - gte
            - gt
            - lt
            - lte
      required:
        - interval
        - operator
    ContactFilter:
      type: object
      properties:
        contactType:
          type: string
          example: email
          enum:
            - bbm
            - email
            - facebook
            - instagram
            - itunes
            - kakao
            - kik
            - lineid
            - linktree
            - pinterest
            - sarahah
            - sayat
            - skype
            - snapchat
            - tiktok
            - tumblr
            - twitchtv
            - twitter
            - vk
            - wechat
            - youtube
          description: Specifies the contact channels of an influencer.
        filterAction:
          type: string
          example: must
          enum:
            - must
            - should
            - not
          default: must
          description: >-
            Defines condition enforced by the filter - "must" include, "should"
            include, or must "not" include.
      required:
        - contactType
    TextTag:
      type: object
      properties:
        type:
          type: string
          enum:
            - hashtag
            - mention
          description: The type of the tag.
        value:
          type: string
          description: The hashtag or mention without `@` or `#` in front of it.
      required:
        - type
        - value
    ReelsPlaysCount:
      type: object
      properties:
        min:
          type: number
          example: 20000
          description: Minimum reels plays count.
        max:
          type: number
          example: 50000000
          description: Maximum reels plays count.
    EngagementsCount:
      type: object
      properties:
        min:
          type: number
          example: 5000
          description: Minimum engagements count (this value will be rounded).
        max:
          type: number
          example: 10000
          description: Maximum engagements count (this value will be rounded).
    InstagramFilterOperations:
      type: object
      properties:
        operator:
          type: string
          description: >-
            Logical operations used to combine filters.<br><i>Note: To use the
            `or` operator, you must apply it to at least two filters.</i>
          enum:
            - and
            - or
            - not
        filter:
          type: string
          description: >-
            Filter to apply the operation on. If `keywords` or `relevance` are
            specified then you can not sort by these fields.
          enum:
            - followers
            - engagements
            - engagementRate
            - lastposted
            - bio
            - keywords
            - relevance
            - language
            - gender
            - age
            - location
            - isVerified
            - interests
            - brands
            - accountTypes
            - hasSponsoredPosts
            - textTags
      required:
        - operator
        - filter
    InstagramSearchInfluencerFilters:
      type: object
      properties:
        followers:
          example:
            min: 20000
            max: 70000
          description: >-
            We round followers value in the filter: whenever it's below 5k, we
            round it to the nearest thousand (4123 -> 4000; 4800-> 5000); when
            it's over 5k, we round it to the nearest 5,000 (27k -> 25k; 28k ->
            30k).
          allOf:
            - $ref: '#/components/schemas/FollowersCount'
        engagementRate:
          type: number
          description: Minimum engagement rate.
          maximum: 1
          minimum: 0
          example: 0.02
        location:
          example:
            - 148838
            - 62149
            - 80500
            - 1428125
            - 304716
          description: >-
            Filter by Influencer Location, You can get the locations with our
            locations api end point and send location ids in an array.
          maxItems: 20
          type: array
          items:
            type: number
        language:
          type: string
          example: en
          description: >-
            Filter by Influencer Language, You can get the languages code with
            our languages api end point.
          minLength: 1
          maxLength: 3
        lastposted:
          type: number
          example: 90
          description: >-
            Idenitfy influencers based on when they last posted. The number
            represents days and should be >= 30.
          minimum: 30
        relevance:
          example:
            - '#cars'
            - '@topgear'
          description: >-
            Filter by topic of influencers posts or by similarity of topic to
            other influencer. For example "#cars #audi @topgear" means "Writing
            about #cars and #audi, has similar topic as @topgear account."
            <strong>You can only enter 100 usernames.</strong>
          type: array
          items:
            type: string
        audienceRelevance:
          example:
            - '@topgear'
          description: >-
            Filter by similarity of influencer's audience to another
            influencer's audience. For example "@topgear" means "Has audience
            similar to @topgear account." Audience similarity means followers
            follow accounts with the same topics as those followed by @topgear's
            audience.
          type: array
          items:
            type: string
        gender:
          type: string
          example: MALE
          description: Filter by Influencer gender.
          enum:
            - MALE
            - FEMALE
            - KNOWN
            - UNKNOWN
        age:
          description: >-
            Filter by Influencer age, possible values are: 18, 25, 35, 45, 65.
            You have the option to utilize either the `min` field, the `max`
            field, or both concurrently. <strong>Any number that falls outside
            the accepted range will be disregarded.</strong>
          allOf:
            - $ref: '#/components/schemas/InfluencerAgeRange'
        followersGrowthRate:
          description: Growth rate by followers over a period of time.
          example:
            interval: i6months
            value: 0.01
            operator: gt
          allOf:
            - $ref: '#/components/schemas/GrowthFilter'
        bio:
          type: string
          example: photos videos
          description: Search influencer by their bio description and/or full name
        hasYouTube:
          type: boolean
          example: false
          description: If Influencer has a youtube channel.
        hasContactDetails:
          description: If Influencer has contact details.
          type: array
          items:
            $ref: '#/components/schemas/ContactFilter'
        accountTypes:
          example:
            - 2
          description: >-
            Identify influencers by their Instagram account type: Regular = 1,
            Business = 2, Creator = 3. E.g to find business accounts use: 2
          type: array
          items:
            type: number
        brands:
          example:
            - 1708
            - 13
          description: >-
            Filter by Influencer Brands, You can get the array of brands with
            our brands API endpoint and send brand ids in an array.
          type: array
          items:
            type: number
        interests:
          example:
            - 3
            - 21
            - 1
            - 13
            - 11
            - 1708
            - 7
            - 1826
          description: >-
            Filter by Influencer Interests, You can get the array of interests
            with our interests api end point and send interests ids in an array.
          type: array
          items:
            type: number
        keywords:
          type: string
          description: >-
            Identify influencers by a phrase they use within the caption of
            their post.
          example: supercars
        textTags:
          example:
            - type: hashtag
              value: carsofinstagram
            - type: mention
              value: topgear
          maxItems: 20
          description: >-
            Filter by influencers who have used the defined hashtags or mentions
            in their posts. 
          type: array
          items:
            $ref: '#/components/schemas/TextTag'
        reelsPlays:
          description: >-
            We round reels plays value in the filter to the nearest thousand
            (1400 -> 1k; 1500-> 2k)
          allOf:
            - $ref: '#/components/schemas/ReelsPlaysCount'
        isVerified:
          type: boolean
          description: Set to `true` to filter by verified influencers.
        hasSponsoredPosts:
          type: boolean
          description: >-
            Set to `true` to filter by influencers who have sponsored posts. We
            identify sponsored posts by looking for commercial hashtags or the
            official paid partnership tag.
        engagements:
          description: >-
            Filter by engagements count. <i>Pro tip: set `max` to 0 if you want
            to see results with hidden likes.</i>
          allOf:
            - $ref: '#/components/schemas/EngagementsCount'
        filterOperations:
          description: >-
            Modify filter operation to use `and`, `or`, or `not`. Example:
            Search for <i>influencer using the keyword *cars* AND `not` from the
            London</i> or <i>Female `or` interested in Beauty &
            Cosmetics</i>.<br><i>If no operator is specified, the default
            operator applied is the `and` operator.</i>
          type: array
          items:
            $ref: '#/components/schemas/InstagramFilterOperations'
    LocationWeightedFilter:
      type: object
      properties:
        weight:
          type: number
          description: Weight of filter.
          maximum: 1
          minimum: 0
          example: 0.4
        id:
          type: number
          description: Filter value id for location (e.g. 148838)
      required:
        - id
    LanguageWeightedFilter:
      type: object
      properties:
        weight:
          type: number
          description: Weight of filter.
          maximum: 1
          minimum: 0
          example: 0.4
        id:
          type: string
          description: Filter value id for language (e.g. "en")
          minLength: 1
          maxLength: 2
      required:
        - id
    GenderWeightedFilter:
      type: object
      properties:
        weight:
          type: number
          description: Weight of filter.
          maximum: 1
          minimum: 0
          example: 0.4
        id:
          type: string
          description: Filter value id for gender
          enum:
            - MALE
            - FEMALE
      required:
        - id
    AgeWeightedFilter:
      type: object
      properties:
        weight:
          type: number
          description: Weight of filter.
          maximum: 1
          minimum: 0
          example: 0.4
        id:
          type: string
          description: Filter value id for age
          enum:
            - 13-17
            - 18-24
            - 25-34
            - 35-44
            - 45-64
            - 65-
      required:
        - id
    AudienceAgeRange:
      type: object
      properties:
        min:
          type: string
          example: 18
          description: Minimum audience age.
          enum:
            - '13'
            - '18'
            - '25'
            - '35'
            - '45'
            - '65'
        max:
          type: string
          example: 24
          description: Maximum audience age.
          enum:
            - '17'
            - '24'
            - '34'
            - '44'
            - '64'
        weight:
          type: number
          description: Weight of audience age range.
          minimum: 0
          maximum: 1
          example: 0.3
    InterestsWeightedFilter:
      type: object
      properties:
        weight:
          type: number
          description: Weight of filter.
          maximum: 1
          minimum: 0
          example: 0.4
        id:
          type: number
          description: Filter value id for interests (e.g. 1708)
      required:
        - id
    InstagramSearchAudienceFilters:
      type: object
      properties:
        location:
          example:
            - id: 148838
              weight: 0.2
            - id: 62149
              weight: 0.2
            - id: 80500
              weight: 0.2
            - id: 1428125
              weight: 0.2
            - id: 304716
              weight: 0.2
          description: >-
            Filter by Audience Location, You can get the locations with our
            locations api end point and send location ids in an array together
            with their weight percentages. The default percentage is set to 20%
            (0.2)
          type: array
          items:
            $ref: '#/components/schemas/LocationWeightedFilter'
        language:
          example:
            id: en
            weight: 0.2
          description: >-
            Filter by Audience Language, You can get the languages code with our
            languages api end point and send the location id within an object,
            together with the weight percentage. The default percentage is set
            to 20% (0.2)
          allOf:
            - $ref: '#/components/schemas/LanguageWeightedFilter'
        gender:
          example:
            id: MALE
            weight: 0.5
          description: >-
            Filter by gender specific Audience, You can send the gender together
            with the weight percentage. The default percentage is set to 50%
            (0.5)
          allOf:
            - $ref: '#/components/schemas/GenderWeightedFilter'
        age:
          example:
            - id: 18-24
              weight: 0.3
            - id: 65-
              weight: 0.3
          description: >-
            Filter by Audience age. You can send the age together with the
            weight percentage. The default percentage is set to 30% (0.3)
          type: array
          items:
            $ref: '#/components/schemas/AgeWeightedFilter'
        ageRange:
          example:
            min: '18'
            max: '24'
            weight: 0.3
          description: >-
            Filter by audience age range. You can send the age range together
            with the weight percentage. The default percentage is set to 30%
            (0.3). You can't send both age and ageRange together.
          allOf:
            - $ref: '#/components/schemas/AudienceAgeRange'
        interests:
          example:
            - id: 1708
              weight: 0.2
            - id: 13
              weight: 0.2
            - id: 3
              weight: 0.2
            - id: 21
              weight: 0.2
            - id: 1
              weight: 0.2
            - id: 11
              weight: 0.2
            - id: 7
              weight: 0.2
            - id: 1826
              weight: 0.2
          description: >-
            Filter by Audience Interests, You can get the array of interests
            with our interests api end point and send interests ids in an array
            together with their weight percentages. The default percentage is
            set to 30% (0.3)
          type: array
          items:
            $ref: '#/components/schemas/InterestsWeightedFilter'
        credibility:
          type: number
          example: 0.75
          description: >-
            Filter by Audience Credibility. The value is the inverse of fake
            followers, meaning 25% fake followers would translate to 0.75 of
            audience credibility.
          minimum: 0
          maximum: 1
    InstagramSearchFilters:
      type: object
      properties:
        influencer:
          $ref: '#/components/schemas/InstagramSearchInfluencerFilters'
        audience:
          $ref: '#/components/schemas/InstagramSearchAudienceFilters'
    InstagramSearchBody:
      type: object
      properties:
        page:
          type: number
          description: Page number
          default: 0
          minimum: 0
          maximum: 665
        calculationMethod:
          type: string
          example: median
          default: median
          description: >-
            If specified, this indicates the method used to compute
            average-based metrics, such as average number of likes, comments,
            shares, etc.
          enum:
            - median
            - average
        sort:
          description: Sorting
          allOf:
            - $ref: '#/components/schemas/InstagramSort'
        filter:
          $ref: '#/components/schemas/InstagramSearchFilters'
    ProfileResponse:
      type: object
      properties:
        userId:
          type: string
          description: User id of the influencer
          example: '173560420'
        fullname:
          type: string
          description: Full name of Influencer
          example: Instagram
        username:
          type: string
          description: Username of Influencer
          example: instagram
        url:
          type: string
          description: Profile URL
          example: https://www.instagram.com/instagram/
        picture:
          type: string
          description: Profile Picture
          example: >-
            https://imgigp.modash.io/?https://scontent-arn2-1.cdninstagram.com/t51.2885-19/s320x320/22159423_1794482210565499_9190891265074397184_n.jpg
        followers:
          type: number
          description: Follower count
          example: 313560626
        engagements:
          type: number
          description: Engagements
          example: 857994
        engagementRate:
          type: number
          description: Engagement rate
          example: 0.0027362938100525414
      required:
        - username
        - url
        - picture
        - followers
        - engagements
        - engagementRate
    InfluencerMatch:
      type: object
      properties:
        geo:
          type: object
          description: Influencer geo
          example:
            city:
              id: 1
              name: New York
              code: NY
            state:
              id: 1
              name: California
              code: CA
            country:
              id: 1
              name: United States
              code: US
            subdivision:
              id: 1
              name: New York State
              code: NY
        language:
          type: object
          description: Influencer language
          example:
            code: en
            name: English
        relevance:
          type: number
          description: Influencer relevance
          example: 0.85
        gender:
          type: string
          description: Influencer gender
          example: FEMALE
        age:
          type: string
          description: Influencer age
          example: 25-34
        followersGrowthRate:
          type: number
          description: Influencer followers growth rate
          example: 0.05
        brands:
          description: Influencer brands
          example:
            - id: 1
              name: Nike
          type: array
          items:
            type: object
        interests:
          description: Influencer interests
          example:
            - id: 3
              name: Music
          type: array
          items:
            type: object
        audienceRelevance:
          type: number
          description: Influencer audience relevance
          example: 0.85
    AudienceMatch:
      type: object
      properties:
        ages:
          description: Audience ages
          example:
            - code: 13-17
              weight: 0.25
          type: array
          items:
            type: object
        ageRange:
          type: object
          description: Audience age range
          example:
            code: 13-17
            weight: 0.25
        credibility:
          type: number
          description: Audience credibility
          example: 0.85
        geo:
          type: object
          description: Audience geo
          example:
            countries:
              - id: 1
                name: United States
                code: US
                weight: 0.25
            states:
              - id: 1
                name: California
                code: CA
                weight: 0.25
            cities:
              - id: 1
                name: New York
                code: NY
                weight: 0.25
            subdivisions:
              - id: 1
                name: New York State
                weight: 0.25
        interests:
          description: Audience interests
          example:
            - id: 1
              name: Fashion
          type: array
          items:
            type: object
        languages:
          description: Audience languages
          example:
            - code: en
              name: English
              weight: 0.25
          type: array
          items:
            type: object
        genders:
          description: Audience genders
          example:
            - code: MALE
              weight: 0.25
          type: array
          items:
            type: object
    Match:
      type: object
      properties:
        influencer:
          description: Influencer match
          allOf:
            - $ref: '#/components/schemas/InfluencerMatch'
        audience:
          description: Audience match
          allOf:
            - $ref: '#/components/schemas/AudienceMatch'
    InfluencerResponse:
      type: object
      properties:
        userId:
          type: string
          description: User Id
          example: '173560420'
        profile:
          description: Profile info of influencer
          allOf:
            - $ref: '#/components/schemas/ProfileResponse'
        match:
          description: Match
          allOf:
            - $ref: '#/components/schemas/Match'
      required:
        - userId
        - profile
    SearchResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        total:
          type: number
          description: Number of results
          example: 2
        lookalikes:
          description: Lookalikes
          type: array
          items:
            $ref: '#/components/schemas/InfluencerResponse'
        directs:
          description: Directs
          type: array
          items:
            $ref: '#/components/schemas/InfluencerResponse'
        isExactMatch:
          type: boolean
          description: >-
            Are the results exactly matching the filters you provided? If we
            don't find exact results then we try to show similar users by
            automatically removing some filters for you.
          example: true
      required:
        - total
        - lookalikes
        - directs
        - isExactMatch
    InstagramProfileResponse:
      type: object
      properties:
        userId:
          type: string
          description: User id of the influencer
          example: '173560420'
        fullname:
          type: string
          description: Full name of Influencer
          example: Instagram
        username:
          type: string
          description: Username of Influencer
          example: instagram
        url:
          type: string
          description: Profile URL
          example: https://www.instagram.com/instagram/
        picture:
          type: string
          description: Profile Picture
          example: >-
            https://imgigp.modash.io/?https://scontent-arn2-1.cdninstagram.com/t51.2885-19/s320x320/22159423_1794482210565499_9190891265074397184_n.jpg
        followers:
          type: number
          description: Follower count
          example: 313560626
        engagements:
          type: number
          description: Engagements
          example: 857994
        engagementRate:
          type: number
          description: Engagement rate
          example: 0.0027362938100525414
      required:
        - username
        - url
        - picture
        - followers
        - engagements
        - engagementRate
    Tag:
      type: object
      properties:
        tag:
          type: string
          example: ''
        weight:
          type: number
          example: 0.1
      required:
        - tag
        - weight
    ContentTypeStatsHistory:
      type: object
      properties:
        month:
          type: string
          example: 2025-01
        avgLikes:
          type: number
          example: 0
        avgEngagements:
          type: number
          example: 0
        avgViews:
          type: number
          example: 0
        avgComments:
          type: number
          example: 0
        avgShares:
          type: number
          example: 0
        avgSaves:
          type: number
          example: 0
    ContentTypeStatsInstagram:
      type: object
      properties:
        engagements:
          type: number
          example: 0
        engagementRate:
          type: number
          example: 0
        avgLikes:
          type: number
          example: 0
        avgComments:
          type: number
          example: 0
        statHistory:
          type: array
          items:
            $ref: '#/components/schemas/ContentTypeStatsHistory'
        avgReelsPlays:
          type: number
          example: 0
        avgShares:
          type: number
          example: 0
    StatsByContentTypeInstagram:
      type: object
      properties:
        all:
          example: {}
          description: All content type stats
          allOf:
            - $ref: '#/components/schemas/ContentTypeStatsInstagram'
        reels:
          example: {}
          description: Reels stats
          allOf:
            - $ref: '#/components/schemas/ContentTypeStatsInstagram'
    WeightWithCode:
      type: object
      properties:
        code:
          type: string
          example: ''
        weight:
          type: number
          example: 0.07
      required:
        - code
        - weight
    WeightWithCodeName:
      type: object
      properties:
        name:
          type: string
          example: ''
        weight:
          type: number
          example: 0.07
        code:
          type: string
          example: ''
      required:
        - name
        - weight
        - code
    GenderPerAge:
      type: object
      properties:
        code:
          type: string
          example: ''
        male:
          type: number
          example: 0.07
        female:
          type: number
          example: 0.07
      required:
        - code
        - male
        - female
    WeightWithName:
      type: object
      properties:
        name:
          type: string
          example: ''
        weight:
          type: number
          example: 0.07
      required:
        - name
        - weight
    InstagramAudienceSubdivision:
      type: object
      properties:
        name:
          type: string
          example: ''
        code:
          type: string
          example: ''
        items:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithName'
      required:
        - name
        - code
        - items
    AudienceLanguage:
      type: object
      properties:
        code:
          type: string
          example: it
        name:
          type: string
          example: Italian
        weight:
          type: number
          example: 0.1
      required:
        - code
        - name
        - weight
    User:
      type: object
      properties:
        userId:
          type: string
          description: User id of the influencer
          example: '173560420'
        fullname:
          type: string
          description: Full name of Influencer
          example: Instagram
        username:
          type: string
          description: Username of Influencer
          example: instagram
        url:
          type: string
          description: Profile URL
          example: https://www.instagram.com/instagram/
        picture:
          type: string
          description: Profile Picture
          example: >-
            https://imgigp.modash.io/?https://scontent-arn2-1.cdninstagram.com/t51.2885-19/s320x320/22159423_1794482210565499_9190891265074397184_n.jpg
        followers:
          type: number
          description: Follower count
          example: 313560626
        engagements:
          type: number
          description: Engagements
          example: 857994
      required:
        - username
        - url
        - picture
        - followers
        - engagements
    AudienceEthnicities:
      type: object
      properties:
        code:
          type: string
          example: white
          enum:
            - white
            - asian
            - african_american
            - hispanic
        name:
          type: string
          example: White / Caucasian
          enum:
            - White / Caucasian
            - Asian
            - African American
            - Hispanic
        weight:
          type: number
          example: 0.1
      required:
        - code
        - name
        - weight
    AudienceReachability:
      type: object
      properties:
        code:
          type: string
          example: 500-1000
          enum:
            - '-500'
            - 500-1000
            - 1000-1500
            - 1500-
          description: Range of the number of accounts followed
        weight:
          type: number
          example: 0.1
          description: Percentage of the audience
      required:
        - code
        - weight
    AudienceType:
      type: object
      properties:
        code:
          type: string
          example: real
          enum:
            - mass_followers
            - suspicious
            - influencers
            - real
          description: Type of the audience
        weight:
          type: number
          example: 0.9
          description: Percentage of the audience
      required:
        - code
        - weight
    InstagramReportAudience:
      type: object
      properties:
        notable:
          type: number
          example: 0.07
        genders:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithCode'
        geoCountries:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithCodeName'
        ages:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithCode'
        gendersPerAge:
          type: array
          items:
            $ref: '#/components/schemas/GenderPerAge'
        geoCities:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithName'
        geoStates:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithName'
        geoSubdivisions:
          type: array
          items:
            $ref: '#/components/schemas/InstagramAudienceSubdivision'
        credibility:
          type: number
          example: 0.75
        interests:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithName'
        brandAffinity:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithName'
        languages:
          type: array
          items:
            $ref: '#/components/schemas/AudienceLanguage'
        notableUsers:
          type: array
          items:
            $ref: '#/components/schemas/User'
        audienceLookalikes:
          type: array
          items:
            $ref: '#/components/schemas/User'
        ethnicities:
          type: array
          items:
            $ref: '#/components/schemas/AudienceEthnicities'
        audienceReachability:
          description: >-
            Percentage of the audience based on the number of accounts they
            follow, categorized into specific ranges. For instance, percentage
            of followers following no more than 500 accounts, or following
            between 500 and 1000 accounts.
          example:
            - code: '-500'
              weight: 0.379536
            - code: 500-1000
              weight: 0.161691
            - code: 1000-1500
              weight: 0.097547
            - code: 1500-
              weight: 0.361225
          type: array
          items:
            $ref: '#/components/schemas/AudienceReachability'
        audienceTypes:
          description: Percentage of the audience based on the type of accounts they follow
          example:
            - code: mass_followers
              weight: 0.379536
            - code: suspicious
              weight: 0.161691
            - code: influencers
              weight: 0.097547
            - code: real
              weight: 0.361225
          type: array
          items:
            $ref: '#/components/schemas/AudienceType'
      required:
        - notable
        - genders
        - geoCountries
        - ages
        - gendersPerAge
        - geoCities
        - geoStates
        - geoSubdivisions
        - credibility
        - interests
        - brandAffinity
        - languages
        - notableUsers
        - audienceLookalikes
        - ethnicities
    StatsData:
      type: object
      properties:
        value:
          type: number
          description: Value
          example: 859004
        compared:
          type: number
          description: Change in value compared to last month
          example: 0.007144320631801482
    Stats:
      type: object
      properties:
        avgLikes:
          description: Average Likes and historical comparison
          allOf:
            - $ref: '#/components/schemas/StatsData'
        followers:
          description: Followers and historical comparison
          allOf:
            - $ref: '#/components/schemas/StatsData'
        avgShares:
          description: Average Shares and historical comparison
          allOf:
            - $ref: '#/components/schemas/StatsData'
        avgComments:
          description: Average Comments and historical comparison
          allOf:
            - $ref: '#/components/schemas/StatsData'
    InstagramRecentPost:
      type: object
      properties:
        id:
          type: string
        text:
          type: string
        url:
          type: string
        created:
          type: string
        likes:
          type: number
        comments:
          type: number
        views:
          type: number
        type:
          type: string
        mentions:
          type: array
          items:
            type: string
        hashtags:
          type: array
          items:
            type: string
      required:
        - id
        - text
        - url
        - created
        - type
    InstagramPopularPost:
      type: object
      properties:
        id:
          type: string
        text:
          type: string
        url:
          type: string
        created:
          type: string
        likes:
          type: number
        comments:
          type: number
        views:
          type: number
        type:
          type: string
        thumbnail:
          type: string
      required:
        - id
        - text
        - url
        - created
        - type
        - thumbnail
    Language:
      type: object
      properties:
        code:
          type: string
          example: en
          enum:
            - af
            - als
            - am
            - an
            - ar
            - arz
            - as
            - ast
            - av
            - az
            - azb
            - ba
            - bar
            - bcl
            - be
            - bg
            - bh
            - bn
            - bo
            - bpy
            - br
            - bs
            - bxr
            - ca
            - cbk
            - ce
            - ceb
            - ckb
            - co
            - cs
            - cv
            - cy
            - da
            - de
            - diq
            - dsb
            - dty
            - dv
            - dz
            - el
            - eml
            - en
            - eo
            - es
            - et
            - eu
            - fa
            - fi
            - fo
            - fr
            - frr
            - fy
            - ga
            - gd
            - gl
            - gn
            - gom
            - gu
            - gv
            - he
            - hi
            - hif
            - hr
            - hsb
            - ht
            - hu
            - hy
            - ia
            - id
            - ie
            - ilo
            - io
            - is
            - it
            - ja
            - jbo
            - jv
            - ka
            - kk
            - km
            - kn
            - ko
            - krc
            - ku
            - kv
            - kw
            - ky
            - la
            - lb
            - lez
            - li
            - lmo
            - lo
            - lrc
            - lt
            - lv
            - mai
            - mg
            - mhr
            - min
            - mk
            - ml
            - mn
            - mr
            - mrj
            - ms
            - mt
            - mwl
            - my
            - myv
            - mzn
            - nah
            - nap
            - nb
            - nds
            - ne
            - new
            - nl
            - nn
            - 'no'
            - oc
            - or
            - os
            - pa
            - pam
            - pfl
            - pl
            - pms
            - pnb
            - ps
            - pt
            - qu
            - rm
            - ro
            - ru
            - rue
            - rw
            - sa
            - sah
            - sc
            - scn
            - sco
            - sd
            - se
            - sh
            - si
            - sk
            - sl
            - so
            - sq
            - sr
            - su
            - sv
            - sw
            - ta
            - te
            - tg
            - th
            - tk
            - tl
            - tr
            - tt
            - tyv
            - ug
            - uk
            - ur
            - uz
            - vec
            - vep
            - vi
            - vls
            - vo
            - wa
            - war
            - wuu
            - xal
            - xh
            - xmf
            - yi
            - yo
            - yue
            - zh
            - zu
        name:
          type: string
          example: English
      required:
        - code
        - name
    Contacts:
      type: object
      properties:
        type:
          type: string
          example: email
          enum:
            - bbm
            - email
            - facebook
            - instagram
            - itunes
            - kakao
            - kik
            - lineid
            - linktree
            - phone
            - pinterest
            - sarahah
            - sayat
            - skype
            - snapchat
            - telegram
            - threads
            - tiktok
            - tumblr
            - twitchtv
            - twitter
            - viber
            - vk
            - wechat
            - weibo
            - whatsapp
            - youtube
        value:
          type: string
          example: influenceremail@example.com
          minLength: 1
      required:
        - type
        - value
    Interest:
      type: object
      properties:
        id:
          type: number
          example: 1
        name:
          type: string
          example: ''
      required:
        - id
        - name
    Brand:
      type: object
      properties:
        id:
          type: number
          example: 1
        name:
          type: string
          example: ''
      required:
        - id
        - name
    PostSponsor:
      type: object
      properties:
        domain:
          type: string
        logo_url:
          type: string
        name:
          type: string
    InstagramSponsoredPost:
      type: object
      properties:
        id:
          type: string
        text:
          type: string
        url:
          type: string
        created:
          type: string
        likes:
          type: number
        comments:
          type: number
        views:
          type: number
        type:
          type: string
        mentions:
          type: array
          items:
            type: string
        hashtags:
          type: array
          items:
            type: string
        video:
          type: string
        image:
          type: string
        thumbnail:
          type: string
        sponsors:
          type: array
          items:
            $ref: '#/components/schemas/PostSponsor'
      required:
        - id
        - text
        - url
        - created
        - type
        - thumbnail
    MonthlyStat:
      type: object
      properties:
        month:
          type: string
          example: 2019-05
        followers:
          type: number
          example: 1000
        following:
          type: number
          example: 1000
        avgLikes:
          type: number
          example: 1000
        avgViews:
          type: number
          example: 1000
        avgComments:
          type: number
          example: 1000
        avgShares:
          type: number
          example: 1000
      required:
        - month
        - followers
        - following
        - avgLikes
        - avgViews
        - avgComments
    FollowersRange:
      type: object
      properties:
        leftNumber:
          type: number
          example: 100000
        rightNumber:
          type: number
          example: 500000
    HistogramBin:
      type: object
      properties:
        min:
          type: number
          description: The lower bound of the range
          example: 0.4546
        max:
          type: number
          description: The upper bound of the range
          example: 0.6482
        total:
          type: number
          description: The total count of data points within this range
          example: 5551
        median:
          type: boolean
          description: >-
            Indicates if this bin represents the median range of the data. Only
            one range has this value set to `true`
          example: true
      required:
        - total
    AudienceExtraInstagramReportData:
      type: object
      properties:
        followersRange:
          description: >-
            All histograms shown here are based on influencers whose number of
            followers fall within the range specified in this field
          allOf:
            - $ref: '#/components/schemas/FollowersRange'
        engagementRateDistribution:
          description: >-
            Distribution of influencers by their followers' engagement rate.
            This histogram displays how influencers from the same follower group
            are distributed based on the engagement rate of their followers.
            Ranges are automatically chosen for a clearer view of the entire
            histogram
          type: array
          items:
            $ref: '#/components/schemas/HistogramBin'
        credibilityDistribution:
          description: >-
            Distribution of influencers by their followers' credibility. This
            histogram displays how influencers from the same follower group are
            distributed based on the credibility of their followers. Ranges are
            automatically chosen for a clearer view of the entire histogram
          type: array
          items:
            $ref: '#/components/schemas/HistogramBin'
      required:
        - followersRange
        - engagementRateDistribution
    InstagramReportProfile:
      type: object
      properties:
        userId:
          type: string
          description: User Id
          example: '173560420'
        profile:
          description: Influencer Profile
          allOf:
            - $ref: '#/components/schemas/InstagramProfileResponse'
        hashtags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        mentions:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        statsByContentType:
          description: User stats separated by content type
          allOf:
            - $ref: '#/components/schemas/StatsByContentTypeInstagram'
        audience:
          description: Audience data
          allOf:
            - $ref: '#/components/schemas/InstagramReportAudience'
        stats:
          description: >-
            Influencer stats, likes and followers (deprecated in favor of
            statsByContentType)
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/Stats'
        recentPosts:
          description: Recent Posts
          example:
            - id: string
              text: string
              url: string
              created: string
              likes: 0
              comments: 0
              mentions:
                - string
              hashtags:
                - string
          type: array
          items:
            $ref: '#/components/schemas/InstagramRecentPost'
        popularPosts:
          description: Popular Posts
          type: array
          items:
            $ref: '#/components/schemas/InstagramPopularPost'
        city:
          type: string
          example: New york
        state:
          type: string
          example: California
        subdivision:
          type: string
          example: New York State
        gender:
          type: string
          example: FEMALE
          enum:
            - MALE
            - FEMALE
        language:
          $ref: '#/components/schemas/Language'
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/Contacts'
        country:
          type: string
          example: US
        ageGroup:
          type: string
          example: 18-24
          enum:
            - 13-17
            - 18-24
            - 25-34
            - 35-44
            - 45-64
            - 65-
        isPrivate:
          type: boolean
          example: true
        accountType:
          type: string
          example: Regular
          enum:
            - Regular
            - Business
            - Creator
        isVerified:
          type: boolean
          example: true
        postsCounts:
          type: number
          example: 37
        avgLikes:
          type: number
          example: 18211
        avgComments:
          type: number
          example: 12321
        bio:
          type: string
          example: 'CEO of #RockTok'
        interests:
          type: array
          items:
            $ref: '#/components/schemas/Interest'
        brandAffinity:
          type: array
          items:
            $ref: '#/components/schemas/Brand'
        sponsoredPosts:
          type: array
          items:
            $ref: '#/components/schemas/InstagramSponsoredPost'
        statHistory:
          type: array
          items:
            $ref: '#/components/schemas/MonthlyStat'
        lookalikes:
          type: array
          items:
            $ref: '#/components/schemas/User'
        postsCount:
          type: number
          example: 37
        avgViews:
          type: number
          example: 48
        avgReelsPlays:
          type: number
          example: 5727
        audienceExtra:
          $ref: '#/components/schemas/AudienceExtraInstagramReportData'
        paidPostPerformance:
          type: number
          example: 0.5
        paidPostPerformanceViews:
          type: number
          example: 37
        sponsoredPostsMedianViews:
          type: number
          example: 3127
        sponsoredPostsMedianLikes:
          type: number
          example: 3743
        nonSponsoredPostsMedianViews:
          type: number
          example: 267
        nonSponsoredPostsMedianLikes:
          type: number
          example: 367
      required:
        - userId
        - hashtags
        - mentions
        - isPrivate
        - accountType
        - isVerified
        - postsCounts
        - avgLikes
        - avgComments
        - bio
        - interests
        - brandAffinity
        - sponsoredPosts
        - statHistory
        - lookalikes
        - postsCount
        - avgViews
        - avgReelsPlays
        - paidPostPerformanceViews
        - sponsoredPostsMedianViews
        - sponsoredPostsMedianLikes
        - nonSponsoredPostsMedianViews
        - nonSponsoredPostsMedianLikes
    InstagramReport:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        profile:
          $ref: '#/components/schemas/InstagramReportProfile'
      required:
        - profile
    CollaborationsPostStats:
      type: object
      properties:
        likes:
          type: number
          description: Likes
          example: 123
        comments:
          type: number
          description: Comments
          example: 12
        likes_and_views_counts_enabled:
          type: boolean
          description: Likes and views counts enabled
          example: true
        likes_count_enabled:
          type: boolean
          description: Likes count enabled
          example: true
        plays:
          type: number
          description: Plays
          example: 123
        views:
          type: number
          description: Views
          example: 123
        shares:
          type: number
          description: Shares
          example: 123
        views_count_enabled:
          type: boolean
          description: Views count enabled
          example: true
    CollaborationsSponsor:
      type: object
      properties:
        name:
          type: string
          description: Brand name
          example: Honda
        domain:
          type: string
          description: Brand domain
          example: honda.com
        logo_url:
          type: string
          description: Brand logo
          example: https://images.od.modash.io/739b39affeb633d30a8a4280668605b091af0083
        user_id:
          type: string
          description: Brand ID
          example: '1234567890'
    CollaborationsPostInfluencerPaginated:
      type: object
      properties:
        post_id:
          type: string
          description: Post id
          example: '4333460164'
        post_thumbnail:
          type: string
          description: Post thumbnail
          example: https://images.od.modash.io/c5175c827bcd7fb6e89a53729b1a2347f0c6210f
        post_timestamp:
          type: number
          description: Post timestamp
          example: 1729502216000
        title:
          type: string
          description: Title
          example: Title
        description:
          type: string
          description: Description
          example: Description
        stats:
          description: Stats
          allOf:
            - $ref: '#/components/schemas/CollaborationsPostStats'
        sponsors:
          description: Sponsors
          type: array
          items:
            $ref: '#/components/schemas/CollaborationsSponsor'
        user_id:
          type: string
          description: User id
          example: '173560420'
        username:
          type: string
          description: Username
          example: username
        user_picture:
          type: string
          description: User picture
          example: https://images.od.modash.io/c5175c827bcd7fb6e89a53729b1a2347f0c6210f
        platform:
          type: string
          description: Platform
          example: instagram
      required:
        - post_id
    CollaborationsInfluencerResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        collaborations:
          description: Collaborations
          type: array
          items:
            $ref: '#/components/schemas/CollaborationsPostInfluencerPaginated'
        more_available:
          type: boolean
        end_cursor:
          type: string
    AudiencerOverlapBody:
      type: object
      properties:
        influencers:
          description: List of usernames or user ids
          type: array
          items:
            type: string
    ReportInfo:
      type: object
      properties:
        totalFollowers:
          type: number
          description: Total followers
        totalUniqueFollowers:
          type: number
          description: Total unique followers
      required:
        - totalFollowers
        - totalUniqueFollowers
    OverlapReport:
      type: object
      properties:
        userId:
          type: string
          minLength: 1
        username:
          type: string
          minLength: 1
        followers:
          type: number
          description: Number of followers for this influencer
        uniquePercentage:
          type: number
          description: >-
            The percent of followers that are unique for this influencer (they
            do not follow any other influencer within this overlap request)
        overlappingPercentage:
          type: number
          description: >-
            The percent of followers that overlap with at least one other
            influencer (they follow at least one other influencer within this
            overlap request)
      required:
        - userId
        - followers
        - uniquePercentage
        - overlappingPercentage
    AudienceOverlapResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        reportInfo:
          $ref: '#/components/schemas/ReportInfo'
        data:
          type: array
          items:
            $ref: '#/components/schemas/OverlapReport'
      required:
        - reportInfo
        - data
    ListBrandsResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        brands:
          type: array
          items:
            $ref: '#/components/schemas/Brand'
        total:
          type: number
          example: 28
          description: Total number of brands
      required:
        - brands
        - total
    ListInterestsResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        interests:
          type: array
          items:
            $ref: '#/components/schemas/Interest'
        total:
          type: number
          example: 28
          description: Total number of interests
      required:
        - interests
        - total
    HashtagsResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        tags:
          type: array
          items:
            type: string
      required:
        - tags
    ListLanguagesResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        languages:
          type: array
          items:
            $ref: '#/components/schemas/Language'
        total:
          type: number
          example: 98
          description: Total number of languages
      required:
        - languages
        - total
    Location:
      type: object
      properties:
        id:
          type: number
          example: 51800
          description: Id of the location
        name:
          type: string
          example: London
          description: Name of the location
        title:
          type: string
          example: London, United Kingdom
          description: Full title of the location
      required:
        - id
        - name
        - title
    ListLocationsResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        locations:
          type: array
          items:
            $ref: '#/components/schemas/Location'
        total:
          type: number
          example: 8477
          description: Total number of locations
      required:
        - locations
        - total
    UserInfluencer:
      type: object
      properties:
        userId:
          type: string
          example: '232192182'
          description: User Id
        username:
          type: string
          example: therock
          description: Username
        fullname:
          type: string
          example: therock
          description: User's full name
        picture:
          type: string
          example: >-
            https://imgigp.modash.io/v2?mb0KwpL92uYofJiSjDn1%2F6peL1lBwv3s%2BUvShHERlDbrEEwrWumIvR20xZeZXa0LDeIrcniqZeG9S%2F1a5s2Rx3FZdXrWpY%2BmSBJp1l%2FmBGon3rcHA4EfuatZqMhVBzAT
          description: User's profile image URL
        followers:
          type: number
          example: 313583625
          description: User's number of followers
        isVerified:
          type: boolean
          example: true
          description: User has verified badge
      required:
        - userId
        - username
        - fullname
        - picture
        - followers
        - isVerified
    ListUsersResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserInfluencer'
      required:
        - users
    TikTokSort:
      type: object
      properties:
        field:
          type: string
          example: followers
          default: followers
          description: "Note: The following sort options are available only when the corresponding filter is applied: `keywords` `audienceGeo` `audienceLang` `audienceGender` `audienceAge` `followersGrowth` `likesGrowth`. <br />\n\t\tSorting field in which order you want to get the results."
          enum:
            - engagements
            - followers
            - engagementRate
            - keywords
            - audienceGeo
            - audienceLang
            - audienceGender
            - audienceAge
            - audienceRelevance
            - relevance
            - followersGrowth
            - views
            - shares
            - saves
            - likesGrowth
        value:
          type: number
          example: 123
          description: Only required for ```audienceGeo``` sorting.
        direction:
          type: string
          example: desc
          default: desc
          description: Sorting direction
          enum:
            - asc
            - desc
      required:
        - field
    ViewsCount:
      type: object
      properties:
        min:
          type: number
          example: 5000
          description: Minimum views count.
        max:
          type: number
          example: 10000
          description: Maximum views count.
    SharesCount:
      type: object
      properties:
        min:
          type: number
          example: 5000
          description: Minimum shares count (this value will be rounded).
        max:
          type: number
          example: 10000
          description: Maximum shares count (this value will be rounded).
    SavesCount:
      type: object
      properties:
        min:
          type: number
          example: 5000
          description: Minimum saves count (this value will be rounded).
        max:
          type: number
          example: 10000
          description: Maximum saves count (this value will be rounded).
    TikTokFilterOperations:
      type: object
      properties:
        operator:
          type: string
          description: >-
            Logical operations used to combine filters.<br><i>Note: To use the
            `or` operator, you must apply it to at least two filters.</i>
          enum:
            - and
            - or
            - not
        filter:
          type: string
          description: >-
            Filter to apply the operation on. If `keywords` or `relevance` are
            specified then you can not sort by these fields.
          enum:
            - followers
            - engagements
            - engagementRate
            - lastposted
            - bio
            - keywords
            - relevance
            - language
            - gender
            - age
            - location
            - isVerified
            - views
            - textTags
      required:
        - operator
        - filter
    TikTokSearchInfluencerFilters:
      type: object
      properties:
        followers:
          example:
            min: 20000
            max: 70000
          description: >-
            We round followers value in the filter: whenever it's below 5k, we
            round it to the nearest thousand (4123 -> 4000; 4800-> 5000); when
            it's over 5k, we round it to the nearest 5,000 (27k -> 25k; 28k ->
            30k).
          allOf:
            - $ref: '#/components/schemas/FollowersCount'
        engagementRate:
          type: number
          description: Minimum engagement rate.
          maximum: 1
          minimum: 0
          example: 0.02
        location:
          example:
            - 148838
            - 62149
            - 80500
            - 1428125
            - 304716
          description: >-
            Filter by Influencer Location, You can get the locations with our
            locations api end point and send location ids in an array.
          maxItems: 20
          type: array
          items:
            type: number
        language:
          type: string
          example: en
          description: >-
            Filter by Influencer Language, You can get the languages code with
            our languages api end point.
          minLength: 1
          maxLength: 3
        lastposted:
          type: number
          example: 90
          description: >-
            Idenitfy influencers based on when they last posted. The number
            represents days and should be >= 30.
          minimum: 30
        relevance:
          example:
            - '#cars'
            - '@topgear'
          description: >-
            Filter by topic of influencers posts or by similarity of topic to
            other influencer. For example "#cars #audi @topgear" means "Writing
            about #cars and #audi, has similar topic as @topgear account."
            <strong>You can only enter 100 usernames.</strong>
          type: array
          items:
            type: string
        audienceRelevance:
          example:
            - '@topgear'
          description: >-
            Filter by similarity of influencer's audience to another
            influencer's audience. For example "@topgear" means "Has audience
            similar to @topgear account." Audience similarity means followers
            follow accounts with the same topics as those followed by @topgear's
            audience.
          type: array
          items:
            type: string
        gender:
          type: string
          example: MALE
          description: Filter by Influencer gender.
          enum:
            - MALE
            - FEMALE
            - KNOWN
            - UNKNOWN
        age:
          description: >-
            Filter by Influencer age, possible values are: 18, 25, 35, 45, 65.
            You have the option to utilize either the `min` field, the `max`
            field, or both concurrently. <strong>Any number that falls outside
            the accepted range will be disregarded.</strong>
          allOf:
            - $ref: '#/components/schemas/InfluencerAgeRange'
        followersGrowthRate:
          description: Growth rate by followers over a period of time.
          example:
            interval: i6months
            value: 0.01
            operator: gt
          allOf:
            - $ref: '#/components/schemas/GrowthFilter'
        bio:
          type: string
          example: photos videos
          description: Search influencer by their bio description and/or full name
        views:
          description: Filter by views count
          allOf:
            - $ref: '#/components/schemas/ViewsCount'
        hasContactDetails:
          description: If Influencer has contact details.
          type: array
          items:
            $ref: '#/components/schemas/ContactFilter'
        textTags:
          example:
            - type: hashtag
              value: carsofinstagram
            - type: mention
              value: topgear
          maxItems: 20
          description: >-
            Filter by influencers who have used the defined hashtags or mentions
            in their posts. 
          type: array
          items:
            $ref: '#/components/schemas/TextTag'
        keywords:
          type: string
          description: >-
            Identify influencers by a phrase they use within the caption of
            their post.
          example: cars
        isVerified:
          type: boolean
          description: Set to `true` to filter by verified influencers.
        likesGrowthRate:
          description: Growth rate by total likes over a period of time.
          example:
            interval: i1month
            value: 0.2
            operator: gt
          allOf:
            - $ref: '#/components/schemas/GrowthFilter'
        shares:
          description: Filter by shares count
          allOf:
            - $ref: '#/components/schemas/SharesCount'
        saves:
          description: Filter by saves count
          allOf:
            - $ref: '#/components/schemas/SavesCount'
        engagements:
          description: Filter by engagements count
          allOf:
            - $ref: '#/components/schemas/EngagementsCount'
        filterOperations:
          description: >-
            Modify filter operation to use `and`, `or`, or `not`. Example:
            Search for <i>influencer using the keyword *cars* AND `not` from the
            London</i> or <i>Female `or` interested in Beauty &
            Cosmetics</i>.<br><i>If no operator is specified, the default
            operator applied is the `and` operator.</i>
          type: array
          items:
            $ref: '#/components/schemas/TikTokFilterOperations'
    TikTokSearchAudienceFilters:
      type: object
      properties:
        location:
          example:
            - id: 148838
              weight: 0.2
            - id: 62149
              weight: 0.2
            - id: 80500
              weight: 0.2
            - id: 1428125
              weight: 0.2
            - id: 304716
              weight: 0.2
          description: >-
            Filter by Audience Location, You can get the locations with our
            locations api end point and send location ids in an array together
            with their weight percentages. The default percentage is set to 20%
            (0.2)
          type: array
          items:
            $ref: '#/components/schemas/LocationWeightedFilter'
        language:
          example:
            id: en
            weight: 0.2
          description: >-
            Filter by Audience Language, You can get the languages code with our
            languages api end point and send the location id within an object,
            together with the weight percentage. The default percentage is set
            to 20% (0.2)
          allOf:
            - $ref: '#/components/schemas/LanguageWeightedFilter'
        gender:
          example:
            id: MALE
            weight: 0.5
          description: >-
            Filter by gender specific Audience, You can send the gender together
            with the weight percentage. The default percentage is set to 50%
            (0.5)
          allOf:
            - $ref: '#/components/schemas/GenderWeightedFilter'
        age:
          example:
            - id: 18-24
              weight: 0.3
            - id: 65-
              weight: 0.3
          description: >-
            Filter by Audience age. You can send the age together with the
            weight percentage. The default percentage is set to 30% (0.3)
          type: array
          items:
            $ref: '#/components/schemas/AgeWeightedFilter'
        ageRange:
          example:
            min: '18'
            max: '24'
            weight: 0.3
          description: >-
            Filter by audience age range. You can send the age range together
            with the weight percentage. The default percentage is set to 30%
            (0.3). You can't send both age and ageRange together.
          allOf:
            - $ref: '#/components/schemas/AudienceAgeRange'
    TikTokSearchFilters:
      type: object
      properties:
        influencer:
          $ref: '#/components/schemas/TikTokSearchInfluencerFilters'
        audience:
          $ref: '#/components/schemas/TikTokSearchAudienceFilters'
    TikTokSearchBody:
      type: object
      properties:
        page:
          type: number
          description: Page number
          default: 0
          minimum: 0
          maximum: 665
        calculationMethod:
          type: string
          example: median
          default: median
          description: >-
            If specified, this indicates the method used to compute
            average-based metrics, such as average number of likes, comments,
            shares, etc.
          enum:
            - median
            - average
        sort:
          description: Sorting
          allOf:
            - $ref: '#/components/schemas/TikTokSort'
        filter:
          $ref: '#/components/schemas/TikTokSearchFilters'
    TiktokProfileResponse:
      type: object
      properties:
        userId:
          type: string
          description: User id of the influencer
          example: '173560420'
        fullname:
          type: string
          description: Full name of Influencer
          example: Instagram
        username:
          type: string
          description: Username of Influencer
          example: instagram
        url:
          type: string
          description: Profile URL
          example: https://www.instagram.com/instagram/
        picture:
          type: string
          description: Profile Picture
          example: >-
            https://imgigp.modash.io/?https://scontent-arn2-1.cdninstagram.com/t51.2885-19/s320x320/22159423_1794482210565499_9190891265074397184_n.jpg
        followers:
          type: number
          description: Follower count
          example: 313560626
        engagements:
          type: number
          description: Engagements
          example: 857994
        engagementRate:
          type: number
          description: Engagement rate
          example: 0.0027362938100525414
        averageViews:
          type: number
          example: 98124
      required:
        - username
        - url
        - picture
        - followers
        - engagements
        - engagementRate
        - averageViews
    TikTokReportAudience:
      type: object
      properties:
        notable:
          type: number
          example: 0.07
        genders:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithCode'
        geoCountries:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithCodeName'
        ages:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithCode'
        gendersPerAge:
          type: array
          items:
            $ref: '#/components/schemas/GenderPerAge'
        languages:
          type: array
          items:
            $ref: '#/components/schemas/AudienceLanguage'
        notableUsers:
          type: array
          items:
            $ref: '#/components/schemas/User'
        audienceLookalikes:
          type: array
          items:
            $ref: '#/components/schemas/User'
        audienceReachability:
          description: >-
            Percentage of the audience based on the number of accounts they
            follow, categorized into specific ranges. For instance, percentage
            of followers following no more than 500 accounts, or following
            between 500 and 1000 accounts.
          example:
            - code: '-500'
              weight: 0.379536
            - code: 500-1000
              weight: 0.161691
            - code: 1000-1500
              weight: 0.097547
            - code: 1500-
              weight: 0.361225
          type: array
          items:
            $ref: '#/components/schemas/AudienceReachability'
      required:
        - notable
        - genders
        - geoCountries
        - ages
        - gendersPerAge
        - languages
        - notableUsers
        - audienceLookalikes
    ContentTypeStatsTiktok:
      type: object
      properties:
        engagements:
          type: number
          example: 0
        engagementRate:
          type: number
          example: 0
        avgLikes:
          type: number
          example: 0
        avgComments:
          type: number
          example: 0
        statHistory:
          type: array
          items:
            $ref: '#/components/schemas/ContentTypeStatsHistory'
        avgViews:
          type: number
          example: 0
        avgShares:
          type: number
          example: 0
        avgPosts4weeks:
          type: number
          example: 0
    StatsByContentTypeTiktok:
      type: object
      properties:
        all:
          example: {}
          description: All content type stats
          allOf:
            - $ref: '#/components/schemas/ContentTypeStatsTiktok'
    TikTokRecentPost:
      type: object
      properties:
        id:
          type: string
        text:
          type: string
        url:
          type: string
        created:
          type: string
        likes:
          type: number
        comments:
          type: number
        views:
          type: number
        type:
          type: string
        video:
          type: string
        thumbnail:
          type: string
          deprecated: true
          example: >-
            https://p16-amd-va.tiktokcdn.com/obj/tos-useast5-p-0068-tx/ogyxG5KtISdEAzSCEzZL4BA7BIij8pf5dwwBli
          description: >-
            Thumbnail images are sent as TikTok URLs that expire in a few hours
            and are not accessible in most cases. This field will be removed
            with the next API version.
      required:
        - id
        - text
        - url
        - created
        - type
        - thumbnail
    AudienceExtraReportData:
      type: object
      properties:
        followersRange:
          description: >-
            All histograms shown here are based on influencers whose number of
            followers fall within the range specified in this field
          allOf:
            - $ref: '#/components/schemas/FollowersRange'
        engagementRateDistribution:
          description: >-
            Distribution of influencers by their followers' engagement rate.
            This histogram displays how influencers from the same follower group
            are distributed based on the engagement rate of their followers.
            Ranges are automatically chosen for a clearer view of the entire
            histogram
          type: array
          items:
            $ref: '#/components/schemas/HistogramBin'
      required:
        - followersRange
        - engagementRateDistribution
    TiktokSponsoredPost:
      type: object
      properties:
        id:
          type: string
        text:
          type: string
        url:
          type: string
        created:
          type: string
        likes:
          type: number
        comments:
          type: number
        views:
          type: number
        type:
          type: string
        video:
          type: string
        thumbnail:
          type: string
        title:
          type: string
        sponsors:
          type: array
          items:
            $ref: '#/components/schemas/PostSponsor'
      required:
        - id
        - text
        - url
        - created
        - type
        - thumbnail
        - title
    TikTokReportProfile:
      type: object
      properties:
        userId:
          type: string
          description: User Id
          example: '173560420'
        profile:
          description: Influencer Profile
          allOf:
            - $ref: '#/components/schemas/TiktokProfileResponse'
        audience:
          description: Audience data
          allOf:
            - $ref: '#/components/schemas/TikTokReportAudience'
        secUid:
          type: string
        statsByContentType:
          description: User stats separated by content type
          allOf:
            - $ref: '#/components/schemas/StatsByContentTypeTiktok'
        recentPosts:
          description: Recent Posts
          type: array
          items:
            $ref: '#/components/schemas/TikTokRecentPost'
        popularPosts:
          description: Popular Posts
          type: array
          items:
            $ref: '#/components/schemas/TikTokRecentPost'
        city:
          type: string
          example: New york
        state:
          type: string
          example: California
        gender:
          type: string
          example: FEMALE
          enum:
            - MALE
            - FEMALE
        statHistory:
          type: array
          items:
            $ref: '#/components/schemas/MonthlyStat'
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/Contacts'
        country:
          type: string
          example: US
        ageGroup:
          type: string
          example: 18-24
          enum:
            - 18-24
            - 25-34
            - 35-44
            - 45-64
            - 65-
        isPrivate:
          type: boolean
          example: true
        isVerified:
          type: boolean
          example: true
        postsCount:
          type: number
          example: 37
        avgLikes:
          type: number
          example: 18211
        totalLikes:
          type: number
          example: 182211
        avgComments:
          type: number
          example: 12321
        bio:
          type: string
          example: 'CEO of #RockTok'
        interests:
          type: array
          items:
            $ref: '#/components/schemas/Interest'
        lookalikes:
          type: array
          items:
            $ref: '#/components/schemas/User'
        audienceExtra:
          $ref: '#/components/schemas/AudienceExtraReportData'
        sponsoredPosts:
          type: array
          items:
            $ref: '#/components/schemas/TiktokSponsoredPost'
        paidPostPerformance:
          type: number
          example: 0.5
        paidPostPerformanceViews:
          type: number
          example: 37
        sponsoredPostsMedianViews:
          type: number
          example: 3127
        sponsoredPostsMedianLikes:
          type: number
          example: 3743
        nonSponsoredPostsMedianViews:
          type: number
          example: 267
        nonSponsoredPostsMedianLikes:
          type: number
          example: 367
      required:
        - userId
        - secUid
        - statHistory
        - isPrivate
        - isVerified
        - postsCount
        - avgLikes
        - totalLikes
        - avgComments
        - bio
        - interests
        - lookalikes
        - sponsoredPosts
        - paidPostPerformanceViews
        - sponsoredPostsMedianViews
        - sponsoredPostsMedianLikes
        - nonSponsoredPostsMedianViews
        - nonSponsoredPostsMedianLikes
    TikTokReport:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        profile:
          $ref: '#/components/schemas/TikTokReportProfile'
      required:
        - profile
    YoutubeSort:
      type: object
      properties:
        field:
          type: string
          example: followers
          default: followers
          description: "Note: The following sort options are available only when the corresponding filter is applied: `keywords` `audienceGeo` `audienceLang` `audienceGender` `audienceAge` `followersGrowth` `viewsGrowth`. <br />\n\t\tSorting field in which order you want to get the results."
          enum:
            - engagements
            - followers
            - engagementRate
            - keywords
            - audienceGeo
            - audienceLang
            - audienceGender
            - audienceAge
            - audienceRelevance
            - relevance
            - followersGrowth
            - views
            - viewsGrowth
        value:
          type: number
          example: 123
          description: Only required for ```audienceGeo``` sorting.
        direction:
          type: string
          example: desc
          default: desc
          description: Sorting direction
          enum:
            - asc
            - desc
      required:
        - field
    YoutubeFilterOperations:
      type: object
      properties:
        operator:
          type: string
          description: >-
            Logical operations used to combine filters.<br><i>Note: To use the
            `or` operator, you must apply it to at least two filters.</i>
          enum:
            - and
            - or
            - not
        filter:
          type: string
          description: >-
            Filter to apply the operation on. If `keywords` or `relevance` are
            specified then you can not sort by these fields.
          enum:
            - followers
            - engagements
            - engagementRate
            - lastposted
            - bio
            - keywords
            - relevance
            - language
            - gender
            - age
            - location
            - isVerified
            - isOfficialArtist
            - views
      required:
        - operator
        - filter
    YouTubeSearchInfluencerFilters:
      type: object
      properties:
        followers:
          example:
            min: 20000
            max: 70000
          description: >-
            We round followers value in the filter: whenever it's below 5k, we
            round it to the nearest thousand (4123 -> 4000; 4800-> 5000); when
            it's over 5k, we round it to the nearest 5,000 (27k -> 25k; 28k ->
            30k).
          allOf:
            - $ref: '#/components/schemas/FollowersCount'
        engagementRate:
          type: number
          description: Minimum engagement rate.
          maximum: 1
          minimum: 0
          example: 0.02
        location:
          example:
            - 148838
            - 62149
            - 80500
            - 1428125
            - 304716
          description: >-
            Filter by Influencer Location, You can get the locations with our
            locations api end point and send location ids in an array.
          maxItems: 20
          type: array
          items:
            type: number
        language:
          type: string
          example: en
          description: >-
            Filter by Influencer Language, You can get the languages code with
            our languages api end point.
          minLength: 1
          maxLength: 3
        lastposted:
          type: number
          example: 90
          description: >-
            Idenitfy influencers based on when they last posted. The number
            represents days and should be >= 30.
          minimum: 30
        relevance:
          example:
            - '#cars'
            - '@topgear'
          description: >-
            Filter by topic of influencers posts or by similarity of topic to
            other influencer. For example "#cars #audi @topgear" means "Writing
            about #cars and #audi, has similar topic as @topgear account."
            <strong>You can only enter 100 usernames.</strong>
          type: array
          items:
            type: string
        audienceRelevance:
          example:
            - '@topgear'
          description: >-
            Filter by similarity of influencer's audience to another
            influencer's audience. For example "@topgear" means "Has audience
            similar to @topgear account." Audience similarity means followers
            follow accounts with the same topics as those followed by @topgear's
            audience.
          type: array
          items:
            type: string
        gender:
          type: string
          example: MALE
          description: Filter by Influencer gender.
          enum:
            - MALE
            - FEMALE
            - KNOWN
            - UNKNOWN
        age:
          description: >-
            Filter by Influencer age, possible values are: 18, 25, 35, 45, 65.
            You have the option to utilize either the `min` field, the `max`
            field, or both concurrently. <strong>Any number that falls outside
            the accepted range will be disregarded.</strong>
          allOf:
            - $ref: '#/components/schemas/InfluencerAgeRange'
        followersGrowthRate:
          description: Growth rate by followers over a period of time.
          example:
            interval: i6months
            value: 0.01
            operator: gt
          allOf:
            - $ref: '#/components/schemas/GrowthFilter'
        bio:
          type: string
          example: photos videos
          description: Search influencer by their bio description and/or full name
        views:
          description: Filter by average views.
          allOf:
            - $ref: '#/components/schemas/ViewsCount'
        hasContactDetails:
          description: If Influencer has contact details.
          type: array
          items:
            $ref: '#/components/schemas/ContactFilter'
        keywords:
          type: string
          description: >-
            Identify influencers by a phrase they use when speaking in their
            videos.
          example: cats
        isVerified:
          type: boolean
          description: Set to `true` to filter by verified influencers.
        isOfficialArtist:
          type: boolean
          description: Filter by isOfficialArtist.
        viewsGrowthRate:
          description: Growth rate by total views over a period of time.
          example:
            interval: i1month
            value: 0.2
            operator: gt
          allOf:
            - $ref: '#/components/schemas/GrowthFilter'
        engagements:
          description: >-
            Filter by engagements count. <i>Pro tip: set `max` to 0 if you want
            to see results with hidden likes.</i>
          allOf:
            - $ref: '#/components/schemas/EngagementsCount'
        filterOperations:
          description: >-
            Modify filter operation to use `and`, `or`, or `not`. Example:
            Search for <i>influencer using the keyword *cars* AND `not` from the
            London</i> or <i>Female `or` interested in Beauty &
            Cosmetics</i>.<br><i>If no operator is specified, the default
            operator applied is the `and` operator.</i>
          type: array
          items:
            $ref: '#/components/schemas/YoutubeFilterOperations'
    YouTubeSearchAudienceFilters:
      type: object
      properties:
        location:
          example:
            - id: 148838
              weight: 0.2
            - id: 62149
              weight: 0.2
            - id: 80500
              weight: 0.2
            - id: 1428125
              weight: 0.2
            - id: 304716
              weight: 0.2
          description: >-
            Filter by Audience Location, You can get the locations with our
            locations api end point and send location ids in an array together
            with their weight percentages. The default percentage is set to 20%
            (0.2)
          type: array
          items:
            $ref: '#/components/schemas/LocationWeightedFilter'
        language:
          example:
            id: en
            weight: 0.2
          description: >-
            Filter by Audience Language, You can get the languages code with our
            languages api end point and send the location id within an object,
            together with the weight percentage. The default percentage is set
            to 20% (0.2)
          allOf:
            - $ref: '#/components/schemas/LanguageWeightedFilter'
        gender:
          example:
            id: MALE
            weight: 0.5
          description: >-
            Filter by gender specific Audience, You can send the gender together
            with the weight percentage. The default percentage is set to 50%
            (0.5)
          allOf:
            - $ref: '#/components/schemas/GenderWeightedFilter'
        age:
          example:
            - id: 18-24
              weight: 0.3
            - id: 65-
              weight: 0.3
          description: >-
            Filter by Audience age. You can send the age together with the
            weight percentage. The default percentage is set to 30% (0.3)
          type: array
          items:
            $ref: '#/components/schemas/AgeWeightedFilter'
        ageRange:
          example:
            min: '18'
            max: '24'
            weight: 0.3
          description: >-
            Filter by audience age range. You can send the age range together
            with the weight percentage. The default percentage is set to 30%
            (0.3). You can't send both age and ageRange together.
          allOf:
            - $ref: '#/components/schemas/AudienceAgeRange'
    YouTubeSearchFilters:
      type: object
      properties:
        influencer:
          $ref: '#/components/schemas/YouTubeSearchInfluencerFilters'
        audience:
          $ref: '#/components/schemas/YouTubeSearchAudienceFilters'
    YouTubeSearchBody:
      type: object
      properties:
        page:
          type: number
          description: Page number
          default: 0
          minimum: 0
          maximum: 665
        calculationMethod:
          type: string
          example: median
          default: median
          description: >-
            If specified, this indicates the method used to compute
            average-based metrics, such as average number of likes, comments,
            shares, etc.
          enum:
            - median
            - average
        sort:
          description: Sorting
          allOf:
            - $ref: '#/components/schemas/YoutubeSort'
        filter:
          $ref: '#/components/schemas/YouTubeSearchFilters'
    YoutubeProfileResponse:
      type: object
      properties:
        userId:
          type: string
          description: User id of the influencer
          example: '173560420'
        fullname:
          type: string
          description: Full name of Influencer
          example: Instagram
        username:
          type: string
          description: Username of Influencer
          example: instagram
        url:
          type: string
          description: Profile URL
          example: https://www.instagram.com/instagram/
        picture:
          type: string
          description: Profile Picture
          example: >-
            https://imgigp.modash.io/?https://scontent-arn2-1.cdninstagram.com/t51.2885-19/s320x320/22159423_1794482210565499_9190891265074397184_n.jpg
        followers:
          type: number
          description: Follower count
          example: 313560626
        engagements:
          type: number
          description: Engagements
          example: 857994
        engagementRate:
          type: number
          description: Engagement rate
          example: 0.0027362938100525414
        averageViews:
          type: number
          example: 98124
        handle:
          type: string
          example: tseries
          description: Unique and short YouTube channel identifier
      required:
        - username
        - url
        - picture
        - followers
        - engagements
        - engagementRate
        - averageViews
    YoutubeInfluencerResponse:
      type: object
      properties:
        userId:
          type: string
          description: User Id
          example: '173560420'
        profile:
          description: Profile info of influencer
          allOf:
            - $ref: '#/components/schemas/YoutubeProfileResponse'
      required:
        - userId
        - profile
    YoutubeSearchResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        total:
          type: number
          description: Number of results
          example: 2
        lookalikes:
          description: Lookalikes
          type: array
          items:
            $ref: '#/components/schemas/YoutubeInfluencerResponse'
        directs:
          description: Directs
          type: array
          items:
            $ref: '#/components/schemas/YoutubeInfluencerResponse'
        isExactMatch:
          type: boolean
          description: >-
            Are the results exactly matching the filters you provided? If we
            don't find exact results then we try to show similar users by
            automatically removing some filters for you.
          example: true
      required:
        - total
        - lookalikes
        - directs
        - isExactMatch
    YoutubeReportAudience:
      type: object
      properties:
        notable:
          type: number
          example: 0.07
        genders:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithCode'
        geoCountries:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithCodeName'
        ages:
          type: array
          items:
            $ref: '#/components/schemas/WeightWithCode'
        gendersPerAge:
          type: array
          items:
            $ref: '#/components/schemas/GenderPerAge'
        languages:
          type: array
          items:
            $ref: '#/components/schemas/AudienceLanguage'
        notableUsers:
          type: array
          items:
            $ref: '#/components/schemas/User'
        audienceLookalikes:
          type: array
          items:
            $ref: '#/components/schemas/User'
      required:
        - notable
        - genders
        - geoCountries
        - ages
        - gendersPerAge
        - languages
        - notableUsers
        - audienceLookalikes
    ContentTypeStatsYoutube:
      type: object
      properties:
        engagements:
          type: number
          example: 0
        engagementRate:
          type: number
          example: 0
        avgLikes:
          type: number
          example: 0
        avgComments:
          type: number
          example: 0
        statHistory:
          type: array
          items:
            $ref: '#/components/schemas/ContentTypeStatsHistory'
        avgViews:
          type: number
          example: 0
        avgPosts4weeks:
          type: number
          example: 0
    StatsByContentTypeYoutube:
      type: object
      properties:
        all:
          example: {}
          description: All content type stats
          allOf:
            - $ref: '#/components/schemas/ContentTypeStatsYoutube'
        videos:
          example: {}
          description: Videos stats
          allOf:
            - $ref: '#/components/schemas/ContentTypeStatsYoutube'
        shorts:
          example: {}
          description: Shorts stats
          allOf:
            - $ref: '#/components/schemas/ContentTypeStatsYoutube'
        streams:
          example: {}
          description: Streams stats
          allOf:
            - $ref: '#/components/schemas/ContentTypeStatsYoutube'
    YoutubeRecentPost:
      type: object
      properties:
        id:
          type: string
        text:
          type: string
        url:
          type: string
        created:
          type: string
        likes:
          type: number
        comments:
          type: number
        views:
          type: number
        type:
          type: string
        video:
          type: string
        thumbnail:
          type: string
        title:
          type: string
      required:
        - id
        - text
        - url
        - created
        - type
        - thumbnail
        - title
    YoutubeSponsoredPost:
      type: object
      properties:
        id:
          type: string
        text:
          type: string
        url:
          type: string
        created:
          type: string
        likes:
          type: number
        comments:
          type: number
        views:
          type: number
        type:
          type: string
        video:
          type: string
        thumbnail:
          type: string
        title:
          type: string
        sponsors:
          type: array
          items:
            $ref: '#/components/schemas/PostSponsor'
      required:
        - id
        - text
        - url
        - created
        - type
        - thumbnail
        - title
    YouTubeReportProfile:
      type: object
      properties:
        userId:
          type: string
          description: User Id
          example: '173560420'
        profile:
          description: Influencer Profile
          allOf:
            - $ref: '#/components/schemas/YoutubeProfileResponse'
        audience:
          description: Audience data
          allOf:
            - $ref: '#/components/schemas/YoutubeReportAudience'
        statsByContentType:
          description: User stats separated by content type
          allOf:
            - $ref: '#/components/schemas/StatsByContentTypeYoutube'
        recentPosts:
          description: Recent Posts
          type: array
          items:
            $ref: '#/components/schemas/YoutubeRecentPost'
        popularPosts:
          description: Popular Posts
          type: array
          items:
            $ref: '#/components/schemas/YoutubeRecentPost'
        city:
          type: string
          example: New york
        state:
          type: string
          example: California
        gender:
          type: string
          example: FEMALE
          enum:
            - MALE
            - FEMALE
        statHistory:
          type: array
          items:
            $ref: '#/components/schemas/MonthlyStat'
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/Contacts'
        country:
          type: string
          example: US
        ageGroup:
          type: string
          example: 18-24
          enum:
            - 18-24
            - 25-34
            - 35-44
            - 45-64
            - 65-
        isVerified:
          type: boolean
          example: true
        postsCount:
          type: number
          example: 37
        avgLikes:
          type: number
          example: 18211
        totalViews:
          type: number
          example: 1821211
        avgComments:
          type: number
          example: 12321
        description:
          type: string
          example: 'CEO of #RockTok'
        interests:
          type: array
          items:
            $ref: '#/components/schemas/Interest'
        audienceCommenters:
          $ref: '#/components/schemas/YoutubeReportAudience'
        lookalikesByTopics:
          type: array
          items:
            $ref: '#/components/schemas/User'
        audienceExtra:
          $ref: '#/components/schemas/AudienceExtraReportData'
        sponsoredPosts:
          type: array
          items:
            $ref: '#/components/schemas/YoutubeSponsoredPost'
        paidPostPerformance:
          type: number
          example: 0.5
        paidPostPerformanceViews:
          type: number
          example: 37
        sponsoredPostsMedianViews:
          type: number
          example: 3127
        sponsoredPostsMedianLikes:
          type: number
          example: 3743
        nonSponsoredPostsMedianViews:
          type: number
          example: 267
        nonSponsoredPostsMedianLikes:
          type: number
          example: 367
      required:
        - userId
        - statHistory
        - postsCount
        - avgLikes
        - totalViews
        - avgComments
        - description
        - interests
        - audienceCommenters
        - lookalikesByTopics
        - sponsoredPosts
        - paidPostPerformanceViews
        - sponsoredPostsMedianViews
        - sponsoredPostsMedianLikes
        - nonSponsoredPostsMedianViews
        - nonSponsoredPostsMedianLikes
    YouTubeReport:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        profile:
          $ref: '#/components/schemas/YouTubeReportProfile'
      required:
        - profile
    YoutubeUserInfluencer:
      type: object
      properties:
        userId:
          type: string
          example: '232192182'
          description: User Id
        username:
          type: string
          example: therock
          description: Username
        fullname:
          type: string
          example: therock
          description: User's full name
        picture:
          type: string
          example: >-
            https://imgigp.modash.io/v2?mb0KwpL92uYofJiSjDn1%2F6peL1lBwv3s%2BUvShHERlDbrEEwrWumIvR20xZeZXa0LDeIrcniqZeG9S%2F1a5s2Rx3FZdXrWpY%2BmSBJp1l%2FmBGon3rcHA4EfuatZqMhVBzAT
          description: User's profile image URL
        followers:
          type: number
          example: 313583625
          description: User's number of followers
        isVerified:
          type: boolean
          example: true
          description: User has verified badge
        handle:
          type: string
          example: tseries
          description: Unique and short YouTube channel identifier
      required:
        - userId
        - username
        - fullname
        - picture
        - followers
        - isVerified
    YoutubeListUsersResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        users:
          type: array
          items:
            $ref: '#/components/schemas/YoutubeUserInfluencer'
      required:
        - users
    EmailsSearchBody:
      type: object
      properties:
        emails:
          description: List of emails to search
          minItems: 1
          maxItems: 1000
          type: array
          items:
            type: string
      required:
        - emails
    MatchedEmailUser:
      type: object
      properties:
        platform:
          type: string
          description: Platform
          example: instagram
        userId:
          type: string
          description: User id of the influencer
          example: '173560420'
        url:
          type: string
          description: URL of Influencer
          example: https://www.instagram.com/instagram/
        username:
          type: string
          description: Username of Influencer
          example: instagram
        fullname:
          type: string
          description: Full name of Influencer
          example: Instagram
        picture:
          type: string
          description: Profile Picture
          example: >-
            https://imgigp.modash.io/?https://scontent-arn2-1.cdninstagram.com/t51.2885-19/s320x320/3232323.jpg
        followers:
          type: number
          description: Follower count
          example: 313560626
        engagements:
          type: number
          description: Engagements
          example: 857994
        engagementRate:
          type: number
          description: Engagement rate
          example: 0.0027362938100525414
        isVerified:
          type: boolean
          description: Is verified
          example: true
      required:
        - platform
        - url
        - username
        - picture
        - followers
        - engagements
        - engagementRate
        - isVerified
    MatchedEmail:
      type: object
      properties:
        email:
          type: string
          description: Email address
          example: example@modash.io
        users:
          description: User details
          type: array
          items:
            $ref: '#/components/schemas/MatchedEmailUser'
      required:
        - email
        - users
    EmailsSearchResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        matchedEmails:
          description: Matches by email
          type: array
          items:
            $ref: '#/components/schemas/MatchedEmail'
        notMatchedEmails:
          description: Emails that were not matched
          type: array
          items:
            type: string
        totalMatches:
          type: number
          description: Number of matched emails
          example: 1
      required:
        - totalMatches
    CollaborationsPostsRequest:
      type: object
      properties:
        id:
          type: string
          description: User ID / Username / Profile URL, User ID is preferred
          example: johndoe
        platform:
          type: string
          enum:
            - instagram
            - tiktok
            - youtube
          example: instagram
        collaboratorId:
          type: string
          description: >-
            If provided, only returns the collaboration posts between the
            specified influencer and brand
        cursor:
          type: string
          description: Cursor for pagination (only valid for 2 days)
        limit:
          type: number
          description: Number of collaboration posts per page
          minimum: 1
          maximum: 30
          default: 30
        groupBrandCollaborations:
          type: boolean
          default: true
          description: >-
            If true, brand collaborations will be grouped across all platforms.
            This provides insights about the brand across all its social
            accounts.


            For example: if you request brand collaborations for @cocacola on
            Instagram, you will get posts sponsored by Coca Cola on all three
            platforms (Instagram, Tiktok and Youtube).


            Note: In some cases, this may group regional or variant accounts
            (e.g., @cocacola_uk, @cocacola_us) when they represent the same
            brand identity. Set this flag to false if social media
            account-specific insights are needed.
      required:
        - id
        - platform
    CollaborationsPost:
      type: object
      properties:
        post_id:
          type: string
          description: Post id
          example: '4333460164'
        post_thumbnail:
          type: string
          description: Post thumbnail
          example: https://images.od.modash.io/c5175c827bcd7fb6e89a53729b1a2347f0c6210f
        post_timestamp:
          type: number
          description: Post timestamp
          example: 1729502216000
        title:
          type: string
          description: Title
          example: Title
        description:
          type: string
          description: Description
          example: Description
        stats:
          description: Stats
          allOf:
            - $ref: '#/components/schemas/CollaborationsPostStats'
        sponsors:
          description: Sponsors
          type: array
          items:
            $ref: '#/components/schemas/CollaborationsSponsor'
      required:
        - post_id
    CollaborationsPostsInfluencer:
      type: object
      properties:
        id:
          type: string
          description: User ID / Username / Profile URL
          example: johndoe
        platform:
          type: string
          enum:
            - instagram
            - tiktok
            - youtube
          example: instagram
        is_more_available:
          type: boolean
          description: True if there are more collaboration posts available
        username:
          type: string
          description: Username
          example: username
        user_picture:
          type: string
          description: Influencer user picture
          example: https://images.od.modash.io/c5175c827bcd7fb6e89a53729b1a2347f0c6210f
        posts:
          description: List of collaboration posts
          type: array
          items:
            $ref: '#/components/schemas/CollaborationsPost'
      required:
        - id
        - platform
    CollaborationsPostBrand:
      type: object
      properties:
        post_id:
          type: string
          description: Post id
          example: '4333460164'
        post_thumbnail:
          type: string
          description: Post thumbnail
          example: https://images.od.modash.io/c5175c827bcd7fb6e89a53729b1a2347f0c6210f
        post_timestamp:
          type: number
          description: Post timestamp
          example: 1729502216000
        title:
          type: string
          description: Title
          example: Title
        description:
          type: string
          description: Description
          example: Description
        stats:
          description: Stats
          allOf:
            - $ref: '#/components/schemas/CollaborationsPostStats'
        sponsors:
          description: Sponsors
          type: array
          items:
            $ref: '#/components/schemas/CollaborationsSponsor'
        user_id:
          type: string
          description: User id
          example: '173560420'
        platform:
          type: string
          description: Platform
          example: instagram
      required:
        - post_id
    CollaborationsPostsBrand:
      type: object
      properties:
        id:
          type: string
          description: User ID / Username / Profile URL
          example: johndoe
        platform:
          type: string
          enum:
            - instagram
            - tiktok
            - youtube
          example: instagram
        is_more_available:
          type: boolean
          description: True if there are more collaboration posts available
        brand_name:
          type: string
          description: Brand name
        brand_domain:
          type: string
          description: Brand domain
        brand_logo:
          type: string
          description: Brand logo
        posts:
          description: Posts
          type: array
          items:
            $ref: '#/components/schemas/CollaborationsPostBrand'
      required:
        - id
        - platform
    CollaborationsPostsResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        cursor:
          type: string
          description: Cursor for pagination (only valid for 2 days)
        influencer:
          description: >-
            Only available if the requested profile has influencer
            collaborations
          allOf:
            - $ref: '#/components/schemas/CollaborationsPostsInfluencer'
        brand:
          description: Only available if the requested profile has brand collaborations
          allOf:
            - $ref: '#/components/schemas/CollaborationsPostsBrand'
    CollaborationsNotFoundResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
    CollaborationsSummaryRequest:
      type: object
      properties:
        id:
          type: string
          description: User ID / Username / Profile URL, User ID is preferred
          example: johndoe
        platform:
          type: string
          enum:
            - instagram
            - tiktok
            - youtube
          example: instagram
        collaboratorId:
          type: string
          description: >-
            If provided, only returns the collaboration summary between the
            specified influencer and brand
        cursor:
          type: string
          description: Cursor for pagination (only valid for 2 days)
        limit:
          type: number
          description: Number of collaboration summaries per page
          minimum: 1
          maximum: 10
          default: 10
        groupBrandCollaborations:
          type: boolean
          default: true
          description: >-
            If true, brand collaborations summaries will be grouped across all
            platforms. This provides insights about the brand across all its
            social accounts.


            For example: if you request brand collaborations summary for
            @cocacola on Instagram, you will get collaboration summary for posts
            sponsored by Coca Cola on all three platforms (Instagram, Tiktok and
            Youtube).


            Note: In some cases, this may group regional or variant accounts
            (e.g., @cocacola_uk, @cocacola_us) when they represent the same
            brand identity. Set this flag to false if social media
            account-specific insights are needed.
      required:
        - id
        - platform
    InstagramSummary:
      type: object
      properties:
        total_distinct_posts:
          type: number
        total_collaborations:
          type: number
        total_plays:
          type: number
        total_views:
          type: number
        total_likes:
          type: number
        total_comments:
          type: number
    InfluencerSummaryInstagram:
      type: object
      properties:
        total_collaborations:
          type: number
        first_collaboration_timestamp:
          type: number
        last_collaboration_timestamp:
          type: number
        feed_photo:
          $ref: '#/components/schemas/InstagramSummary'
        feed_video:
          $ref: '#/components/schemas/InstagramSummary'
        reels_photo:
          $ref: '#/components/schemas/InstagramSummary'
        reels_video:
          $ref: '#/components/schemas/InstagramSummary'
        total_distinct_posts:
          type: number
        total_distinct_brands:
          type: number
    TiktokSummary:
      type: object
      properties:
        total_distinct_posts:
          type: number
        total_collaborations:
          type: number
        total_likes:
          type: number
        total_comments:
          type: number
        total_views:
          type: number
        total_shares:
          type: number
        total_collects:
          type: number
    InfluencerSummaryTiktok:
      type: object
      properties:
        total_collaborations:
          type: number
        first_collaboration_timestamp:
          type: number
        last_collaboration_timestamp:
          type: number
        photo:
          $ref: '#/components/schemas/TiktokSummary'
        video:
          $ref: '#/components/schemas/TiktokSummary'
        total_distinct_posts:
          type: number
        total_distinct_brands:
          type: number
    YoutubeSummary:
      type: object
      properties:
        total_distinct_posts:
          type: number
        total_collaborations:
          type: number
        total_likes:
          type: number
        total_comments:
          type: number
        total_views:
          type: number
    InfluencerSummaryYoutube:
      type: object
      properties:
        total_collaborations:
          type: number
        first_collaboration_timestamp:
          type: number
        last_collaboration_timestamp:
          type: number
        short:
          $ref: '#/components/schemas/YoutubeSummary'
        video:
          $ref: '#/components/schemas/YoutubeSummary'
        total_distinct_posts:
          type: number
        total_distinct_brands:
          type: number
    BaseInstagramSummary:
      type: object
      properties:
        total_collaborations:
          type: number
        first_collaboration_timestamp:
          type: number
        last_collaboration_timestamp:
          type: number
        feed_photo:
          $ref: '#/components/schemas/InstagramSummary'
        feed_video:
          $ref: '#/components/schemas/InstagramSummary'
        reels_photo:
          $ref: '#/components/schemas/InstagramSummary'
        reels_video:
          $ref: '#/components/schemas/InstagramSummary'
    BaseTiktokSummary:
      type: object
      properties:
        total_collaborations:
          type: number
        first_collaboration_timestamp:
          type: number
        last_collaboration_timestamp:
          type: number
        photo:
          $ref: '#/components/schemas/TiktokSummary'
        video:
          $ref: '#/components/schemas/TiktokSummary'
    BaseYoutubeSummary:
      type: object
      properties:
        total_collaborations:
          type: number
        first_collaboration_timestamp:
          type: number
        last_collaboration_timestamp:
          type: number
        short:
          $ref: '#/components/schemas/YoutubeSummary'
        video:
          $ref: '#/components/schemas/YoutubeSummary'
    InfluencerPerBrandSummary:
      type: object
      properties:
        brand:
          description: Brand data
          allOf:
            - $ref: '#/components/schemas/CollaborationsSponsor'
        summary:
          oneOf:
            - $ref: '#/components/schemas/BaseInstagramSummary'
            - $ref: '#/components/schemas/BaseTiktokSummary'
            - $ref: '#/components/schemas/BaseYoutubeSummary'
          description: >-
            Performance summary for collaborations between the influencer and
            the brand
      required:
        - brand
        - summary
    CollaborationsSummaryInfluencer:
      type: object
      properties:
        id:
          type: string
          description: User ID / Username / Profile URL
          example: johndoe
        platform:
          type: string
          enum:
            - instagram
            - tiktok
            - youtube
          example: instagram
        is_more_available:
          type: boolean
          description: >-
            True if there are more per-brand / per-influencer collaboration
            summmaries available
        summary:
          oneOf:
            - $ref: '#/components/schemas/InfluencerSummaryInstagram'
            - $ref: '#/components/schemas/InfluencerSummaryTiktok'
            - $ref: '#/components/schemas/InfluencerSummaryYoutube'
          description: Influencer collaboration summary for all brands
        per_brand_summary:
          description: Influencer summary for collaborations with specific brands
          type: array
          items:
            $ref: '#/components/schemas/InfluencerPerBrandSummary'
      required:
        - id
        - platform
        - summary
        - per_brand_summary
    BrandSummaryInstagram:
      type: object
      properties:
        total_collaborations:
          type: number
        first_collaboration_timestamp:
          type: number
        last_collaboration_timestamp:
          type: number
        feed_photo:
          $ref: '#/components/schemas/InstagramSummary'
        feed_video:
          $ref: '#/components/schemas/InstagramSummary'
        reels_photo:
          $ref: '#/components/schemas/InstagramSummary'
        reels_video:
          $ref: '#/components/schemas/InstagramSummary'
        total_distinct_posts:
          type: number
        total_distinct_influencers:
          type: number
    BrandSummaryTiktok:
      type: object
      properties:
        total_collaborations:
          type: number
        first_collaboration_timestamp:
          type: number
        last_collaboration_timestamp:
          type: number
        photo:
          $ref: '#/components/schemas/TiktokSummary'
        video:
          $ref: '#/components/schemas/TiktokSummary'
        total_distinct_posts:
          type: number
        total_distinct_influencers:
          type: number
    BrandSummaryYoutube:
      type: object
      properties:
        total_collaborations:
          type: number
        first_collaboration_timestamp:
          type: number
        last_collaboration_timestamp:
          type: number
        short:
          $ref: '#/components/schemas/YoutubeSummary'
        video:
          $ref: '#/components/schemas/YoutubeSummary'
        total_distinct_posts:
          type: number
        total_distinct_influencers:
          type: number
    CollaborationsInfluencer:
      type: object
      properties:
        username:
          type: string
          description: Influencer username
        user_id:
          type: string
          description: Influencer user ID
        user_picture:
          type: string
          description: Influencer user picture
    BrandPerInfluencerSummary:
      type: object
      properties:
        influencer:
          description: Influencer data
          allOf:
            - $ref: '#/components/schemas/CollaborationsInfluencer'
        summary:
          oneOf:
            - $ref: '#/components/schemas/BaseInstagramSummary'
            - $ref: '#/components/schemas/BaseTiktokSummary'
            - $ref: '#/components/schemas/BaseYoutubeSummary'
          description: >-
            Performance summary for collaborations between the brand and the
            influencer
      required:
        - influencer
        - summary
    CollaborationsSummaryBrand:
      type: object
      properties:
        id:
          type: string
          description: User ID / Username / Profile URL
          example: johndoe
        platform:
          type: string
          enum:
            - instagram
            - tiktok
            - youtube
          example: instagram
        is_more_available:
          type: boolean
          description: >-
            True if there are more per-brand / per-influencer collaboration
            summmaries available
        summary:
          oneOf:
            - $ref: '#/components/schemas/BrandSummaryInstagram'
            - $ref: '#/components/schemas/BrandSummaryTiktok'
            - $ref: '#/components/schemas/BrandSummaryYoutube'
          description: Brand collaboration summary for all influencers
        per_influencer_summary:
          description: Brand summary for collaborations with specific influencers
          type: array
          items:
            $ref: '#/components/schemas/BrandPerInfluencerSummary'
      required:
        - id
        - platform
        - summary
        - per_influencer_summary
    CollaborationsSummaryResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        cursor:
          type: string
          description: Cursor for pagination (only valid for 2 days)
        influencer:
          description: >-
            Only available if the requested profile has influencer
            collaborations
          allOf:
            - $ref: '#/components/schemas/CollaborationsSummaryInfluencer'
        brand:
          description: Only available if the requested profile has brand collaborations
          allOf:
            - $ref: '#/components/schemas/CollaborationsSummaryBrand'
    AiSearchFiltersFollowers:
      type: object
      properties:
        min:
          type: number
          description: >-
            Minimum followers count. Number will be approximated to the nearest
            range lower or equal to the given number. Ranges are: 1000, 3000,
            5000, 10000, 15000, 20000, 25000, 35000, 50000, 75000, 100000,
            125000, 150000, 175000, 200000, 250000, 300000, 350000, 500000,
            1000000, 2000000, 3000000.
        max:
          type: number
          description: >-
            Maximum followers count. Number will be approximated to the nearest
            range higher or equal to the given number. Ranges are: 1000, 3000,
            5000, 10000, 15000, 20000, 25000, 35000, 50000, 75000, 100000,
            125000, 150000, 175000, 200000, 250000, 300000, 350000, 500000,
            1000000, 2000000, 3000000.
    AiSearchFiltersAge:
      type: object
      properties:
        min:
          type: string
          description: Minimum age range
          enum:
            - '13'
            - '18'
            - '25'
            - '35'
            - '45'
            - '65'
        max:
          type: string
          description: Maximum age range
          enum:
            - '18'
            - '25'
            - '35'
            - '45'
            - '65'
    AiSearchFiltersEngagementRate:
      type: object
      properties:
        min:
          type: number
          description: Minimum engagement rate (in percentage, 0.01 = 1%)
          example: 0.01
    AiSearchFilters:
      type: object
      properties:
        followersCount:
          description: Filter by followers count
          allOf:
            - $ref: '#/components/schemas/AiSearchFiltersFollowers'
        locations:
          description: >-
            Filter by locations (use <a target="_blank"
            href="/products/discovery_api/openapi_doc/discovery/instagram/instagramcontroller_locations">Locations
            dictionary endpoint</a> to get the location IDs)
          minItems: 1
          maxItems: 100
          type: array
          items:
            type: number
        gender:
          type: string
          description: Filter by gender; KNOWN -> male or female, UNKNOWN -> gender neutral
          enum:
            - MALE
            - FEMALE
            - KNOWN
            - UNKNOWN
        lastPostedInDays:
          type: number
          description: >-
            Filter by influencers with latest post date, in days. P.S. we update
            profiles every 4 weeks and this lag should be considered when using
            this field.
          example: 90
        accountType:
          type: string
          description: Filter by account type
          enum:
            - creator
            - brand
        language:
          type: string
          description: >-
            Filter by language (use <a target="_blank"
            href="/products/discovery_api/openapi_doc/discovery/instagram/instagramcontroller_languages">Languages
            dictionary endpoint</a> to get the language IDs)
        age:
          description: Filter by age range
          allOf:
            - $ref: '#/components/schemas/AiSearchFiltersAge'
        engagementRate:
          description: Filter by engagement rate
          allOf:
            - $ref: '#/components/schemas/AiSearchFiltersEngagementRate'
        hasEmail:
          type: boolean
          description: Filter by whether the influencer has an email
        brands:
          description: >-
            Filter by brands (Use AI search's <a target="_blank"
            href="/products/discovery_api/openapi_doc/discovery/ai-search/aisearchcontroller_brandsdictionary">Brand
            Dictionary endpoint</a> to get the brand names. P.S. this is a
            different endpoint than existing Brand Dictionary endpoint).
          minItems: 1
          maxItems: 4
          type: array
          items:
            type: string
    TextAiSearchRequest:
      type: object
      properties:
        page:
          type: number
          description: Page number, each page contains max. 6 results
          default: 0
          minimum: 0
        filters:
          description: Additional filters to refine the search results
          allOf:
            - $ref: '#/components/schemas/AiSearchFilters'
        query:
          type: string
          description: >-
            Example: woman with curly hair lifting weights. Queries can be sent
            in any language, but English yields the best results. Limit: 1024
            characters or 64 words. If omitted, results are sorted by follower
            count.
          example: woman with curly hair lifting weights
          minLength: 1
          maxLength: 1024
    AiSearchPostStats:
      type: object
      properties:
        likesCount:
          type: number
          description: Likes count; -1 if likes count is hidden
        commentsCount:
          type: number
          description: Comments count; -1 if comments count is hidden
        playsCount:
          type: number
          description: Plays count
      required:
        - likesCount
        - commentsCount
        - playsCount
    AiSearchPost:
      type: object
      properties:
        id:
          type: string
          description: Post ID
        url:
          type: string
          description: Post URL
        thumbnail:
          type: string
          description: Post thumbnail URL
        stats:
          description: Post statistics
          allOf:
            - $ref: '#/components/schemas/AiSearchPostStats'
      required:
        - id
        - url
        - thumbnail
        - stats
    AiSearchProfile:
      type: object
      properties:
        userId:
          type: string
          description: User ID
          example: '173560420'
        fullName:
          type: string
          description: Full name
          example: Instagram
        username:
          type: string
          description: Username
          example: instagram
        profilePicture:
          type: string
          description: Profile Picture
          example: >-
            https://imgigp.modash.io/22159423_1794482210565499_9190891265074397184_n.jpg
        followersCount:
          type: number
          description: Followers count
          example: 313560626
        engagementRate:
          type: number
          description: Engagement rate
          example: 0.01
        accountCategory:
          type: string
          description: Account category
          example: Sportsperson / Digital creator etc.
        matchedPosts:
          description: Posts ordered by relevance to the search query
          type: array
          items:
            $ref: '#/components/schemas/AiSearchPost'
        recentPosts:
          description: >-
            Recent posts (not necessarily relevant to the search query). P.S. we
            update profiles every 4 weeks and this lag should be considered when
            using this field.
          type: array
          items:
            $ref: '#/components/schemas/AiSearchPost'
      required:
        - username
        - profilePicture
        - followersCount
        - engagementRate
        - accountCategory
        - matchedPosts
        - recentPosts
    AiSearchResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        total:
          type: number
          description: Total number of profiles matching the search query
        profiles:
          description: List of influencer profiles matching the search query and filters
          type: array
          items:
            $ref: '#/components/schemas/AiSearchProfile'
      required:
        - total
        - profiles
    ImageAiSearchRequest:
      type: object
      properties:
        page:
          type: number
          description: Page number, each page contains max. 6 results
          default: 0
          minimum: 0
        filters:
          description: Additional filters to refine the search results
          allOf:
            - $ref: '#/components/schemas/AiSearchFilters'
        imageType:
          type: string
          description: Image type
          enum:
            - image/jpeg
            - image/png
            - image/webp
        base64Image:
          type: string
          description: Image (base64 encoded), max size 5MB
          format: base64
          maxLength: 6990507
      required:
        - imageType
        - base64Image
    TTAiSearchPostStats:
      type: object
      properties:
        likesCount:
          type: number
          description: Likes count
        commentsCount:
          type: number
          description: Comments count
        sharesCount:
          type: number
          description: Shares count
        playsCount:
          type: number
          description: Plays count
        collectsCount:
          type: number
          description: Collects count
      required:
        - likesCount
        - commentsCount
        - sharesCount
        - playsCount
        - collectsCount
    TTAiSearchPost:
      type: object
      properties:
        id:
          type: string
          description: Post ID
        url:
          type: string
          description: Post URL
        thumbnail:
          type: string
          description: Post thumbnail URL
        stats:
          description: Post statistics
          allOf:
            - $ref: '#/components/schemas/TTAiSearchPostStats'
      required:
        - id
        - url
        - thumbnail
        - stats
    TTAiSearchProfile:
      type: object
      properties:
        userId:
          type: string
          description: User ID
          example: '173560420'
        fullName:
          type: string
          description: Full name
          example: Instagram
        username:
          type: string
          description: Username
          example: instagram
        profilePicture:
          type: string
          description: Profile Picture
          example: >-
            https://imgigp.modash.io/22159423_1794482210565499_9190891265074397184_n.jpg
        followersCount:
          type: number
          description: Followers count
          example: 313560626
        engagementRate:
          type: number
          description: Engagement rate
          example: 0.01
        accountCategory:
          type: string
          description: Account category
          example: Sportsperson / Digital creator etc.
        matchedPosts:
          description: Posts ordered by relevance to the search query
          type: array
          items:
            $ref: '#/components/schemas/TTAiSearchPost'
        recentPosts:
          description: >-
            Recent posts (not necessarily relevant to the search query). P.S. we
            update profiles every 4 weeks and this lag should be considered when
            using this field.
          type: array
          items:
            $ref: '#/components/schemas/TTAiSearchPost'
      required:
        - username
        - profilePicture
        - followersCount
        - engagementRate
        - accountCategory
        - matchedPosts
        - recentPosts
    TTAiSearchResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        total:
          type: number
          description: Total number of profiles matching the search query
        profiles:
          description: List of influencer profiles matching the search query and filters
          type: array
          items:
            $ref: '#/components/schemas/TTAiSearchProfile'
      required:
        - total
        - profiles
    BrandsDictionaryBrandAccount:
      type: object
      properties:
        platform:
          type: string
          description: Platform
          enum:
            - instagram
            - tiktok
            - youtube
        userId:
          type: string
          description: Brand user ID, not available for Youtube
        username:
          type: string
          description: Brand username, not available for Youtube
        domain:
          type: string
          description: >-
            Brand domain (if we do not have the domain then we return the
            brand's profile URL instead)
      required:
        - platform
        - domain
    BrandsDictionaryBrand:
      type: object
      properties:
        name:
          type: string
          description: Brand name
        logoUrl:
          type: string
          description: Brand logo URL
        accounts:
          description: Social platform accounts related to the brand
          type: array
          items:
            $ref: '#/components/schemas/BrandsDictionaryBrandAccount'
      required:
        - name
        - logoUrl
        - accounts
    BrandsDictionaryResponse:
      type: object
      properties:
        error:
          type: boolean
          description: If there is an error
          example: false
        result:
          description: List of top 5 brands based on the search query
          type: array
          items:
            $ref: '#/components/schemas/BrandsDictionaryBrand'
      required:
        - result
security:
  - accessToken: []
