Skip to content

Commit 1e3ac9a

Browse files
committed
docs(readme): add search-first SDK landing page
1 parent 69aa90c commit 1e3ac9a

2 files changed

Lines changed: 73 additions & 5 deletions

File tree

CITATION.cff

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
cff-version: 1.2.0
2+
message: If you use this SDK, cite it using this metadata.
3+
title: Xquik Python SDK for the X (Twitter) Scraper API
4+
type: software
5+
authors:
6+
- name: Xquik
7+
version: 0.4.0
8+
date-released: 2026-04-22
9+
url: https://github.com/Xquik-dev/x-twitter-scraper-python
10+
repository-code: https://github.com/Xquik-dev/x-twitter-scraper-python
11+
license: Apache-2.0
12+
keywords:
13+
- Xquik
14+
- Python
15+
- SDK
16+
- REST API
17+
- webhooks
18+
- MCP
19+
- X
20+
- Twitter scraper

README.md

Lines changed: 53 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,65 @@
1-
# X Twitter Scraper Python API library
1+
# Xquik Python SDK for X (Twitter) Scraper API
22

33
<!-- prettier-ignore -->
44
[![PyPI version](https://img.shields.io/pypi/v/x_twitter_scraper.svg?label=pypi%20(stable))](https://pypi.org/project/x_twitter_scraper/)
55

6-
The X Twitter Scraper Python library provides convenient access to the X Twitter Scraper REST API from any Python 3.9+
7-
application. The library includes type definitions for all request params and response fields,
8-
and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
6+
Xquik Python SDK for the X (Twitter) Scraper API: typed REST, HMAC webhooks, MCP, and docs at https://docs.xquik.com/api-reference/overview.
7+
8+
Use it to search tweets, look up users, monitor accounts, run giveaway draws, and connect AI agents to X data without maintaining scraping infrastructure.
9+
10+
[SDK API](api.md) | [REST API Docs](https://docs.xquik.com/api-reference/overview) | [OpenAPI Spec](https://xquik.com/openapi.json) | [Webhooks](https://docs.xquik.com/api-reference/webhooks/create) | [MCP Server](https://xquik.com/mcp) | [TypeScript SDK](https://github.com/Xquik-dev/x-twitter-scraper-typescript)
911

1012
It is generated with [Stainless](https://www.stainless.com/).
1113

14+
## Tweet Search & User Lookup
15+
16+
Build Python services that search tweets, fetch user profiles, check follower relationships, download media, and inspect timeline data through one typed REST client.
17+
18+
## Real-Time Monitoring & Webhooks
19+
20+
Create monitors for X accounts, receive HMAC-signed webhook events, and query event history from the same SDK surface.
21+
22+
## AI Agent Workflows With MCP
23+
24+
Connect agent systems to Xquik through the MCP server while keeping custom product code on the typed REST SDK.
25+
26+
## Giveaway Draws & Extractions
27+
28+
Run giveaway draws, export winners, and launch extraction jobs for replies, reposts, quotes, followers, lists, communities, threads, articles, and tweet search.
29+
30+
## Xquik SDK vs Building From Scratch
31+
32+
| Need | Xquik Python SDK | Building From Scratch |
33+
| --- | --- | --- |
34+
| Typed REST calls | Pydantic models and typed request params | Hand-maintained schemas |
35+
| Sync and async apps | Synchronous and asynchronous clients | Separate clients and retries |
36+
| Real-time events | Monitors plus HMAC webhooks | Separate queue and signing work |
37+
| AI agent access | REST SDK plus MCP server | Custom bridge layer |
38+
39+
## Package & Registry Trust
40+
41+
- Package: [PyPI `x_twitter_scraper`](https://pypi.org/project/x_twitter_scraper/)
42+
- Source: [Xquik-dev/x-twitter-scraper-python](https://github.com/Xquik-dev/x-twitter-scraper-python)
43+
- License: Apache-2.0
44+
- Citation metadata: [CITATION.cff](CITATION.cff)
45+
46+
## FAQ
47+
48+
### Does this SDK support async Python?
49+
50+
Yes. Import `AsyncXTwitterScraper` and await the same API methods.
51+
52+
### Where are the REST endpoints documented?
53+
54+
Start with the [REST API overview](https://docs.xquik.com/api-reference/overview), then use [api.md](api.md) for generated method names.
55+
56+
### Can this work with AI agents?
57+
58+
Yes. Use the SDK in your app code and the [MCP server](https://xquik.com/mcp) for MCP-compatible agent clients.
59+
1260
## Documentation
1361

14-
The REST API documentation can be found on [xquik.com](https://xquik.com). The full API of this library can be found in [api.md](api.md).
62+
The REST API documentation can be found on [docs.xquik.com](https://docs.xquik.com/api-reference/overview). The full API of this library can be found in [api.md](api.md).
1563

1664
## Installation
1765

0 commit comments

Comments
 (0)