Official Xquik SDKs wrap the REST API with generated request types, response models, retries, pagination helpers, and consistent authentication.Documentation Index
Fetch the complete documentation index at: https://docs.xquik.com/llms.txt
Use this file to discover all available pages before exploring further.
TypeScript / Node.js
Use typed REST calls from Node.js, Bun, Next.js route handlers, workers, and backend services.
Python
Build sync or async Python jobs for tweet search, user lookup, exports, monitors, and webhook automation.
Go
Add X data workflows to Go services with generated models, request options, and context-aware calls.
Java
Use Maven or Gradle to add the Java SDK to Spring, worker, and JVM backend applications.
Kotlin
Use idiomatic Kotlin types, nullable values, sequences, and suspend-friendly client surfaces.
C# / .NET
Install from NuGet and call Xquik from .NET services, workers, and command-line tools.
Ruby
Use the Ruby gem with Yard, RBS, RBI, retries, and connection pooling.
PHP
Add the Composer package to PHP 8.1+ applications with named parameters and typed exceptions.
CLI
Install the command-line tool for shell workflows, JSON output, and scripted API calls.
Terraform Provider
Manage Xquik resources as infrastructure and prepare for provider registry publication.
Choose an SDK
| SDK | Install | Source |
|---|---|---|
| TypeScript | npm install x-twitter-scraper | GitHub |
| Python | pip install x_twitter_scraper | GitHub |
| Go | go get github.com/Xquik-dev/x-twitter-scraper-go | GitHub |
| Java | com.x_twitter_scraper.api:x-twitter-scraper-java | GitHub |
| Kotlin | com.x_twitter_scraper.api:x-twitter-scraper-kotlin | GitHub |
| C# / .NET | dotnet add package XTwitterScraper | GitHub |
| Ruby | gem install x-twitter-scraper | GitHub |
| PHP | composer require xquik/x-twitter-scraper | GitHub |
| CLI | go install github.com/Xquik-dev/x-twitter-scraper-cli/cmd/x-twitter-scraper@latest | GitHub |
| Terraform | Local provider build while registry publication is pending | GitHub |
Authentication
All SDKs accept the same API credentials as the REST API:X_TWITTER_SCRAPER_BEARER_TOKEN.
Common Workflows
- Search tweets and inspect threads through Search Tweets, Get Tweet, and Tweet Thread.
- Look up profiles and relationships through Get User, Followers, and Check Follower.
- Create account monitors with Create Monitor, then receive events through Webhooks.
- Run exports and giveaway workflows with Extractions and Draws.
- Connect agents through the MCP Server when you need tool use instead of direct SDK calls.
Error Handling & Pagination
Generated SDKs map HTTP errors into language-native exception or error types. Start with the error handling guide for status code semantics and the per-language page for idiomatic handling. Paginated endpoints return a page object with a next-page marker such ashas_next_page, hasNextPage, or HasNextPage depending on language casing. Use the SDK’s generated pagination helpers when available, or pass the cursor fields documented on each endpoint.