First request

1. Get a key

Create an account on the get started page and copy the API key from the dashboard. New accounts get $0.50 of test credit, valid for 7 days, at 3 requests per second. Trial keys can call every read endpoint, but not the account actions. After your first top-up the key gets the Standard rate limit. Prices are on the pricing page.

Keep the key out of your code. The SDKs and examples read it from the TWITTRAPI_API_KEY environment variable:

export TWITTRAPI_API_KEY=your_key

2. Make a request

The base URL is https://api.twittrapi.com. Send the key in the X-API-KEY header. This looks up the profile of @jack:

curl 'https://api.twittrapi.com/user/by/username/jack' \
  --header 'X-API-KEY: YOUR_API_KEY'

curl 'https://twitter-aio.p.rapidapi.com/user/by/username/jack' \
  --header 'x-rapidapi-host: twitter-aio.p.rapidapi.com' \
  --header 'x-rapidapi-key: YOUR_API_KEY'

The response is X's JSON for that profile. The numeric user ID is in data.user.result.rest_id. Most other endpoints take that ID. For a one-off lookup without code, use the free user ID finder.

Python

pip install twittrapi

from twittrapi import TwittrAPI
 
client = TwittrAPI()  # reads TWITTRAPI_API_KEY
user = client.users.get_by_username("jack")
print(user["data"]["user"]["result"]["rest_id"])

Node.js

npm install twittrapi

import { TwittrAPI } from "twittrapi";
 
const client = new TwittrAPI(); // reads TWITTRAPI_API_KEY
const user = await client.users.getByUsername("jack");
console.log(user.data.user.result.rest_id);

Go

go get github.com/twittrapi/twittrapi-go

client, err := twittrapi.NewClient() // reads TWITTRAPI_API_KEY
if err != nil {
	log.Fatal(err)
}
user, err := client.Users.GetByUsername(context.Background(), "jack")
if err != nil {
	log.Fatal(err)
}
fmt.Println(string(user))

The SDKs retry 429 and 5xx responses with backoff and raise typed errors. More tools are on SDKs and integrations.

3. Check your balance

GET /balance returns your balance and price per call. It is not billed.

curl 'https://api.twittrapi.com/balance' -H 'X-API-KEY: YOUR_API_KEY'

Every billed response also carries X-Remaining-Balance and X-Price-Per-Call headers. See Pricing and billing.

Using RapidAPI instead

The same API is sold on RapidAPI with monthly plans, including a free plan for testing. Paths and parameters are the same; only the host and headers change:

curl 'https://twitter-aio.p.rapidapi.com/user/by/username/jack' \
  --header 'x-rapidapi-key: YOUR_RAPIDAPI_KEY' \
  --header 'x-rapidapi-host: twitter-aio.p.rapidapi.com'

The SDKs accept a RapidAPI key too (TwittrAPI(rapidapi_key=...), new TwittrAPI({ rapidApiKey }), or the RAPIDAPI_KEY variable). Limits and billing for RapidAPI keys are set on RapidAPI; the balance, price tiers and rate-limit tiers on these pages apply to direct keys. The API is also listed on JojAPI; see the get started page.

Find your RapidAPI host

TwittrAPI is on RapidAPI under more than one listing, and each listing has its own host. Your key only works with the host of the listing you subscribed to. twitter-aio.p.rapidapi.com is the host of the Twitter AIO listing and the default everywhere.

To find yours:

1. Open the listing you subscribed to on RapidAPI.
2. Open any endpoint. The code example next to it shows the header x-rapidapi-host, for example x-rapidapi-host: twitter-aio.p.rapidapi.com.
3. Use that value as the host. The request URL starts with the same host: https://twitter-aio.p.rapidapi.com/....

A 403 with "You are not subscribed to this API" usually means the host does not match the listing of your key.

Set the host

Send the host in x-rapidapi-host and use it in the URL. In the SDKs and tools, set it once:

Without a host, everything uses twitter-aio.p.rapidapi.com. You can enter the host with or without https://.

Next steps

• Errors: status codes, retries and refunds.
• Pagination: getting more than one page of results.
• API reference: all endpoints.