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

# Profile

> Scrapes a public TikTok profile

<Note>
  💳 **1 credit** per request
</Note>


## OpenAPI

````yaml GET /v1/scrape/tiktok/profile
openapi: 3.1.0
info:
  title: SociaVault API
  version: 1.0.0
  description: >-
    # SociaVault API Documentation


    The SociaVault API provides comprehensive access to social media data
    extraction across multiple platforms.


    ## Features


    - **Multi-Platform Support**: TikTok, Instagram, YouTube, Facebook, Twitter,
    Reddit, Threads, and more

    - **Credit-Based System**: Pay-as-you-go pricing with transparent credit
    costs

    - **High Performance**: Fast, reliable data extraction

    - **Comprehensive Data**: Detailed user profiles, videos, posts, comments,
    and analytics


    ## Authentication


    All API requests require authentication using an API key in the `X-API-Key`
    header:


    ```bash

    X-API-Key: sk_live_your_api_key_here

    ```


    Get your API key from the [SociaVault
    Dashboard](https://sociavault.com/dashboard).


    ## Credits


    Each endpoint consumes credits based on data complexity:

    - Simple requests (profiles): 1 credit

    - Complex requests (demographics): 20+ credits

    - Paginated requests: Credits per page


    Check your credit balance in the dashboard or via the API.


    ## Support


    - **Documentation**: https://docs.sociavault.com

    - **Email**: support@sociavault.com

    - **Discord**: https://discord.gg/sociavault
  contact:
    name: SociaVault Support
    email: support@sociavault.com
    url: https://sociavault.com/support
  license:
    name: Commercial
    url: https://sociavault.com/terms
servers:
  - url: https://api.sociavault.com
    description: Production API
security:
  - ApiKeyAuth: []
tags:
  - name: account
    description: Account management and credit balance
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/account
  - name: tiktok
    description: Scrape TikTok profiles, videos, and more
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/tiktok
  - name: tiktok-shop
    description: Everything about TikTok Shop
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/tiktok-shop
  - name: instagram
    description: Gets Instagram profiles, posts, and reels
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/instagram
  - name: youtube
    description: Scrape YouTube channels, videos, and more
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/youtube
  - name: linkedin
    description: Scrape LinkedIn
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/linkedin
  - name: facebook
    description: Get public Facebook profiles and posts
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/facebook
  - name: facebookAdLibrary
    description: Scrapes the Facebook (Meta) Ad Library
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/facebookAdLibrary
  - name: facebookMarketplace
    description: Search Facebook Marketplace and pull full listing details
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/facebookMarketplace
  - name: googleAdLibrary
    description: >-
      Scrape the Google Ad Transparency Library. *This only gets the public ads.
      Some ads you need to log in for and sadly we can't get those. Also, since
      there are so many variations, the return types might not all be 100% the
      same.
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/googleAdLibrary
  - name: linkedinAdLibrary
    description: Search the LinkedIn Ad Library
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/linkedinAdLibrary
  - name: twitter
    description: Get Twitter profiles, tweets, followers and more
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/twitter
  - name: reddit
    description: Scrape Reddit posts and comments
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/reddit
  - name: threads
    description: Get Threads posts
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/threads
  - name: google
    description: Scrape Google search results
    externalDocs:
      description: Learn more
      url: https://docs.sociavault.com/platforms/google
paths:
  /v1/scrape/tiktok/profile:
    get:
      tags:
        - tiktok
      summary: Profile
      description: Scrapes a public TikTok profile
      operationId: tiktok_Profile
      parameters:
        - name: handle
          in: query
          description: TikTok handle
          required: true
          schema:
            type: string
            example: stoolpresidente
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                success: true
                data:
                  success: true
                  user:
                    id: '6659752019493208069'
                    shortId: ''
                    uniqueId: stoolpresidente
                    nickname: Dave Portnoy
                    avatarLarger: >-
                      https://p19-common-sign.tiktokcdn-us.com/tos-maliva-avt-0068/7310178711609032710~tplv-tiktokx-cropcenter:1080:1080.jpeg
                    avatarMedium: >-
                      https://p16-common-sign.tiktokcdn-us.com/tos-maliva-avt-0068/7310178711609032710~tplv-tiktokx-cropcenter:720:720.jpeg
                    avatarThumb: >-
                      https://p19-common-sign.tiktokcdn-us.com/tos-maliva-avt-0068/7310178711609032710~tplv-tiktokx-cropcenter:100:100.jpeg
                    signature: El Presidente/Barstool Sports Founder.
                    createTime: 1550594547
                    verified: true
                    secUid: >-
                      MS4wLjABAAAAINC_ElRR-l1RCcnEjOZhNO-9wOzAMf-YHXqRY8vvG9bEhMRa6iu23TaE3JPZYXBD
                    ftc: false
                    relation: 0
                    openFavorite: false
                    bioLink:
                      link: https://youtu.be/lN0jRqTlGeU?si=JLcTbGpgEPQUeDaC
                      risk: 0
                    commentSetting: 0
                    commerceUserInfo:
                      commerceUser: false
                    duetSetting: 0
                    stitchSetting: 0
                    privateAccount: false
                    secret: false
                    isADVirtual: false
                    roomId: ''
                    uniqueIdModifyTime: 0
                    ttSeller: false
                    downloadSetting: 0
                    profileTab:
                      showMusicTab: false
                      showQuestionTab: false
                      showPlayListTab: true
                    followingVisibility: 1
                    recommendReason: ''
                    nowInvitationCardUrl: ''
                    nickNameModifyTime: 0
                    isEmbedBanned: false
                    canExpPlaylist: true
                    profileEmbedPermission: 1
                    language: en
                    eventList: {}
                    suggestAccountBind: false
                    isOrganization: 0
                    UserStoryStatus: 0
                  stats:
                    followerCount: 4600000
                    followingCount: 90
                    heart: 217600000
                    heartCount: 217600000
                    videoCount: 2329
                    diggCount: 0
                    friendCount: 61
                  statsV2:
                    followerCount: '4567606'
                    followingCount: '90'
                    heart: '217637994'
                    heartCount: '217637994'
                    videoCount: '2329'
                    diggCount: '0'
                    friendCount: '61'
                  itemList: {}
                credits_used: 1
                endpoint: tiktok/profile
              schema:
                type: object
                properties:
                  user:
                    type: object
                    properties:
                      id:
                        type: string
                        example: '6659752019493208069'
                      shortId:
                        type: string
                        example: ''
                      uniqueId:
                        type: string
                        example: stoolpresidente
                      nickname:
                        type: string
                        example: Dave Portnoy
                      avatarLarger:
                        type: string
                        example: >-
                          https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/7310178711609032710~c5_1080x1080.jpeg?lk3s=a5d48078&nonce=58494&refresh_token=466ff0b92ed2f51170dbbdc2a30b9e9a&x-expires=1737921600&x-signature=uZnt1AjbwQ5pMTWNSV5hqw8QhMM%3D&shp=a5d48078&shcp=81f88b70
                      avatarMedium:
                        type: string
                        example: >-
                          https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/7310178711609032710~c5_720x720.jpeg?lk3s=a5d48078&nonce=18587&refresh_token=4c5e30ff3fe99ca813d9f79d74c41fb1&x-expires=1737921600&x-signature=6ropsZzca3J6jx%2BH49D%2BAgxMoe4%3D&shp=a5d48078&shcp=81f88b70
                      avatarThumb:
                        type: string
                        example: >-
                          https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/7310178711609032710~c5_100x100.jpeg?lk3s=a5d48078&nonce=56685&refresh_token=52483b418cbeceeaf2863a9fe0feb830&x-expires=1737921600&x-signature=xGLErTLpukZpmPcYw1ZBHJpPEbM%3D&shp=a5d48078&shcp=81f88b70
                      signature:
                        type: string
                        example: El Presidente/Barstool Sports Founder.
                      createTime:
                        type: integer
                        example: 1550594547
                      verified:
                        type: boolean
                        example: true
                      secUid:
                        type: string
                        example: >-
                          MS4wLjABAAAAINC_ElRR-l1RCcnEjOZhNO-9wOzAMf-YHXqRY8vvG9bEhMRa6iu23TaE3JPZYXBD
                      ftc:
                        type: boolean
                        example: false
                      relation:
                        type: integer
                        example: 0
                      openFavorite:
                        type: boolean
                        example: false
                      bioLink:
                        type: object
                        properties:
                          link:
                            type: string
                            example: >-
                              https://www.barstoolsports.com/bios/Surviving-Barstool
                          risk:
                            type: integer
                            example: 0
                        required:
                          - link
                          - risk
                      commentSetting:
                        type: integer
                        example: 0
                      commerceUserInfo:
                        type: object
                        properties:
                          commerceUser:
                            type: boolean
                            example: false
                        required:
                          - commerceUser
                      duetSetting:
                        type: integer
                        example: 0
                      stitchSetting:
                        type: integer
                        example: 0
                      privateAccount:
                        type: boolean
                        example: false
                      secret:
                        type: boolean
                        example: false
                      isADVirtual:
                        type: boolean
                        example: false
                      roomId:
                        type: string
                        example: ''
                      uniqueIdModifyTime:
                        type: integer
                        example: 0
                      ttSeller:
                        type: boolean
                        example: false
                      downloadSetting:
                        type: integer
                        example: 0
                      profileTab:
                        type: object
                        properties:
                          showMusicTab:
                            type: boolean
                            example: false
                          showQuestionTab:
                            type: boolean
                            example: false
                          showPlayListTab:
                            type: boolean
                            example: true
                        required:
                          - showMusicTab
                          - showQuestionTab
                          - showPlayListTab
                      followingVisibility:
                        type: integer
                        example: 1
                      recommendReason:
                        type: string
                        example: ''
                      nowInvitationCardUrl:
                        type: string
                        example: ''
                      nickNameModifyTime:
                        type: integer
                        example: 0
                      isEmbedBanned:
                        type: boolean
                        example: false
                      canExpPlaylist:
                        type: boolean
                        example: true
                      profileEmbedPermission:
                        type: integer
                        example: 1
                      language:
                        type: string
                        example: en
                      eventList:
                        type: array
                        items: {}
                      suggestAccountBind:
                        type: boolean
                        example: false
                      isOrganization:
                        type: integer
                        example: 0
                    required:
                      - id
                      - shortId
                      - uniqueId
                      - nickname
                      - avatarLarger
                      - avatarMedium
                      - avatarThumb
                      - signature
                      - createTime
                      - verified
                      - secUid
                      - ftc
                      - relation
                      - openFavorite
                      - bioLink
                      - commentSetting
                      - commerceUserInfo
                      - duetSetting
                      - stitchSetting
                      - privateAccount
                      - secret
                      - isADVirtual
                      - roomId
                      - uniqueIdModifyTime
                      - ttSeller
                      - downloadSetting
                      - profileTab
                      - followingVisibility
                      - recommendReason
                      - nowInvitationCardUrl
                      - nickNameModifyTime
                      - isEmbedBanned
                      - canExpPlaylist
                      - profileEmbedPermission
                      - language
                      - eventList
                      - suggestAccountBind
                      - isOrganization
                  stats:
                    type: object
                    properties:
                      followerCount:
                        type: integer
                        example: 4100000
                      followingCount:
                        type: integer
                        example: 74
                      heart:
                        type: integer
                        example: 190400000
                      heartCount:
                        type: integer
                        example: 190400000
                      videoCount:
                        type: integer
                        example: 2017
                      diggCount:
                        type: integer
                        example: 0
                      friendCount:
                        type: integer
                        example: 52
                    required:
                      - followerCount
                      - followingCount
                      - heart
                      - heartCount
                      - videoCount
                      - diggCount
                      - friendCount
                  itemList:
                    type: array
                    items: {}
                required:
                  - user
                  - stats
                  - itemList
        '400':
          description: Bad Request - Invalid parameters or missing required fields
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: 'Missing required parameter: handle'
                  endpoint:
                    type: string
                  credits_required:
                    type: integer
                required:
                  - error
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Invalid API key
                  docs:
                    type: string
                    example: https://docs.sociavault.com/authentication
                required:
                  - error
        '402':
          description: Payment Required - Insufficient credits
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Insufficient credits
                  required:
                    type: integer
                    example: 1
                    description: Credits required for this request
                  available:
                    type: integer
                    example: 0
                    description: Credits currently available
                required:
                  - error
                  - required
                  - available
        '500':
          description: Internal Server Error - Service configuration or processing error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Service configuration error
                required:
                  - error
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: |-
        API key for authentication. Format: `sk_live_xxxxxxxxxxxxx`

        Get your API key from the [Dashboard](https://sociavault.com/dashboard).

````