twitter.js

Twitter.js

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

Installation

npm i twitter.js

Usage

🚀 Fetch details about a twitter user in no time:

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

const client = new Client();
await client.loginWithBearerToken(bearerToken);

const user = await client.users.fetchByUsername({ username: 'iShiibi' });
console.log(user.description); // Contributing to open-source 🌐

🔒 Make user-context authorized requests without any hassle:

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

const client = new Client();
await client.login(credentials);

const tweet = await client.tweets.fetch({ tweet: '1336749579228745728' });
await tweet.like();

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

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.

There is an autogenerated documentation website for API references. We hope to replace it with a custom one soon. If you love web development, then feel free to discuss how you can contribute towards this goal in our Discord server.

We are also building a guide website to teach new users how to use the twitter.js library.