Xquik Skill

https://github.com/xquik-dev/x-twitter-scraper
Admin
Xquik Skill is an AI agent skill for building integrations with the Xquik X (Twitter) real-time data...
Tokens:149,387
Snippets:1,203
Trust Score:7.5
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### POST /compose with step=compose

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/tweet-ideas.md

Example request to the /compose endpoint with step=compose to get content rules and follow-up questions. The response includes contentRules, followUpQuestions, scorerWeights, and topPenalties.

```http
POST /compose
{
  "step": "compose",
  "topic": "indie saas",
  "goal": "engagement"
}
-> { contentRules, followUpQuestions, scorerWeights, topPenalties }
```

--------------------------------

### Install and confirm Skills with Gemini CLI

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/README.md

Review the repository and its Skill files before consenting to installation. Then install and confirm the Skills. The command discovers x-twitter-scraper, xquik-mcp, and xquik-social-research.

```bash
gemini skills install https://github.com/Xquik-dev/x-twitter-scraper.git \
  --path skills
```

```bash
gemini skills list
```

--------------------------------

### Install and confirm plugin with Codex CLI

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/README.md

Add the marketplace, install the plugin, then confirm it with the Codex CLI.

```bash
codex plugin marketplace add Xquik-dev/x-twitter-scraper
```

```bash
codex plugin add x-twitter-scraper@x-twitter-scraper
```

```bash
codex plugin list
```

--------------------------------

### POST /compose (refine)

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/optimize-tweets.md

Gets rewrite rules for a topic, tone, and goal, returning composition guidance and example patterns.

```APIDOC
## POST /compose

### Description
Gets rewrite rules for a topic, tone, and goal, returning composition guidance and example patterns.

### Method
POST

### Endpoint
https://xquik.com/api/v1/compose

### Parameters
#### Request Body
- **step** (string) - Required - Must be "refine"
- **topic** (string) - Required - The topic of the tweet
- **goal** (string) - Required - The engagement goal (e.g., "engagement")
- **tone** (string) - Required - The desired tone (e.g., "casual")
- **additionalContext** (string) - Optional - Additional context such as a draft

### Request Example
```json
{
  "step": "refine",
  "topic": "<topic>",
  "goal": "engagement",
  "tone": "casual",
  "additionalContext": "<draft>"
}
```

### Response
#### Success Response (200)
- **compositionGuidance** (string) - Guidance for composing the tweet
- **examplePatterns** (array) - Example patterns for rewriting

#### Response Example
```json
{
  "compositionGuidance": "Use a hook and a call to action.",
  "examplePatterns": []
}
```

```

--------------------------------

### Install and confirm Skills with LobeHub CLI

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/README.md

Sign in with LobeHub CLI 0.0.48 or later, install the Skills, then confirm them.

```bash
lh login
```

```bash
lh skill install https://github.com/Xquik-dev/x-twitter-scraper/tree/master/skills/x-twitter-scraper
```

```bash
lh skill install https://github.com/Xquik-dev/x-twitter-scraper/tree/master/skills/xquik-mcp
```

```bash
lh skill install https://github.com/Xquik-dev/x-twitter-scraper/tree/master/skills/xquik-social-research
```

```bash
lh skill list --source market
```

--------------------------------

### GET /x/bookmarks request and response

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/x-bookmarks.md

Example request to the X bookmarks endpoint. The route accepts an opaque cursor and an optional folderId, and uses the caller's connected account; it does not accept an account parameter.

```http
GET /x/bookmarks?cursor=<optional>&folderId=<optional>
-> { tweets: Tweet[], has_next_page: boolean, next_cursor?: string }
```

--------------------------------

### Install primary Skill with bunx

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/README.md

Installs the primary Skill for any compatible agent using the bunx CLI.

```bash
bunx skills@1.5.3 add Xquik-dev/x-twitter-scraper
```

--------------------------------

### Example profile output row

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/apify/x-profile-scraper/README.zh-CN.md

Example profile output row. Uses sample values; actual results come from live data. Shows the resultType, sourceTarget, and accountBasedInUnavailable fields.

```json
{
  "resultType": "profile",
  "sourceTarget": "sample_user",
  "username": "sample_user",
  "name": "Sample User",
  "followers": 1200,
  "verified": false,
  "accountBasedInUnavailable": true
}
```

--------------------------------

### Example photo output row

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/apify/x-media-downloader/README.md

Example output row for a photo. Rows include availability, metadata, and action URLs; stored rows add storedMediaUrl and downloadStatus: "stored". Results reflect live data.

```json
{
  "type": "photo",
  "width": 1200,
  "height": 675,
  "altText": "Sample alt text",
  "sourceTarget": "OpenAI"
}
```

--------------------------------

### GET /monitors/keywords

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/skills/x-twitter-scraper/references/monitors-webhooks.md

Lists all keyword monitors.

```APIDOC
## GET /monitors/keywords

### Description
Lists all keyword monitors.

### Method
GET

### Endpoint
https://xquik.com/api/v1/monitors/keywords

### Parameters
None

### Response
#### Success Response (200)
- **monitors** (array of objects) - List of keyword monitors.

#### Response Example
[
  {
    "id": "monitor_id",
    "query": "#rustlang",
    "eventTypes": ["tweet.new"],
    "isActive": true
  }
]
```

--------------------------------

### Start favoriters extraction with POST /extractions

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/tweet-analytics.md

Starts a bulk favoriters extraction after confirmation. The response is a 202 with the extraction ID and status 'running'. Poll GET /extractions/{id} to retrieve results. The same pattern applies to repost_extractor and quote_extractor, both using targetTweetId.

```http
POST /extractions
{ "toolType": "favoriters", "targetTweetId": "<id>" }
-> 202 { "id": "<extractionId>", "toolType": "favoriters", "status": "running" }
```

--------------------------------

### POST /compose with step=compose

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/write-tweets.md

Example request to the Xquik compose endpoint with step=compose. The response includes contentRules, followUpQuestions, scorerWeights, and topPenalties. The topic is free text, goal is one of engagement, followers, authority, or conversation, and styleUsername is an optional cached style label from POST /styles.

```http
POST /compose
{
  "step": "compose",
  "topic": "shipping a new feature",
  "goal": "engagement",
  "styleUsername": "optional_cached_style"
}
-> { contentRules, followUpQuestions, scorerWeights, topPenalties }
```

--------------------------------

### GET /radar?category=tech&limit=20 request and response

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/trending-news.md

Example request to the Radar API with category and limit parameters, showing the response structure with items array and pagination fields.

```http
GET /radar?category=tech&limit=20
-> { items: [{ id, sourceId, title, score, category, source, region, language, metadata, publishedAt, createdAt }], hasMore, nextCursor }
```

--------------------------------

### Configure the Actor with search terms, maxItems, and analysis context

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/apify/x-tweet-viral-score-analyzer/README.md

Example input configuration for the Actor. Set searchTerms, maxItems, and optionally analysis.context to describe the audience. The default context is used if omitted.

```json
{
  "searchTerms": ["from:NASA -filter:replies -filter:retweets"],
  "maxItems": 150,
  "analysis": { "context": "Space fans & general readers." }
}
```

--------------------------------

### POST /extractions/estimate and POST /extractions - Bulk article extraction

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/x-articles.md

Bulk extraction rooted at a tweet ID. First, POST /extractions/estimate to preview usage. Then POST /extractions to start the extraction, returning a 202 with an extraction job ID. Poll GET /extractions/{id} and export via GET /extractions/{id}/export?format=csv when complete.

```http
POST /extractions/estimate
{ "toolType": "article_extractor", "targetTweetId": "<id>" }

POST /extractions
{ "toolType": "article_extractor", "targetTweetId": "<id>" }
-> 202 { "id": "<extractionId>", "toolType": "article_extractor", "status": "running" }
```

--------------------------------

### Tweet metrics response JSON

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/tweet-analytics.md

Example response structure for the GET /x/tweets/{id} endpoint. Shows the tweet object with engagement counts and the author object. All IDs are strings; viewCount can be omitted or zero when unavailable.

```json
{
  "tweet": {
    "id": "...",
    "text": "...",
    "createdAt": "ISO 8601",
    "likeCount": 0,
    "retweetCount": 0,
    "quoteCount": 0,
    "replyCount": 0,
    "bookmarkCount": 0,
    "viewCount": 0
  },
  "author": { "id": "...", "username": "...", "followers": 0, "verified": bool }
}
```

--------------------------------

### POST /compose request with step=compose

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/write-threads.md

Example request to the /compose endpoint with step=compose, a topic, and a goal. The response includes contentRules, followUpQuestions, scorerWeights, and topPenalties.

```http
POST /compose
{
  "step": "compose",
  "topic": "why static sites beat SPAs for blogs",
  "goal": "authority"
}
-> { contentRules, followUpQuestions, scorerWeights, topPenalties }
```

--------------------------------

### GET /x/timeline request and response

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/for-you-feed.md

Example request for the For You timeline endpoint. Pass the opaque cursor to continue pagination and comma-separated tweet IDs in seenTweetIds to hide already-seen tweets. The endpoint rejects account, type, and limit parameters.

```http
GET /x/timeline?cursor=<optional>&seenTweetIds=<comma-separated>
-> { tweets: Tweet[], has_next_page: boolean, next_cursor?: string }
```

--------------------------------

### POST /x/tweets with Idempotency-Key

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/skills/x-twitter-scraper/references/writes.md

Example HTTP request for creating a tweet via the Xquik API. Requires an X account handle or ID in the body, an API key, and a unique Idempotency-Key per action. A text post costs 30 credits plus 2 credits per started MB of media.

```http
POST https://xquik.com/api/v1/x/tweets
x-api-key: <XQUIK_API_KEY>
Idempotency-Key: 5b0f7c2e-8d1a-4f3b-9e6c-2a7d4b8f1c90
Content-Type: application/json

{"account": "my_brand", "text": "Our spring sale starts today."}
```

--------------------------------

### POST /extractions

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/x-spaces.md

Start a space_explorer extraction to list hosts, co-hosts, speakers, and listeners in an X Space.

```APIDOC
## POST /extractions

### Description
Start a space_explorer extraction to list hosts, co-hosts, speakers, and listeners in an X Space.

### Method
POST

### Endpoint
/extractions

### Parameters
#### Request Body
- **toolType** (string) - Required - Must be "space_explorer".
- **targetSpaceId** (string) - Required - The ID of the X Space.

### Request Example
{
  "toolType": "space_explorer",
  "targetSpaceId": "<id>"
}

### Response
#### Success Response (202)
- **id** (string) - The extraction ID.
- **toolType** (string) - The tool type used.
- **status** (string) - The status of the extraction, e.g., "running".

#### Response Example
{
  "id": "<extractionId>",
  "toolType": "space_explorer",
  "status": "running"
}

```

--------------------------------

### GET /x/tweets/{id}

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/tweet-replies.md

Get root tweet metadata for context when fetching replies.

```APIDOC
## GET /x/tweets/{id}

### Description
Fetches the metadata of a specific tweet to provide context for reply retrieval.

### Method
GET

### Endpoint
`/x/tweets/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the tweet to retrieve.

### Response
#### Success Response (200)
- Returns the full tweet object.

#### Response Example
```json
{
  "id": "<tweetId>",
  "text": "...",
  "likeCount": 0
}
```
```

--------------------------------

### Input JSON for X List Scraper

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/apify/x-list-scraper/README.md

Example input configuration specifying list IDs, resources to scrape, whether to include replies, and the maximum number of items.

```json
{
  "listIds": ["1748648376080666720"],
  "resources": ["tweets", "members", "followers"],
  "includeReplies": false,
  "maxItems": 10000
}
```

--------------------------------

### Set up Xquik MCP in Codex CLI

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/skills/xquik-mcp/references/mcp-setup.md

Adds, authenticates, and lists the Xquik MCP server in Codex CLI. Requires a current Codex release; older releases may fail with an OAuth issuer error.

```bash
codex mcp add xquik --url https://xquik.com/mcp
codex mcp login xquik
codex mcp list
```

--------------------------------

### Create keyword monitor with curl

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/README.md

Creates a keyword monitor via the Xquik API. Requires an XQUIK_API_KEY. The monitor checks every second and costs 21 credits per hour. The response includes stored events and webhook deliveries.

```bash
curl --request POST 'https://xquik.com/api/v1/monitors/keywords' \
  --header "x-api-key: ${XQUIK_API_KEY}" \
  --header 'content-type: application/json' \
  --data '{
    "query": "xquik OR \"x api\"",
    "eventTypes": ["tweet.new"]
  }'
```

--------------------------------

### GET /x/tweets/{id}/replies

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/tweet-replies.md

Get replies to a specific tweet. Supports automatic pagination and complete mode for maximum coverage.

```APIDOC
## GET /x/tweets/{id}/replies

### Description
Fetches replies to a specified tweet, including direct and nested replies, with engagement metrics.

### Method
GET

### Endpoint
`/x/tweets/{id}/replies`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the tweet to fetch replies for.

#### Query Parameters
- **pageSize** (integer) - Optional - Number of replies per page (1-300). Used in automatic pagination.
- **mode** (string) - Optional - Set to `complete` for complete mode.
- **limit** (integer) - Optional - Maximum number of replies to collect (1-25,000). Only used with `mode=complete`.
- **sort** (string) - Optional - Sort order for complete mode: `relevance`, `latest`, `oldest`, `likes`.
- **cursor** (string) - Optional - Pagination cursor, pass `next_cursor` value unchanged.
- **time ranges and Tweet filters** - Optional - Additional filters for automatic pagination.

### Request Example
```http
GET /x/tweets/{id}/replies?pageSize=300
```

### Response
#### Success Response (200)
- **tweets** (array) - Direct replies.
- **nested_replies** (array) - Nested replies.
- **has_next_page** (boolean) - Whether more pages exist.
- **next_cursor** (string) - Cursor for the next page, empty if no more.
- **diagnostic** (object) - Diagnostics including coverage and strategies.

#### Response Example
```json
{
  "tweets": [],
  "nested_replies": [],
  "has_next_page": false,
  "next_cursor": "",
  "diagnostic": {}
}
```

### Error Handling
- **404** - Tweet deleted or protected.
- **409** - Coverage cursor unavailable due to concurrent use. Wait `Retry-After` and retry same cursor once.
- **410** - Coverage cursor gone (finished, expired, superseded, or identity mismatch). Restart without cursor.
- **400** - Invalid coverage cursor. Restart without cursor.
- **424** - Maximum coverage below 80% (complete mode). Safe partial rows returned.
- **429** - Rate limited, retry with backoff.
- **503** - Complete collection busy. Wait `Retry-After` and retry.
```

--------------------------------

### Example PATCH /x/profile request

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/update-x-profile.md

Shows the required structure for updating profile fields. Every request needs the 'account' field; only send fields the user wants to change.

```http
PATCH /x/profile
{
  "account": "<connected_username>",
  "description": "building stuff",
  "name": "Jane Doe",
  "location": "SF",
  "url": "https://janedoe.com"
}
```

--------------------------------

### Output Row Example for listMember

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/apify/x-list-scraper/README.md

Example output row for a list member, showing the result type, source target, and profile fields.

```json
{
  "resultType": "listMember",
  "sourceTarget": "1748648376080666720",
  "username": "sample_user",
  "name": "Sample User",
  "followers": 1200,
  "verified": false
}
```

--------------------------------

### Start follower extraction with POST /extractions

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/task-guides/clean-followers.md

Starts a follower extraction job. The response is a 202 with an extraction ID and status "running".

```http
POST /extractions
{ "toolType": "follower_explorer", "targetUsername": "handle" }
-> 202 { "id": "<extractionId>", "toolType": "follower_explorer", "status": "running" }
```

--------------------------------

### Create keyword monitor

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/skills/x-twitter-scraper/references/monitors-webhooks.md

Creates a monitor for a search query (e.g., '#rustlang') that watches for new tweets. Requires 22 available credits. The monitor costs 21 credits per hour. Only subscribed event types are stored and delivered.

```http
POST https://xquik.com/api/v1/monitors/keywords
x-api-key: <XQUIK_API_KEY>
Content-Type: application/json

{"query": "#rustlang", "eventTypes": ["tweet.new"]}
```

--------------------------------

### Example output row

Source: https://github.com/xquik-dev/x-twitter-scraper/blob/master/apify/x-twitter-news-monitor/README.md

Example output row from the X (Twitter) News Monitor. Shows the tweet object and analysis object with status, answers, and confidence/probability fields.

```json
{
  "tweet": { "id": "2100673144985993441", "text": "…", "retweetCount": 40 },
  "analysis": {
    "status": "succeeded",
    "answers": [
      {
        "questionId": "format",
        "type": "choice",
        "value": "reporting",
        "confidence": 0.9
      },
      {
        "questionId": "attribution",
        "type": "choice",
        "value": "named",
        "confidence": 0.84
      },
      { "questionId": "relevance", "type": "probability", "probability": 0.98 }
    ]
  }
}
```
Tokens:
Raw