# X (Twitter) API by APISH (`apish/x-api`) Actor

X (Twitter) data as clean JSON via APISH: X community, X community tweets, X profile and 4 more endpoints. Pay per credit; failed calls are free.

- **URL**: https://apify.com/apish/x-api.md
- **Developed by:** [APISH](https://apify.com/apish) (community)
- **Categories:** Social media
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$4.00 / 1,000 credits

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## X (Twitter) API by APISH

Get public X (Twitter) data as clean, consistent JSON: x community, x community tweets, x profile, one tweet, x video transcript, x user highlights and more. 7 endpoints, one response shape, numbers parsed, absolute URLs.

### How to use

1. Pick an **Endpoint**. Each option shows what it returns and its price in credits.
2. Enter its **Parameters** as JSON, for example `{"id":"1926186499399139650"}`. All parameters are listed below.
3. Run. Each call becomes one row in the dataset. Use **Batch** to run the same endpoint for many inputs and **Pages per input** to follow pagination.

### Pricing

Pay per event: you pay per APISH credit the call used. The price of each endpoint is in the table below. Calls that fail on our side (server errors, timeouts, blocks) are free.

### Endpoints

| Endpoint | Returns | Required parameters | Credits |
|---|---|---|---|
| `/twitter/v1/community` | X community | `id` | 1 |
| `/twitter/v1/community/tweets` | X community tweets | `id` | 1 |
| `/twitter/v1/profile` | X profile | `username` | 1 |
| `/twitter/v1/tweet` | One tweet | `url` | 1 |
| `/twitter/v1/tweet/transcript` | X video transcript | `url` | 1 |
| `/twitter/v1/user/highlights` | X user highlights | `username` | 1 |
| `/twitter/v1/user/tweets` | X user tweets | `username` | 1 |

### Output

Each dataset row has `endpoint`, `params`, `status`, `credits_used` and the endpoint's data. Add `"raw": 1` to the parameters to also get the site's original record, or `"fields": "a,b.c"` to return only the fields you need.

### Endpoint details

#### X community

Endpoint `/twitter/v1/community` · 1 credit per successful call.

Parameters:

- `id` (required): Community ID or URL.

Example parameters: `{"id":"1926186499399139650"}`

#### X community tweets

Endpoint `/twitter/v1/community/tweets` · 1 credit per successful call.

Parameters:

- `id` (required)

Example parameters: `{"id":"1926186499399139650"}`

#### X profile

Endpoint `/twitter/v1/profile` · 1 credit per successful call.

Parameters:

- `username` (required)

Example parameters: `{"username":"nasa"}`

#### One tweet

Endpoint `/twitter/v1/tweet` · 1 credit per successful call.

Parameters:

- `url` (required): Post URL or numeric id.

Example parameters: `{"url":"20"}`

#### X video transcript

Endpoint `/twitter/v1/tweet/transcript` · 1 credit per successful call.

Parameters:

- `url` (required)

Example parameters: `{"url":"https://x.com/NASA/status/2111180963661435219"}`

#### X user highlights

Endpoint `/twitter/v1/user/highlights` · 1 credit per successful call.

The tweets an account highlighted on its profile (what x.com shows logged out), with the same fields as user tweets. Pass `next_cursor` back as `cursor`; it is null on the last page. Every response includes `credits_used`: the credits this call cost.

Parameters:

- `username` (required)
- `count`: Tweets per page, 1-100 (default 20).
- `cursor`: `next_cursor` from the previous page.

Example parameters: `{"username":"NASA"}`

#### X user tweets

Endpoint `/twitter/v1/user/tweets` · 1 credit per successful call.

X serves about 100 recent tweets to logged-out clients.

Parameters:

- `username` (required)
- `count`: Tweets per page, 1-100 (default 20).
- `cursor`: Value of `next_cursor` from the previous page.

Example parameters: `{"username":"nasa"}`

### Support

Questions, bugs or a missing field? Open an issue in this Actor's Issues tab and we will reply there.

Public data only: nothing behind a login. You are responsible for how you use the data you collect.

# Actor input Schema

## `endpoint` (type: `string`):

Which X (Twitter) endpoint to call. Each option shows what it returns and its price in credits.

## `params` (type: `object`):

Query parameters for the endpoint, as JSON. See the README for every endpoint's parameters. Example: {"id":"1926186499399139650"}

## `batch` (type: `array`):

Run the same endpoint for many inputs: a list of parameter objects. Each item is one call. Leave empty to use Parameters.

## `maxPages` (type: `integer`):

For paginated endpoints: follow next_cursor up to this many pages per input. 1 = first page only.

## Actor input object example

```json
{
  "endpoint": "/twitter/v1/community",
  "params": {
    "id": "1926186499399139650"
  },
  "batch": [],
  "maxPages": 1
}
```

# Actor output Schema

## `results` (type: `string`):

One row per call: endpoint, params, status, credits_used and the data.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "endpoint": "/twitter/v1/community",
    "params": {
        "id": "1926186499399139650"
    },
    "batch": []
};

// Run the Actor and wait for it to finish
const run = await client.actor("apish/x-api").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "endpoint": "/twitter/v1/community",
    "params": { "id": "1926186499399139650" },
    "batch": [],
}

# Run the Actor and wait for it to finish
run = client.actor("apish/x-api").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "endpoint": "/twitter/v1/community",
  "params": {
    "id": "1926186499399139650"
  },
  "batch": []
}' |
apify call apish/x-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,apish/x-api"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/YFVgBBUk7fZNoHw2c/builds/yynwVpblq33qlmfrq/openapi.json