Skip to content

Commit 754411a

Browse files
Burak Bayırkriptoburak
andauthored
docs: map common X data tasks (#15)
Signed-off-by: kriptoburak <kriptoburak@users.noreply.github.com> Co-authored-by: kriptoburak <kriptoburak@users.noreply.github.com>
1 parent 64086a9 commit 754411a

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,27 @@
1-
# Xquik Ruby SDK
1+
# X (Twitter) Scraper Ruby SDK: Tweet Search, Timelines, Followers & Posting
22

3-
Use the Xquik API from Ruby 3.2+. The SDK includes Yard, RBS, and RBI types. It uses `net/http` with connection pooling.
3+
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13739/badge)](https://www.bestpractices.dev/projects/13739)
4+
5+
Use Xquik's typed Ruby client for X data and confirmed actions.
46

57
## Documentation
68

79
Read the [Ruby SDK guide](https://docs.xquik.com/sdks/ruby), [API guide](https://docs.xquik.com/api-reference/overview), or [RubyDoc reference](https://gemdocs.org/gems/x-twitter-scraper).
810

11+
## Common X Data Tasks
12+
13+
Use the linked Ruby reference for typed method names.
14+
15+
| Customer Question | REST Route | Workflow Note |
16+
| --- | --- | --- |
17+
| How do I search tweets? | `GET /x/tweets/search` | Use keyword or advanced operator queries. |
18+
| How do I read a profile timeline? | `GET /x/users/{id}/tweets` | Paginate bounded results. |
19+
| How do I scrape followers? | `GET /x/users/{id}/followers` | Use an extraction for complete datasets. |
20+
| How do I scrape following accounts? | `GET /x/users/{id}/following` | Use an extraction for complete datasets. |
21+
| How do I read my home timeline? | `GET /x/timeline` | Approve this private read. |
22+
| How do I monitor an account? | `POST /monitors` | Deliver events through HMAC webhooks. |
23+
| How do I post or reply? | `POST /x/tweets` | Confirm the account and payload. |
24+
925
## Installation
1026

1127
Add the gem to your `Gemfile`:

0 commit comments

Comments
 (0)