Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/p1atdev/whisper
A client that wraps the API behind Twitter.
https://github.com/p1atdev/whisper
api-client deno twitter typescript
Last synced: 5 days ago
JSON representation
A client that wraps the API behind Twitter.
- Host: GitHub
- URL: https://github.com/p1atdev/whisper
- Owner: p1atdev
- License: mit
- Created: 2022-08-13T03:42:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-10T21:09:32.000Z (over 1 year ago)
- Last Synced: 2024-12-17T02:38:46.826Z (19 days ago)
- Topics: api-client, deno, twitter, typescript
- Language: TypeScript
- Homepage: https://deno.land/x/whisper
- Size: 40 KB
- Stars: 27
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Whisper
A client that wraps the API behind Twitter.
[](https://deno.land/x/whisper)
[](https://velociraptor.run)
[](https://codecov.io/gh/p1atdev/whisper)
## Features
- You can use endpoints not officially provided
- GraphQL endpoint (`UserByScreenName`, `UserTweets`, etc...)
- "i" endpoint (`/users/email_available.json`, etc...)
- You can use the hidden api without any tokens
- Whisper uses the official web client's token
## Example
Full example code can be seen on `/test/example.test.ts`
### User By Screen Name (GraphQL endpoint)
```ts
const client = new TwitterAPI(Bearer.Web);
const query = new RequestQuery({
variables: {
screen_name: "deno_land",
withSafetyModeUserFields: true,
withSuperFollowsUserFields: true,
},
});
const res = await client.request({
method: "GET",
urlType: "gql",
path: "UserByScreenName",
query: query,
});
const json = await res.json();
assertEquals(json.data.user.result.rest_id, "1108769816230293504");
```
### Search Adaptive (v2 endpoint)
```ts
const client = new TwitterAPI(Bearer.Web);
const query = new RequestQuery({
q: "from:@deno_land",
count: 3,
});
const res = await client.request({
method: "GET",
urlType: "i/api/2",
path: "/search/adaptive.json",
query: query,
});
const json = await res.json();
assertExists(json.globalObjects.users["1108769816230293504"]);
```
### User Tweets (GraphQL endpoint)
```ts
const client = new TwitterAPI(Bearer.Web);
const query = new RequestQuery({
variables: {
userId: "1108769816230293504",
count: 4,
includePromotedContent: false,
withVoice: false,
withDownvotePerspective: true,
withReactionsMetadata: false,
withReactionsPerspective: false,
withSuperFollowsTweetFields: false,
withSuperFollowsUserFields: false,
},
features: {
tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled:
false,
interactive_text_enabled: true,
standardized_nudges_misinfo: true,
responsive_web_edit_tweet_api_enabled: true,
responsive_web_enhance_cards_enabled: false,
vibe_api_enabled: true,
dont_mention_me_view_api_enabled: true,
responsive_web_uc_gql_enabled: true,
},
});
const res = await client.request({
method: "GET",
urlType: "gql",
path: "UserTweets",
query: query,
});
const json = await res.json();
const timeline = json.data.user.result.timeline;
console.dir(timeline, { depth: 10 });
// Output:
//
// {
// timeline: {
// instructions: [
// { type: "TimelineClearCache" },
// {
// type: "TimelineAddEntries",
// entries: [
// {
// entryId: "tweet-1558145641565474816",
// sortIndex: "1558145641565474816",
// content: {
// entryType: "TimelineTimelineItem",
// __typename: "TimelineTimelineItem",
// itemContent: {
// itemType: "TimelineTweet",
// __typename: "TimelineTweet",
// tweet_results: {
// result: {
// __typename: "Tweet",
// rest_id: "1558145641565474816",
// core: [Object],
// card: [Object],
// unmention_info: [Object],
// unified_card: [Object],
// edit_control: [Object],
// legacy: [Object]
// }
// },
// tweetDisplayType: "Tweet",
// ruxContext: "HHwWgMCqnZTN0p8rAAAA"
// ...
```
### Email Available (i endpoint)
```ts
const client = new TwitterAPI(Bearer.Web);
const query = new RequestQuery({
email: "[email protected]",
});
const res = await client.request({
method: "GET",
urlType: "i/api/i",
path: "/users/email_available.json",
query: query,
});
const json = await res.json();
assertEquals(json.valid, false);
assertEquals(json.taken, false);
```
## Note
Request parameters and response types are not supported in this module due to
the rapidly changing unofficial API specifications. Beware that Twitter will
change its API specification without notice.