> ## 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 public Facebook profile information

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


## OpenAPI

````yaml GET /v1/scrape/facebook/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/facebook/profile:
    get:
      tags:
        - facebook
      summary: Profile
      description: Get public Facebook profile information
      operationId: facebook_Profile
      parameters:
        - name: url
          in: query
          description: Facebook profile URL
          required: true
          schema:
            type: string
            example: https://www.facebook.com/mantraindianfolsom
        - name: get_business_hours
          in: query
          description: Get the business's hours
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - ''
            example: 'true'
      responses:
        '200':
          description: >-
            Successful response


            **Key Response Fields:**

            - `data.id`: Facebook page/profile ID

            - `data.name`: Page display name

            - `data.url`: Facebook page URL

            - `data.profilePicLarge`: Profile photo URL (large)

            - `data.pageIntro`: Short page description or category intro

            - `data.category`: Page category (e.g., `"Restaurant"`)

            - `data.address`: Physical address (if a business)

            - `data.email`: Public contact email

            - `data.phone`: Public phone number

            - `data.website`: External website URL

            - `data.likeCount`: Total page likes

            - `data.followerCount`: Total page followers

            - `data.adLibrary.adStatus`: Whether the page is currently running
            ads

            - `data.creationDate`: When the page was created

            - `data.businessHours`: Business hours (if `get_business_hours=true`
            and available)
          content:
            application/json:
              example:
                success: true
                data:
                  success: true
                  adLibrary:
                    adStatus: This Page is currently running ads.
                    pageId: '104359362513119'
                  creationDate: November 25, 2022
                  businessHours: null
                  id: '100088017857524'
                  name: Mantraindian
                  url: https://www.facebook.com/mantraindianfolsom
                  gender: UNKNOWN
                  coverPhoto:
                    focus:
                      x: 0.5
                      'y': 0
                    photo:
                      id: '204402652503662'
                      image:
                        uri: >-
                          https://scontent.fsac1-1.fna.fbcdn.net/v/t39.30808-6/477575273_596577106619546_7712360987777031655_n.jpg?stp=dst-jpg_s960x960_tt6&_nc_cat=111&ccb=1-7&_nc_sid=cc71e4&_nc_ohc=exjYwKfSJ1QQ7kNvwFlKycS&_nc_oc=AdmAik3bYpUFpkCcKWImdbruEhvpaDNEhS_ewfTJy7dM9bbB-JqTq93ISJMs4vQQFCY&_nc_zt=23&_nc_ht=scontent.fsac1-1.fna&_nc_gid=DON0JuHYj9PonKOfNA2asA&oh=00_Afs0-NiQNCXyHJpuS6rm7qVnEav215_-NkROTqGqqK52NA&oe=698EDBA2
                        width: 960
                        height: 365
                      viewer_image:
                        height: 780
                        width: 2050
                      blurred_image:
                        uri: >-
                          https://scontent.fsac1-1.fna.fbcdn.net/v/t39.30808-6/477575273_596577106619546_7712360987777031655_n.jpg?stp=dst-jpg_fb50_s320x320_tt6&_nc_cat=111&ccb=1-7&_nc_sid=cc71e4&_nc_ohc=exjYwKfSJ1QQ7kNvwFlKycS&_nc_oc=AdmAik3bYpUFpkCcKWImdbruEhvpaDNEhS_ewfTJy7dM9bbB-JqTq93ISJMs4vQQFCY&_nc_zt=23&_nc_ht=scontent.fsac1-1.fna&_nc_gid=DON0JuHYj9PonKOfNA2asA&oh=00_AfvFTZpcR47XQjCMVXSYGprGGIu4s3g9PhYNHKBDqO7UTQ&oe=698EDBA2
                        width: 320
                        height: 122
                      url: >-
                        https://www.facebook.com/photo/?fbid=204402652503662&set=a.113593838251211
                  isBusinessPageActive: false
                  profilePhoto:
                    url: >-
                      https://www.facebook.com/photo/?fbid=152234581053803&set=a.107432348867360
                    viewer_image:
                      height: 2000
                      width: 2000
                    id: '152234581053803'
                  profilePicLarge: >-
                    https://scontent.fsac1-1.fna.fbcdn.net/v/t39.30808-1/331711173_3408886226056104_241444658713195527_n.jpg?stp=dst-jpg_s200x200_tt6&_nc_cat=110&ccb=1-7&_nc_sid=2d3e12&_nc_ohc=BUuxFIDvjXQQ7kNvwESs3Zj&_nc_oc=AdnOfp2OTKbbZ61s0HkeWHrYnwGOQFlnoNRt6KUks3c5H97UtKz8D65BXFLd3EO9bow&_nc_zt=24&_nc_ht=scontent.fsac1-1.fna&_nc_gid=DON0JuHYj9PonKOfNA2asA&oh=00_AftoaIeEysvX7KLeLf2SQRLcAhBk8qRuHqswgC1CTYb2jw&oe=698EF0E2
                  profilePicMedium: >-
                    https://scontent.fsac1-1.fna.fbcdn.net/v/t39.30808-1/331711173_3408886226056104_241444658713195527_n.jpg?stp=dst-jpg_s148x148_tt6&_nc_cat=110&ccb=1-7&_nc_sid=2d3e12&_nc_ohc=BUuxFIDvjXQQ7kNvwESs3Zj&_nc_oc=AdnOfp2OTKbbZ61s0HkeWHrYnwGOQFlnoNRt6KUks3c5H97UtKz8D65BXFLd3EO9bow&_nc_zt=24&_nc_ht=scontent.fsac1-1.fna&_nc_gid=DON0JuHYj9PonKOfNA2asA&oh=00_Afu6f3psI-NVDNSSyqZRSuoG0TUtno8rkSfcywNI9hkY2A&oe=698EF0E2
                  profilePicSmall: >-
                    https://scontent.fsac1-1.fna.fbcdn.net/v/t39.30808-1/331711173_3408886226056104_241444658713195527_n.jpg?stp=dst-jpg_s100x100_tt6&_nc_cat=110&ccb=1-7&_nc_sid=2d3e12&_nc_ohc=BUuxFIDvjXQQ7kNvwESs3Zj&_nc_oc=AdnOfp2OTKbbZ61s0HkeWHrYnwGOQFlnoNRt6KUks3c5H97UtKz8D65BXFLd3EO9bow&_nc_zt=24&_nc_ht=scontent.fsac1-1.fna&_nc_gid=DON0JuHYj9PonKOfNA2asA&oh=00_AfsafRvzoWSa2Wl73vK2nr-HdCXIKiAsVKvq2E83khjIJQ&oe=698EF0E2
                  pageIntro: Indian Vegan & Vegetarian Restaurant
                  category: Restaurant
                  address: >-
                    1870 Prairie City Rd, Suite 500, Folsom, CA, United States,
                    California
                  email: contact@mantraindian.com
                  links: {}
                  phone: (916) 999-1749
                  website: https://www.mantraindian.com/
                  services: Delivery · Takeout · Dine-in…
                  priceRange: $$
                  rating: Not yet rated (1 Review)
                  ratingCount: null
                  likeCount: 3761
                  followerCount: 3700
                credits_used: 1
                endpoint: facebook/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).

````