twttrapi-middleware

A Node.js module to interact with the Twitter API via RapidAPI's twttrapi service. This middleware provides a simplified interface for accessing Twitter data without directly using the official Twitter API.

Features

• Get tweet by ID
• Get user tweets, replies, and media
• Search tweets (latest and top results)
• Search users
• Get user profile information
• Get user followers and following lists

Installation

npm install twttrapi-middleware

Requirements

You need a RapidAPI key with access to the twttrapi service. Sign up at RapidAPI and subscribe to the twttrapi service.

Configuration

Set your RapidAPI key as an environment variable:

export RAPID_API_KEY="your-rapidapi-key"

Optionally, enable debug mode:

export DEBUG=true

Usage

import TwttrApi from "twttrapi-middleware";

// Get instance (singleton pattern)
const twttr = TwttrApi.getInstance();

// Example: Get a tweet by ID
twttr.getTweetById('1907254694163980405')
  .then(tweet => console.log(tweet))
  .catch(error => console.error(error));

// Example: Get a user's tweets
twttr.getUserTweets('username')
  .then(tweets => console.log(tweets))
  .catch(error => console.error(error));

API Reference

TwttrApi.getInstance()

Returns the singleton instance of the TwttrApi class.

Methods

All methods return a Promise that resolves to the requested data or an error response.

• getTweetById(id: string): Get a tweet by its ID
• getUserTweets(username: string): Get tweets from a user
• getUserReplies(username: string): Get replies from a user
• getUserMedia(username: string): Get media tweets from a user
• searchTop(query: string): Search top tweets for a query
• searchLatest(query: string): Search latest tweets for a query
• searchUsers(query: string): Search users by query
• getUser(username: string): Get a user's profile information
• getUserFollowers(username: string): Get a user's followers
• getUserFollowing(username: string): Get accounts a user is following

Response Types

The module primarily returns Tweet, User, and Media objects or ErrorResponse if an error occurs.

Development

# Install dependencies
npm install

# Build
npm run build

# Run tests
npm test

# Run in development mode
npm run dev

License

MIT © dcSpark