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

# Xshot API

<div className="relative text-[#e7e9ea]">
  <div className="flex flex-col items-center justify-center pt-8 pb-8 md:pt-16 md:pb-16 relative px-4">
    <div className="text-center max-w-6xl mx-auto">
      <div className="text-center text-xs sm:text-base text-[#71767b] font-medium leading-normal">Twitter/X Data Infrastructure</div>
      <div className="text-center text-4xl sm:text-5xl md:text-6xl lg:text-7xl font-semibold leading-tight sm:leading-[60px] md:leading-[80px] lg:leading-[96px] mt-2">Xshot API</div>

      <div className="text-center text-[#71767b] text-sm sm:text-lg font-normal leading-6 mt-4 max-w-2xl mx-auto">
        REST API and WebSocket streaming for Twitter/X data
      </div>

      <div className="mx-1 md:mx-20 grid grid-cols-3 gap-2 md:gap-4 p-2 md:p-6 mt-4">
        <div className="bg-[#16181c] border border-[#2f3336] rounded-lg md:rounded-xl p-3 md:p-5 text-center">
          <div className="text-xl md:text-2xl font-bold text-white mb-1 md:mb-2">31</div>
          <div className="text-xs md:text-sm font-semibold text-gray-100 mb-1">REST Endpoints</div>
          <div className="text-xs text-[#71767b] hidden md:block">Users, Tweets, Communities</div>
        </div>

        <div className="bg-[#16181c] border border-[#2f3336] rounded-lg md:rounded-xl p-3 md:p-5 text-center">
          <div className="text-xl md:text-2xl font-bold text-white mb-1 md:mb-2">5</div>
          <div className="text-xs md:text-sm font-semibold text-gray-100 mb-1">WS Channels</div>
          <div className="text-xs text-[#71767b] hidden md:block">Real-time events</div>
        </div>

        <div className="bg-[#16181c] border border-[#2f3336] rounded-lg md:rounded-xl p-3 md:p-5 text-center">
          <div className="text-xl md:text-2xl font-bold text-white mb-1 md:mb-2">SSL</div>
          <div className="text-xs md:text-sm font-semibold text-gray-100 mb-1">Secure</div>
          <div className="text-xs text-[#71767b] hidden md:block">HTTPS + WSS</div>
        </div>
      </div>
    </div>

    <div className="mt-8 md:mt-12 flex gap-4">
      <a href="/get-started" className="inline-flex items-center px-8 md:px-10 py-2 md:py-3 bg-white text-black font-semibold text-base md:text-lg rounded-full hover:bg-gray-200 transition-all duration-300 ease-in-out">
        Get Started
      </a>

      <a href="/api-reference/users/get-user-profile" className="inline-flex items-center px-8 md:px-10 py-2 md:py-3 border border-[#2f3336] text-white font-semibold text-base md:text-lg rounded-full hover:bg-[#16181c] transition-all duration-300 ease-in-out">
        API Reference
      </a>
    </div>
  </div>

  <div className="max-w-6xl mx-auto px-4">
    <div className="w-full h-px bg-gradient-to-r from-transparent via-[#2f3336] to-transparent" />
  </div>

  <div className="max-w-6xl mx-auto pt-16 md:pt-24 pb-10 md:pb-20 relative px-4">
    <div className="flex justify-center text-2xl sm:text-3xl md:text-4xl font-bold leading-tight md:leading-10 pb-2">API Reference</div>
    <div className="flex justify-center text-[#71767b] text-xs sm:text-lg font-normal leading-6 sm:leading-7 pb-10 sm:pb-14 text-center">REST endpoints and WebSocket streaming</div>

    <CardGroup cols={2}>
      <Card title="REST API" icon="bolt" href="/api-reference/users/get-user-profile">
        Endpoints for users, tweets, communities, lists, spaces, and trends.
      </Card>

      <Card title="WebSocket API" icon="signal-stream" href="/get-started/websocket">
        5 real-time channels: tweet engagement, user activity, mentions, and search.
      </Card>

      <Card title="Community Tracker Bot (Paused)" icon="robot" href="https://t.me/xshotfun_bot">
        Currently paused — X has temporarily disabled community creation. The bot will resume when X releases new updates on Communities. All subscriptions and data are preserved.
      </Card>

      <Card title="Dashboard" icon="gauge" href="https://xshot.fun/dashboard">
        Manage your API keys, monitor usage, buy credits, and track your calls.
      </Card>
    </CardGroup>
  </div>

  <div className="max-w-6xl mx-auto px-4">
    <div className="w-full h-px bg-gradient-to-r from-transparent via-[#2f3336] to-transparent" />
  </div>

  <div className="max-w-6xl mx-auto pt-16 md:pt-24 pb-10 md:pb-20 relative px-4">
    <div className="flex justify-center text-2xl sm:text-3xl md:text-4xl font-bold leading-tight md:leading-10 pb-2">Quick Example</div>
    <div className="flex justify-center text-[#71767b] text-base sm:text-lg font-normal leading-6 sm:leading-7 pb-10 sm:pb-14 text-center">Start making requests in seconds</div>

    <div className="text-center">
      <span className="bg-[#16181c] border border-[#2f3336] px-4 py-2 rounded-lg text-sm font-mono text-[#e7e9ea]">
        curl "[https://api.xshot.fun/twitter/user/info?username=elonmusk\&api\_key=YOUR\_KEY](https://api.xshot.fun/twitter/user/info?username=elonmusk\&api_key=YOUR_KEY)"
      </span>
    </div>

    <div className="mt-8">
      <CardGroup cols={3}>
        <Card title="Authentication" icon="key" href="/get-started/authentication">
          API key via query string, header, or bearer token
        </Card>

        <Card title="Pricing" icon="credit-card" href="https://xshot.fun/pricing">
          Pay-as-you-go credits. No subscriptions required.
        </Card>

        <Card title="QPS Limits" icon="gauge" href="https://xshot.fun/qps-limits">
          Rate limits scale with your credit balance
        </Card>
      </CardGroup>
    </div>
  </div>
</div>