twitter-openapi-typescript-generated

v0.0.40

Published

5 days ago

OpenAPI client for twitter-openapi-typescript-generated

0High
0Medium
0Low

fa0311

twitter api typescript scraper

[email protected]

A TypeScript SDK client for the x.com API.

Usage

First, install the SDK from npm.

npm install twitter-openapi-typescript-generated --save

Next, try it out.

import {
  Configuration,
  DefaultApi,
} from 'twitter-openapi-typescript-generated';
import type { GetProfileSpotlightsQueryRequest } from 'twitter-openapi-typescript-generated';

async function example() {
  console.log("🚀 Testing twitter-openapi-typescript-generated SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: Accept
    apiKey: "YOUR API KEY",
    // To configure API key authorization: ClientLanguage
    apiKey: "YOUR API KEY",
    // To configure API key authorization: Priority
    apiKey: "YOUR API KEY",
    // To configure API key authorization: Referer
    apiKey: "YOUR API KEY",
    // To configure API key authorization: SecFetchDest
    apiKey: "YOUR API KEY",
    // To configure API key authorization: SecChUaPlatform
    apiKey: "YOUR API KEY",
    // To configure API key authorization: SecFetchMode
    apiKey: "YOUR API KEY",
    // To configure API key authorization: CsrfToken
    apiKey: "YOUR API KEY",
    // To configure API key authorization: ClientUuid
    apiKey: "YOUR API KEY",
    // Configure HTTP bearer authorization: BearerAuth
    accessToken: "YOUR BEARER TOKEN",
    // To configure API key authorization: GuestToken
    apiKey: "YOUR API KEY",
    // To configure API key authorization: SecChUa
    apiKey: "YOUR API KEY",
    // To configure API key authorization: CookieGt0
    apiKey: "YOUR API KEY",
    // To configure API key authorization: ClientTransactionId
    apiKey: "YOUR API KEY",
    // To configure API key authorization: ActiveUser
    apiKey: "YOUR API KEY",
    // To configure API key authorization: CookieCt0
    apiKey: "YOUR API KEY",
    // To configure API key authorization: UserAgent
    apiKey: "YOUR API KEY",
    // To configure API key authorization: AcceptLanguage
    apiKey: "YOUR API KEY",
    // To configure API key authorization: SecFetchSite
    apiKey: "YOUR API KEY",
    // To configure API key authorization: AuthType
    apiKey: "YOUR API KEY",
    // To configure API key authorization: CookieAuthToken
    apiKey: "YOUR API KEY",
    // To configure API key authorization: SecChUaMobile
    apiKey: "YOUR API KEY",
    // To configure API key authorization: AcceptEncoding
    apiKey: "YOUR API KEY",
  });
  const api = new DefaultApi(config);

  const body = {
    // string
    pathQueryId: mzoqrVGwk-YTSGME1dRfXQ,
    // string
    variables: {"screen_name": "elonmusk"},
    // string
    features: {},
  } satisfies GetProfileSpotlightsQueryRequest;

  try {
    const data = await api.getProfileSpotlightsQuery(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://x.com/i/api

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- DefaultApi | getProfileSpotlightsQuery | GET /graphql/{pathQueryId}/ProfileSpotlightsQuery | DefaultApi | getTweetResultByRestId | GET /graphql/{pathQueryId}/TweetResultByRestId | OtherApi | other | GET /other | PostApi | postCreateBookmark | POST /graphql/{pathQueryId}/CreateBookmark | PostApi | postCreateRetweet | POST /graphql/{pathQueryId}/CreateRetweet | PostApi | postCreateTweet | POST /graphql/{pathQueryId}/CreateTweet | PostApi | postDeleteBookmark | POST /graphql/{pathQueryId}/DeleteBookmark | PostApi | postDeleteRetweet | POST /graphql/{pathQueryId}/DeleteRetweet | PostApi | postDeleteTweet | POST /graphql/{pathQueryId}/DeleteTweet | PostApi | postFavoriteTweet | POST /graphql/{pathQueryId}/FavoriteTweet | PostApi | postUnfavoriteTweet | POST /graphql/{pathQueryId}/UnfavoriteTweet | TweetApi | getBookmarks | GET /graphql/{pathQueryId}/Bookmarks | TweetApi | getCommunityAboutTimeline | GET /graphql/{pathQueryId}/CommunityAboutTimeline | TweetApi | getCommunityMediaTimeline | GET /graphql/{pathQueryId}/CommunityMediaTimeline | TweetApi | getCommunityTweetsTimeline | GET /graphql/{pathQueryId}/CommunityTweetsTimeline | TweetApi | getHomeLatestTimeline | GET /graphql/{pathQueryId}/HomeLatestTimeline | TweetApi | getHomeTimeline | GET /graphql/{pathQueryId}/HomeTimeline | TweetApi | getLikes | GET /graphql/{pathQueryId}/Likes | TweetApi | getListLatestTweetsTimeline | GET /graphql/{pathQueryId}/ListLatestTweetsTimeline | TweetApi | getNotificationsTimeline | GET /graphql/{pathQueryId}/NotificationsTimeline | TweetApi | getSearchTimeline | GET /graphql/{pathQueryId}/SearchTimeline | TweetApi | getTweetDetail | GET /graphql/{pathQueryId}/TweetDetail | TweetApi | getUserHighlightsTweets | GET /graphql/{pathQueryId}/UserHighlightsTweets | TweetApi | getUserMedia | GET /graphql/{pathQueryId}/UserMedia | TweetApi | getUserTweets | GET /graphql/{pathQueryId}/UserTweets | TweetApi | getUserTweetsAndReplies | GET /graphql/{pathQueryId}/UserTweetsAndReplies | UserApi | getUserByRestId | GET /graphql/{pathQueryId}/UserByRestId | UserApi | getUserByScreenName | GET /graphql/{pathQueryId}/UserByScreenName | UserListApi | getBlueVerifiedFollowers | GET /graphql/{pathQueryId}/BlueVerifiedFollowers | UserListApi | getFavoriters | GET /graphql/{pathQueryId}/Favoriters | UserListApi | getFollowers | GET /graphql/{pathQueryId}/Followers | UserListApi | getFollowersYouKnow | GET /graphql/{pathQueryId}/FollowersYouKnow | UserListApi | getFollowing | GET /graphql/{pathQueryId}/Following | UserListApi | getRetweeters | GET /graphql/{pathQueryId}/Retweeters | UsersApi | getUsersByRestIds | GET /graphql/{pathQueryId}/UsersByRestIds | V11GetApi | getFriendsFollowingList | GET /1.1/friends/following/list.json | V11GetApi | getSearchTypeahead | GET /1.1/search/typeahead.json | V11PostApi | postCreateFriendships | POST /1.1/friendships/create.json | V11PostApi | postDestroyFriendships | POST /1.1/friendships/destroy.json | V20GetApi | getSearchAdaptive | GET /2/search/adaptive.json |

Models

Authorization

Authentication schemes defined for the API:

Accept

Type: API key
API key parameter name: Accept
Location: HTTP header

AcceptEncoding

Type: API key
API key parameter name: Accept-Encoding
Location: HTTP header

AcceptLanguage

Type: API key
API key parameter name: Accept-Language
Location: HTTP header

ActiveUser

Type: API key
API key parameter name: x-twitter-active-user
Location: HTTP header

AuthType

Type: API key
API key parameter name: x-twitter-auth-type
Location: HTTP header

BearerAuth

Type: HTTP Bearer Token authentication

ClientLanguage

Type: API key
API key parameter name: x-twitter-client-language
Location: HTTP header

ClientTransactionId

Type: API key
API key parameter name: x-client-transaction-id
Location: HTTP header

ClientUuid

Type: API key
API key parameter name: x-client-uuid
Location: HTTP header

CookieAuthToken

Type: API key
API key parameter name: auth_token
Location:

CookieCt0

Type: API key
API key parameter name: ct0
Location:

CookieGt0

Type: API key
API key parameter name: gt0
Location:

CsrfToken

Type: API key
API key parameter name: x-csrf-token
Location: HTTP header

GuestToken

Type: API key
API key parameter name: x-guest-token
Location: HTTP header

Priority

Type: API key
API key parameter name: Priority
Location: HTTP header

Referer

Type: API key
API key parameter name: Referer
Location: HTTP header

SecChUa

Type: API key
API key parameter name: Sec-Ch-Ua
Location: HTTP header

SecChUaMobile

Type: API key
API key parameter name: Sec-Ch-Ua-Mobile
Location: HTTP header

SecChUaPlatform

Type: API key
API key parameter name: Sec-Ch-Ua-Platform
Location: HTTP header

SecFetchDest

Type: API key
API key parameter name: Sec-Fetch-Dest
Location: HTTP header

SecFetchMode

Type: API key
API key parameter name: Sec-Fetch-Mode
Location: HTTP header

SecFetchSite

Type: API key
API key parameter name: Sec-Fetch-Site
Location: HTTP header

UserAgent

Type: API key
API key parameter name: user-agent
Location: HTTP header

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: 0.0.1
Package version: 0.0.40
Generator version: 7.22.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

LicenseRef-Custom OR AGPL-3.0-or-later