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

# X Profile

> Return profile metadata for one X account.



## OpenAPI

````yaml /openapi.json post /x-profile
openapi: 3.0.3
info:
  title: Huntr — The GTM Intelligence API
  description: >-
    Give AI agents company, people, contact, and web intelligence through one
    API. Search accounts, build targeted lists, enrich leads, find contacts, and
    uncover buying signals.


    **Authentication:** Authenticated endpoints require an `x-api-key` header
    with your Huntr API key. Get a key by signing up via `POST /keys/create`.
    Public endpoints (pricing, sign-up, health) work without a key.


    **Rate limit:** 5 requests/second per API key on authenticated endpoints.
  version: 2.0.0
servers:
  - url: https://api.tryhuntr.com
security: []
tags:
  - name: Contact APIs
    description: >-
      Search people and enrich work email, phone, and reverse-email contact
      fields.
  - name: Company APIs
    description: >-
      Search companies and retrieve company-level attributes such as detected
      technology stack and active job postings.
  - name: Research APIs
    description: >-
      Research one company, person, team, or focused business question and
      return a sales-ready answer. Lite, standard, and deep tiers.
  - name: LinkedIn APIs
    description: >-
      LinkedIn URL discovery, company and profile pages, posts, reactions, and
      comments.
  - name: X APIs
    description: X profiles, posts, search results, and thread context.
  - name: Web APIs
    description: >-
      Find, scrape, and analyze pages on a domain, plus tech stack, domain
      contacts, and job postings.
  - name: Account
    description: >-
      Sign up, verify email, recover keys, check balance, view usage, add
      credits, and read the public pricing matrix.
  - name: System
    description: Health check.
paths:
  /x-profile:
    post:
      tags:
        - X APIs
      summary: X Profile
      description: Return profile metadata for one X account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - username
              properties:
                username:
                  type: string
                  description: >-
                    X username, @handle, or public x.com/twitter.com profile
                    URL.
            example:
              username: openai
      responses:
        '200':
          description: Profile returned.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  request_id:
                    type: string
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                      userName:
                        type: string
                      name:
                        type: string
                      description:
                        type: string
                      url:
                        type: string
                      followers:
                        type: integer
                      following:
                        type: integer
                      verified:
                        type: boolean
                      createdAt:
                        type: string
                    required:
                      - id
                      - userName
                    additionalProperties: true
                  price:
                    type: number
                    description: Amount charged for this request.
                  credits_remaining:
                    type: number
                    description: Credit balance after this request.
                required:
                  - success
                  - request_id
                  - result
                  - price
                  - credits_remaining
              example:
                success: true
                request_id: req_1746123456_xp1x2y
                result:
                  id: '4398626122'
                  userName: OpenAI
                  name: OpenAI
                  description: Creating safe AGI that benefits all of humanity.
                  url: https://x.com/OpenAI
                  followers: 12000000
                  following: 3
                  verified: true
                  createdAt: '2015-12-11T00:00:00.000Z'
                price: 0.00027
                credits_remaining: 4.99973
        '400':
          description: Invalid username.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Insufficient credits.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Lookup failed and credits were refunded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl --request POST \
              --url https://api.tryhuntr.com/x-profile \
              --header 'x-api-key: <api-key>' \
              --header 'Content-Type: application/json' \
              --data '{
              "username": "openai"
            }'
      x-code-samples:
        - lang: Shell
          label: cURL
          source: |-
            curl --request POST \
              --url https://api.tryhuntr.com/x-profile \
              --header 'x-api-key: <api-key>' \
              --header 'Content-Type: application/json' \
              --data '{
              "username": "openai"
            }'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your Huntr API key. Get one at tryhuntr.com. Pass as x-api-key header on
        all authenticated requests.

````

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