Registry / http-networking / twitter-openapi-typescript

twitter-openapi-typescript

library0.0.55jsnpmunverified

twitter-openapi-typescript is a TypeScript library that provides an implementation of Twitter's (now X's) *internal* API, allowing programmatic interaction with the platform without relying on the official, public API. It is currently in a pre-1.0 development phase, indicated by its `0.0.55` version, suggesting frequent updates and potential breaking changes without prior notice due to the nature of interacting with internal, undocumented endpoints. The library emphasizes ease of use with guest clients for public data access and supports authenticated clients via cookie-based login (`ct0`, `auth_token`). A key differentiator is its focus on the internal API, which offers capabilities beyond the public API, though at a higher risk of instability and account suspension. The project ships with full TypeScript types, enhancing developer experience.

http-networking communication

npm install twitter-openapi-typescript

github ↗package ↗

INSTALL

IMPORT

SIG · TWITTER-OPENAPI-TY

twitter-openapi-typescript

http-networkingjavascriptv0.0.55

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

TwitterOpenApi

✓ import { TwitterOpenApi } from 'twitter-openapi-typescript';

✗ const TwitterOpenApi = require('twitter-openapi-typescript').TwitterOpenApi;

Primary class for initializing API access. The library is ESM-first, CJS `require` might lead to issues.

TwitterOpenApiClient

✓ import { TwitterOpenApiClient } from 'twitter-openapi-typescript';

✗ const { TwitterOpenApiClient } = require('twitter-openapi-typescript');

For advanced customization, direct instantiation of TwitterOpenApiClient might be preferred. Same ESM considerations apply.

TwitterOpenApi

✓ import { TwitterOpenApi } from 'twitter-openapi-typescript';

✗ import TwitterOpenApi from 'twitter-openapi-typescript';

The library exports named symbols, not a default export.

Demonstrates fetching a user's details (followers, friends count) using a guest client.

import { TwitterOpenApi } from 'twitter-openapi-typescript'; async function getUserDetails() { const api = new TwitterOpenApi(); // To avoid rate limits or access private data, you might need to log in: // const client = await api.getClientFromCookies({ // ct0: process.env.TWITTER_CT0 ?? '', // auth_token: process.env.TWITTER_AUTH_TOKEN ?? '' // }); const client = await api.getGuestClient(); const response = await client.getUserApi().getUserByScreenName({ screenName: 'elonmusk' }); const userLegacy = response.data?.user?.legacy; if (userLegacy) { console.log(`@${userLegacy.screenName}`); console.log(`Friends Count: ${userLegacy.friendsCount}, Followers Count: ${userLegacy.followersCount}`); } else { console.log('User not found or API response format changed.'); } } getUserDetails();

Debug

Known issues

breakingThis library relies on Twitter's undocumented internal APIs, which are subject to frequent and unannounced changes. This can lead to sudden breaking changes in the library's functionality, requiring updates or manual workarounds.

fix

Monitor library updates and GitHub issues frequently. Be prepared to adapt your code to API changes or unexpected responses.

affects: >=0.0.1

breakingModifying internal static variables (e.g., `TwitterOpenApi.fetchApi`, `TwitterOpenApi.twitter`, `TwitterOpenApi.bearer`) beyond what is explicitly documented can lead to account suspension by Twitter.

fix

Avoid modifying static variables unless absolutely necessary and with a full understanding of the implications. Use official API calls where possible.

affects: >=0.0.1

gotchaAuthentication tokens are often bound to the operating system (specifically, the `sec-ch-ua-platform` header) that issued them. Using a token generated on Windows with a default Linux-configured client (or vice-versa) will result in authentication failures.

fix

Set the `sec-ch-ua-platform` header using `api.setAdditionalApiHeaders({'sec-ch-ua-platform': '"Windows"'})` (or other OS values) to match the token's origin.

affects: >=0.0.1

gotchaThe library is pre-1.0 (version 0.0.55), indicating that its API is not yet stable. Expect frequent updates, potential changes to method signatures, and evolving data structures without strict semantic versioning adherence.

fix

Pin to exact versions in `package.json` or frequently review release notes and test your integration after updates.

affects: <1.0.0

gotchaThe project is dual-licensed under a Custom License and GNU Affero General Public License v3.0 (AGPLv3). AGPLv3 is a strong copyleft license that requires distributing the source code of your application if it interacts with the AGPLv3-licensed library over a network.

fix

Consult legal counsel to ensure compliance with the chosen license, especially for commercial or proprietary projects. Understand the implications of AGPLv3 for your codebase.

affects: >=0.0.1

Errors

Common errors & fixes

API request failed with status 401 Unauthorized

Invalid, expired, or improperly configured authentication cookies/tokens.

fix

Ensure `ct0` and `auth_token` are current and correctly passed to `getClientFromCookies()`. Check if the token's OS platform matches the client's `sec-ch-ua-platform` header.

API request failed with status 429 Too Many Requests

Twitter's internal API rate limits have been exceeded.

fix

Implement exponential backoff or introduce delays between requests. Consider using authenticated clients which might have higher rate limits than guest clients.

User not found (or similar data parsing errors)

The requested user does not exist, or Twitter's API response structure for user data has changed unexpectedly.

fix

Verify the `screenName` is correct. Check GitHub issues or the library's test cases for recent changes to API responses. Add robust error handling and null checks for API data.

Upgrade

Version history

0.0.55latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

39 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/fa0311/twitter-openapi-typescript ↗

packagehttps://www.npmjs.com/package/twitter-openapi-typescript ↗