> ## 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

> Get Twitter profile information including stats and metadata

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


## OpenAPI

````yaml GET /v1/scrape/twitter/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/twitter/profile:
    get:
      tags:
        - twitter
      summary: Profile
      description: Get Twitter profile information including stats and metadata
      operationId: twitter_Profile
      parameters:
        - name: handle
          in: query
          description: Twitter handle
          required: true
          schema:
            type: string
            example: Austen
      responses:
        '200':
          description: |-
            Successful response

            **Key Response Fields:**
            - `rest_id`: User's numeric ID string
            - `core.name` / `core.screen_name`: Display name and @handle
            - `core.created_at`: Account creation date
            - `is_blue_verified`: Whether the account has a blue checkmark
            - `legacy.followers_count`: Total follower count
            - `legacy.friends_count`: Number of accounts the user follows
            - `legacy.favourites_count`: Total likes count
            - `legacy.statuses_count`: Total tweet count
            - `legacy.media_count`: Total media posts count
            - `legacy.description`: Bio text
            - `legacy.location`: Profile location string
            - `legacy.profile_image_url_https`: Profile picture URL
            - `legacy.profile_banner_url`: Banner image URL
            - `avatar.image_url`: Profile avatar URL
            - `verification.verified`: Legacy verified status
            - `affiliates_highlighted_label`: Affiliated organization badge info
          content:
            application/json:
              example:
                success: true
                data:
                  success: true
                  __typename: User
                  id: VXNlcjoyMjE4MzgzNDk=
                  rest_id: '221838349'
                  affiliates_highlighted_label:
                    label:
                      url:
                        url: https://twitter.com/gauntletai
                        urlType: DeepLink
                      badge:
                        url: >-
                          https://pbs.twimg.com/profile_images/1978528804009132032/dLTATus4_bigger.jpg
                      description: Gauntlet AI
                      userLabelType: BusinessLabel
                      userLabelDisplayType: Badge
                  avatar:
                    image_url: >-
                      https://pbs.twimg.com/profile_images/2016256482833035264/kVHK8w3e_normal.jpg
                  core:
                    created_at: Wed Dec 01 19:13:23 +0000 2010
                    name: Austen Allred
                    screen_name: Austen
                  dm_permissions: {}
                  is_blue_verified: true
                  legacy:
                    created_at: Wed Dec 01 19:13:23 +0000 2010
                    name: Austen Allred
                    screen_name: Austen
                    default_profile: false
                    default_profile_image: false
                    description: >-
                      Founder https://t.co/m6TigM4CJT: Free AI training for the
                      smartest engineers. Will tweet as I wish and suffer the
                      consequences. Accelerando: @kellyclaudeai
                    entities:
                      description:
                        urls:
                          '0':
                            display_url: GauntletAI.com
                            expanded_url: http://GauntletAI.com
                            url: https://t.co/m6TigM4CJT
                            indices:
                              '0': 8
                              '1': 31
                      url:
                        urls:
                          '0':
                            display_url: gauntletai.com
                            expanded_url: http://gauntletai.com
                            url: https://t.co/nCe0AdSANw
                            indices:
                              '0': 0
                              '1': 23
                    fast_followers_count: 0
                    favourites_count: 90858
                    followers_count: 445198
                    friends_count: 1423
                    has_custom_timelines: true
                    is_translator: false
                    listed_count: 4210
                    media_count: 4828
                    normal_followers_count: 445198
                    pinned_tweet_ids_str:
                      '0': '2020629611831599394'
                    possibly_sensitive: false
                    profile_banner_url: https://pbs.twimg.com/profile_banners/221838349/1622098809
                    profile_interstitial_type: ''
                    statuses_count: 55212
                    translator_type: regular
                    url: https://t.co/nCe0AdSANw
                    withheld_in_countries: {}
                    location: Austin, TX
                    profile_image_url_https: >-
                      https://pbs.twimg.com/profile_images/2016256482833035264/kVHK8w3e_normal.jpg
                  location:
                    location: Austin, TX
                  media_permissions: {}
                  parody_commentary_fan_label: None
                  profile_image_shape: Circle
                  privacy:
                    protected: false
                  relationship_perspectives: {}
                  tipjar_settings:
                    is_enabled: false
                    bandcamp_handle: ''
                    bitcoin_handle: ''
                    cash_app_handle: ''
                    ethereum_handle: ''
                    gofundme_handle: ''
                    patreon_handle: ''
                    pay_pal_handle: ''
                    venmo_handle: ''
                  verification:
                    verified: false
                  legacy_extended_profile: {}
                  is_profile_translatable: false
                  has_hidden_subscriptions_on_profile: true
                  verification_info:
                    is_identity_verified: false
                    reason:
                      description:
                        text: >-
                          This account is verified because it's an affiliate of
                          @gauntletai on X. Learn more
                        entities:
                          '0':
                            from_index: 54
                            to_index: 65
                            ref:
                              url: https://twitter.com/gauntletai
                              url_type: ExternalUrl
                          '1':
                            from_index: 72
                            to_index: 82
                            ref:
                              url: >-
                                https://help.twitter.com/en/rules-and-policies/profile-labels
                              url_type: ExternalUrl
                      verified_since_msec: '1473330227634'
                  highlights_info:
                    can_highlight_tweets: true
                    highlighted_tweets: '878'
                  user_seed_tweet_count: 1
                  business_account: {}
                  creator_subscriptions_count: 4
                credits_used: 1
                endpoint: twitter/profile
        '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).

````