Skip to content

docs: map common X data tasks #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kriptoburak merged 1 commit into from
Jul 23, 2026
Merged

docs: map common X data tasks #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Xquik Java SDK
# X (Twitter) Scraper Java SDK: Tweet Search, Timelines, Followers & Posting

Use the Xquik REST API from Java 8 or later.
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13735/badge)](https://www.bestpractices.dev/projects/13735)

Use Xquik's typed Java client for X data and confirmed actions.

[API reference](https://docs.xquik.com/api-reference/overview) ·
[Authentication](https://xquik.com/auth.md) ·
Expand All @@ -13,6 +15,20 @@ Use the Xquik REST API from Java 8 or later.

<!-- x-release-please-end -->

## Common X Data Tasks

Use the linked Javadocs for typed method names.

| Customer Question | REST Route | Workflow Note |
| --- | --- | --- |
| How do I search tweets? | `GET /x/tweets/search` | Use keyword or advanced operator queries. |
| How do I read a profile timeline? | `GET /x/users/{id}/tweets` | Paginate bounded results. |
| How do I scrape followers? | `GET /x/users/{id}/followers` | Use an extraction for complete datasets. |
| How do I scrape following accounts? | `GET /x/users/{id}/following` | Use an extraction for complete datasets. |
| How do I read my home timeline? | `GET /x/timeline` | Approve this private read. |
| How do I monitor an account? | `POST /monitors` | Deliver events through HMAC webhooks. |
| How do I post or reply? | `POST /x/tweets` | Confirm the account and payload. |

## Install

<!-- x-release-please-start-version -->
Expand Down