https://github.com/FeedHive/twitter-api-client
A user-friendly Node.js / JavaScript client library for interacting with the Twitter API.
https://github.com/FeedHive/twitter-api-client
api-client nodejs twitter-api
Last synced: 4 months ago
JSON representation
A user-friendly Node.js / JavaScript client library for interacting with the Twitter API.
- Host: GitHub
- URL: https://github.com/FeedHive/twitter-api-client
- Owner: FeedHive
- License: mit
- Archived: true
- Created: 2020-07-21T13:58:56.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-08-20T08:46:08.000Z (about 3 years ago)
- Last Synced: 2025-06-15T04:48:59.059Z (5 months ago)
- Topics: api-client, nodejs, twitter-api
- Language: TypeScript
- Homepage:
- Size: 744 KB
- Stars: 947
- Watchers: 16
- Forks: 84
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Twitter API Client
Node.js client for Twitter API
[](https://www.npmjs.com/package/twitter-api-client)
### ⚠️ Important notice
Twitter now has an [official TypeScript SDK](https://github.com/twitterdev/twitter-api-typescript-sdk).
We recommend using that instead of this client.
This project will be maintained, but will not be developed any further.
To all contributors who added to this project: Thank you 🧡
## Table of content
- [Features](#features)
- [**Getting Started**](#getting-started)
- [Usage](#usage)
- [License](#license)
- [Get Help](#get-help)
- [Contribute](#contribute)
## Features
☑️ Includes 90% of the **official Twitter API** endpoints.
☑️ **Promise-based!** No ugly callbacks.
☑️ **Fully typed!** Both for query parameters and responses.
☑️ Inbuilt in-memory **cache** for rate-limit friendly usage.
## Getting Started
### Get your Twitter credentials
You will need to create a set of Twitter developer credentials from your Twitter Developer account.
If you don't have one already, apply for a developer account [here](https://developer.twitter.com/).
It takes about 5 minutes.
### Install
```console
npm i twitter-api-client
```
## Usage
```javascript
import { TwitterClient } from 'twitter-api-client';
const twitterClient = new TwitterClient({
apiKey: '',
apiSecret: '',
accessToken: '',
accessTokenSecret: '',
});
// Search for a user
const data = await twitterClient.accountsAndUsers.usersSearch({ q: 'twitterDev' });
// Get message event by Id
const data = await twitterClient.directMessages.eventsShow({ id: '1234' });
// Get most recent 25 retweets of a tweet
const data = await twitterClient.tweets.statusesRetweetsById({ id: '12345', count: 25 });
// Get local trends
const data = await twitterClient.trends.trendsAvailable();
```
[See all available methods here](https://github.com/FeedHive/twitter-api-client/blob/main/REFERENCES.md).
### Configuration
`twitter-api-client` comes with an inbuilt in-memory cache.
The stale data is served by the cache-first principle.
You can configure the caching behavior upon instantiation of the client:
```javascript
const twitterClient = new TwitterClient({
apiKey: '',
apiSecret: '',
accessToken: '',
accessTokenSecret: '',
ttl: 120, // seconds. Defaults to 360
disableCache: true, // Disables the caching behavior. Defaults to 'false'
maxByteSize: 32000000, // Maximum (approximated) memory size for cache store. Defaults to 16000000.
});
```
## License
This project is licensed under the [MIT License](https://github.com/Silind/twitter-api-client/blob/main/LICENSE)
## Get Help
- Reach out on [Twitter](https://twitter.com/SimonHoiberg)
- Open an [issue on GitHub](https://github.com/Silind/twitter-api-client/issues/new)
## Contribute
#### Issues
In the case of a bug report, bugfix or a suggestions, please feel very free to open an issue.
#### Pull request
Pull requests are always welcome, and I'll do my best to do reviews as fast as I can.
Please refer to the [contribution guide](https://github.com/Silind/twitter-api-client/blob/main/CONTRIBUTING.md) to see how to get started.