-
Notifications
You must be signed in to change notification settings - Fork 0
Improve Go SDK Context7 docs #7
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.
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,90 @@ | ||||||||||||||||||||||||||
| # Context7 Guide | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Use this page as the compact Context7-facing guide for the Xquik Go SDK. It | ||||||||||||||||||||||||||
| focuses on install, authentication, first requests, and common X automation | ||||||||||||||||||||||||||
| workflows. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Install | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ```sh | ||||||||||||||||||||||||||
| go get github.com/Xquik-dev/x-twitter-scraper-go@v0.4.1 | ||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Import the SDK as `xtwitterscraper`: | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ```go | ||||||||||||||||||||||||||
| import ( | ||||||||||||||||||||||||||
| xtwitterscraper "github.com/Xquik-dev/x-twitter-scraper-go" | ||||||||||||||||||||||||||
| "github.com/Xquik-dev/x-twitter-scraper-go/option" | ||||||||||||||||||||||||||
| ) | ||||||||||||||||||||||||||
|
Comment on lines
+16
to
+19
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Authenticate | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Set an API key in the process environment: | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ```sh | ||||||||||||||||||||||||||
| export X_TWITTER_SCRAPER_API_KEY="your-api-key" | ||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Then create a client: | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ```go | ||||||||||||||||||||||||||
| client := xtwitterscraper.NewClient( | ||||||||||||||||||||||||||
| option.WithAPIKey(os.Getenv("X_TWITTER_SCRAPER_API_KEY")), | ||||||||||||||||||||||||||
| ) | ||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Never place API keys, webhook signing values, or user credentials in source | ||||||||||||||||||||||||||
| files, logs, examples, issues, or commits. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## First Request | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Search recent tweets with X query operators: | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ```go | ||||||||||||||||||||||||||
| paginatedTweets, err := client.X.Tweets.Search(context.TODO(), xtwitterscraper.XTweetSearchParams{ | ||||||||||||||||||||||||||
| Q: "from:elonmusk", | ||||||||||||||||||||||||||
| Limit: xtwitterscraper.Int(10), | ||||||||||||||||||||||||||
| }) | ||||||||||||||||||||||||||
| if err != nil { | ||||||||||||||||||||||||||
| panic(err) | ||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| for _, tweet := range paginatedTweets.Tweets { | ||||||||||||||||||||||||||
| fmt.Printf("@%s: %s\n", tweet.Author.Username, tweet.Text) | ||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Common Workflows | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| | Workflow | SDK entry point | | ||||||||||||||||||||||||||
| | --- | --- | | ||||||||||||||||||||||||||
| | Tweet search | `client.X.Tweets.Search` | | ||||||||||||||||||||||||||
| | Tweet lookup | `client.X.Tweets.Get` | | ||||||||||||||||||||||||||
| | User lookup | `client.X.Users.Get` | | ||||||||||||||||||||||||||
| | User search | `client.X.Users.GetSearch` | | ||||||||||||||||||||||||||
| | Follower export | `client.X.Users.GetFollowers` | | ||||||||||||||||||||||||||
| | Following export | `client.X.Users.GetFollowing` | | ||||||||||||||||||||||||||
| | Media upload | `client.X.Media.Upload` | | ||||||||||||||||||||||||||
| | Media download | `client.X.Media.Download` | | ||||||||||||||||||||||||||
| | Account monitoring | `client.Monitors.New` | | ||||||||||||||||||||||||||
| | Monitor events | `client.Events.List` | | ||||||||||||||||||||||||||
| | HMAC webhooks | `client.Webhooks.New` | | ||||||||||||||||||||||||||
| | Giveaway draws | `client.Draws.Run` | | ||||||||||||||||||||||||||
| | Bulk extractions | `client.Extractions.Run` | | ||||||||||||||||||||||||||
| | Regional trends | `client.Trends.List` | | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Use `api.md` for generated method coverage and | ||||||||||||||||||||||||||
| <https://pkg.go.dev/github.com/Xquik-dev/x-twitter-scraper-go> for Go type | ||||||||||||||||||||||||||
| signatures. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Public Sources | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| - GitHub: <https://github.com/Xquik-dev/x-twitter-scraper-go> | ||||||||||||||||||||||||||
| - Go reference: <https://pkg.go.dev/github.com/Xquik-dev/x-twitter-scraper-go> | ||||||||||||||||||||||||||
| - Xquik Go SDK docs: <https://docs.xquik.com/sdks/go> | ||||||||||||||||||||||||||
| - REST API docs: <https://docs.xquik.com/api-reference/overview> | ||||||||||||||||||||||||||
| - OpenAPI spec: <https://xquik.com/openapi.json> | ||||||||||||||||||||||||||
| - Context7: <https://context7.com/xquik-dev/x-twitter-scraper-go> | ||||||||||||||||||||||||||
| - DeepWiki: <https://deepwiki.com/Xquik-dev/x-twitter-scraper-go> | ||||||||||||||||||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
v0.4.1means this install command will silently stay on an old version as the SDK evolves. Using@latestkeeps it current without manual doc updates.