@kworq/x-api-post
v0.1.3
Published
A Node.js module for posting tweets with media (images, videos, GIFs) to X (formerly Twitter) using the API. It handles authentication, media uploading, and posting tweets.
Downloads
168
Maintainers
Readme
X / Twitter Media Upload and Posting
Overview
This Node.js module provides functionality to post tweets with media (images, videos, GIFs) to Twitter using Twitter's API. It handles the authentication, media uploading (including chunked uploads for large files), and posting of tweets with the uploaded media.
Requirements
- Node.js v20.0.0 or higher
- X / Twitter Developer Account with API keys
Installation
npm install @kworq/x-api-post
Working with source
- Clone the repository or copy the code into your project directory.
- Install the required dependencies using npm:
npm install
Run source
node --import ./esm-loader.mjs app.ts
Configuration
Before using this module, you need to set up the configuration with your Twitter API credentials. The configuration object should have the following properties:
X_API_KEY
X_API_SECRET
X_API_ACCESS_TOKEN
X_API_ACCESS_TOKEN_SECRET
Class
XApiClient
A class to handle posting tweets with media to Twitter.
Constructor
Creates an instance of XApiClient
.
new XApiClient(config)
Parameters:
config
: Configuration object containing Twitter API credentials.
Methods
postTweetWithMedia(text, mediaUrls)
Posts a tweet with the specified text and media.
Parameters:
text
: The text of the tweet.mediaUrls
: An array of media URLs to upload and attach to the tweet.
Usage Example
import XApiClient from '@kworq/x-api-post';
const config = {
X_API_KEY: 'your_api_key',
X_API_SECRET: 'your_api_secret',
X_API_ACCESS_TOKEN: 'your_access_token',
X_API_ACCESS_TOKEN_SECRET: 'your_access_token_secret',
};
const text = "Hello, world!";
const mediaUrls = ["https://www.w3schools.com/html/mov_bbb.mp4"];
const client = new XApiClient(config);
client.postTweetWithMedia(text, mediaUrls)
.then((response) => console.log(response))
.catch((error) => console.error("Error posting tweet:", error));
Notes
- Ensure you have valid Twitter API credentials.
- Media files larger than 5MB will be uploaded in chunks.
- The media upload process includes initialization, appending chunks, finalizing, and checking the status.
- This module requires Node.js v18.0.0 or higher to use the native
fetch
function.
License
This project is licensed under the MIT License.