GetXAPI Documentation

GetXAPI is a REST API for Twitter/X data with 69 endpoints: 58 usage-priced read and write endpoints from $0.001 per call, 2 free account endpoints, and 9 real-time monitoring endpoints included with a Monitoring plan. Authentication is a single Bearer key, with no OAuth flow and no X developer account required.

New here? Jump straight to the Quickstart for the base URL, authentication, and a working request in curl, JavaScript, or Python.

There are no endpoint-specific request quotas on paid data endpoints; general service throttling still applies, and monitoring management and free polling endpoints use abuse-prevention limits.

Get your API key →

Try it without code

Three ways to explore every endpoint interactively, pick whichever you already use:

View on Fern

• Hosted Postman docs → documenter.getpostman.com/view/54999474/2sBXqRkd7E, searchable, with example responses for every endpoint
• Fern docs → getxapi.docs.buildwithfern.com, same collection rendered in Fern's clean reference layout

Use it in Claude, Cursor & any MCP client

GetXAPI ships an official Model Context Protocol server, point your AI assistant at it and the full Twitter/X API becomes native tools (search tweets, look up users, read followers, post tweets, send DMs, publish articles).

Add it to your MCP client config (Claude Desktop, Cursor, Windsurf, etc.):

{
  "mcpServers": {
    "getxapi": {
      "command": "npx",
      "args": ["-y", "@getxapi/mcp@latest"],
      "env": { "GETXAPI_KEY": "YOUR_API_KEY" }
    }
  }
}

Read tools need only your GETXAPI_KEY; write tools (post, like, DM, etc.) additionally use your X account auth.

• npm → npmjs.com/package/@getxapi/mcp
• GitHub → github.com/getxapi/getxapi-mcp

Quick Start

Base URL

https://api.getxapi.com

Authentication

All requests require an API key passed as a Bearer token in the Authorization header.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.getxapi.com/twitter/user/info?userName=elonmusk"

Example: Get a User Profile

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.getxapi.com/twitter/user/info?userName=elonmusk"

const response = await fetch(
  "https://api.getxapi.com/twitter/user/info?userName=elonmusk",
  {
    headers: { Authorization: "Bearer YOUR_API_KEY" },
  }
);
const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://api.getxapi.com/twitter/user/info",
    params={"userName": "elonmusk"},
    headers={"Authorization": "Bearer YOUR_API_KEY"})
print(response.json())

Example: Search Tweets

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.getxapi.com/twitter/tweet/advanced_search?q=from:elonmusk&product=Latest"

const response = await fetch(
  "https://api.getxapi.com/twitter/tweet/advanced_search?q=from:elonmusk&product=Latest",
  {
    headers: { Authorization: "Bearer YOUR_API_KEY" },
  }
);
const data = await response.json();
console.log(data.tweets);

import requests

response = requests.get(
    "https://api.getxapi.com/twitter/tweet/advanced_search",
    params={"q": "from:elonmusk", "product": "Latest"},
    headers={"Authorization": "Bearer YOUR_API_KEY"})
print(response.json()["tweets"])

Endpoint Index

Tweets

Articles

Users

Lists

Direct Messages

Media

Community

Spaces

Trends

Account

Pagination

All list endpoints support cursor-based pagination:

• Omit cursor for the first page
• Pass next_cursor from the response for subsequent pages
• Each page typically returns ~20 items
• Some endpoints (followers/following v1) return up to 200 per page
• The v2 variants (followers_v2/following_v2) return ~70 per page
• Keep paginating until has_more is false

Error Codes

All errors return a JSON body with an error field:

{
  "error": "Missing required query param: userName"
}

Pricing

Most read endpoints cost $0.001 per call. User Tweets Complete costs $0.003 per call, Tweet Thread costs $0.005 per call, and DM endpoints cost $0.002 per call. No subscription is required for pay-per-call access; optional plans are available. There are no endpoint-specific request quotas on these paid data endpoints, so you pay only for what you use. General service throttling still applies. (The monitoring management endpoints are not billed per call and carry abuse-prevention limits instead.)

View full pricing →