Quickstart

1. Get your API key

Sign in at twitterapi.io with Google.
Copy the API key shown on your dashboard.

New accounts get free starter credits, so you can try the API right away. Accounts that have never topped up are limited to one request every 5 seconds; any top-up raises this (see Rate limits).

2. Make your first request

Look up a user profile. Replace YOUR_API_KEY with your key:

curl 'https://api.twitterapi.io/twitter/user/info?userName=jack' \
  --header 'x-api-key: YOUR_API_KEY'

import requests

resp = requests.get(
    "https://api.twitterapi.io/twitter/user/info",
    params={"userName": "jack"},
    headers={"x-api-key": "YOUR_API_KEY"},
    timeout=30,
)
print(resp.json())

const resp = await fetch(
  "https://api.twitterapi.io/twitter/user/info?userName=jack",
  { headers: { "x-api-key": "YOUR_API_KEY" } }
);
console.log(await resp.json());

3. Read the response

A successful call returns HTTP 200 with JSON like this (trimmed; numbers will differ):

{
  "status": "success",
  "msg": "success",
  "data": {
    "id": "12",
    "userName": "jack",
    "name": "jack",
    "isBlueVerified": true,
    "followers": 12474546,
    "following": 3,
    "statusesCount": 31008,
    "createdAt": "2006-03-21T20:50:14.000000Z",
    "profilePicture": "https://pbs.twimg.com/profile_images/..._normal.jpg"
  }
}

Some “not found” results still return HTTP 200, with "status": "error" in the body, for example {"status": "error", "msg": "user not found", "data": null}. Always check status as well as the HTTP code. See Errors.

4. Try a search

Search returns up to 20 tweets per page, plus a cursor for the next page:

curl 'https://api.twitterapi.io/twitter/tweet/advanced_search?query=from%3Ajack&queryType=Latest' \
  --header 'x-api-key: YOUR_API_KEY'

{
  "tweets": [ { "id": "...", "text": "...", "author": { "userName": "jack" } } ],
  "has_next_page": true,
  "next_cursor": "DAADDAAB..."
}

Pass next_cursor back as cursor to get the next page. See Pagination.

Next steps

Pricing

What each endpoint costs, in credits.

Errors

Status codes and how to handle them.

Rate limits

Requests per second by account type.

Advanced search

The most-used endpoint.

Questions? Email [email protected].

Get Started

Integrations

User Endpoint

Tweet Endpoint

List Endpoint

Communities Endpoint

Trend Endpoint

Spaces Endpoint

My Endpoint

Post & Action Endpoint V2(Back Online)

Community Action V2

Webhook/Websocket Filter Rule

Stream Endpoint

1. Get your API key

2. Make your first request

3. Read the response

4. Try a search

Next steps

Pricing

Errors

Rate limits

Advanced search

​1. Get your API key

​2. Make your first request

​3. Read the response

​4. Try a search

​Next steps

Pricing

Errors

Rate limits

Advanced search

1. Get your API key

2. Make your first request

3. Read the response

4. Try a search

Next steps