https://github.com/twitterjs/twitter.js

A Node.js and TypeScript library for interacting with Twitter API v2
https://github.com/twitterjs/twitter.js

api bots hacktoberfest javascript nodejs twitter twitter-api typescript

Last synced: about 2 months ago
JSON representation

A Node.js and TypeScript library for interacting with Twitter API v2

• Host: GitHub
• URL: https://github.com/twitterjs/twitter.js
• Owner: twitterjs
• License: apache-2.0
• Created: 2021-01-04T21:15:05.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-01T02:59:16.000Z (over 1 year ago)
• Last Synced: 2024-05-06T11:45:57.378Z (about 2 months ago)
• Topics: api, bots, hacktoberfest, javascript, nodejs, twitter, twitter-api, typescript
• Language: TypeScript
• Homepage: https://twitter.js.org
• Size: 1.62 MB
• Stars: 85
• Watchers: 1
• Forks: 9
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Lists

• awesome-modern-twitter-api - twitter.js - A Node.js and TypeScript library for interacting with Twitter API v2. (Libraries / JavaScript (Node.js) / TypeScript)
• awesome - twitterjs/twitter.js - A Node.js and TypeScript library for interacting with Twitter API v2 (TypeScript)

README

        


  


    

  

  


    

    

    

    

  



# Twitter.js

A Node.js and TypeScript library for interacting with Twitter API v2

## Installation

```bash

npm i twitter.js

```

## Usage

🚀 Fetch details about a twitter user in no time:

```js

import { Client } from 'twitter.js';

import { bearerToken } from './secrets.js';

const client = new Client();

await client.loginWithBearerToken(bearerToken);

const user = await client.users.fetchByUsername('iShiibi');

console.log(user.description); // Contributing to open-source 🌐

```

🔒 Make [`user-context`](https://developer.twitter.com/en/docs/authentication/oauth-1-0a) authorized requests without any hassle:

```js

import { Client } from 'twitter.js';

import { credentials } from './secrets.js';

const client = new Client();

await client.login(credentials);

const tweet = await client.tweets.fetch('1336749579228745728');

await tweet.like();

```

📈 Want real-time events listening? We got you covered:

```js

import { Client } from 'twitter.js';

import { credentials } from './secrets.js';

const client = new Client({ events: ['FILTERED_TWEET_CREATE'] });

await client.login(credentials);

await client.filteredStreamRules.create({ value: '@tjs_test' });

client.on('filteredTweetCreate', async tweet => {

	console.log(tweet.text); // hey @tjs_test, like this tweet if you're listening!

	await tweet.like();

});

```

## Future

The `twitter.js` library is not ready for production use yet. You can expect breaking changes without any major version bump until we release `v1.0.0` of the library.