Skip to main content
Main client class for the X API This is the primary entry point for interacting with the X API. It provides access to all API endpoints through specialized client modules and handles authentication, request configuration, and error handling. Example

Constructors

constructor

new Client(config): Client Creates a new X API client instance

Parameters

Returns

Client Example
client.ts:401

Properties

string
required
Base URL for API requests
string
Bearer token for authentication
string
OAuth2 access token
any
OAuth1 instance for authentication
Headers
required
Headers for requests
number
required
Request timeout in milliseconds
boolean
required
Whether to automatically retry failed requests
number
required
Maximum number of retry attempts
HttpClient = httpClient
required
HTTP client for making requests
GeneralClient
required
general client
AccountActivityClient
required
account activity client
CommunityNotesClient
required
community notes client
ComplianceClient
required
compliance client
ConnectionsClient
required
connections client
UsersClient
required
users client
NewsClient
required
news client
SpacesClient
required
spaces client
ActivityClient
required
activity client
UsageClient
required
usage client
trends client
PostsClient
required
posts client
DirectMessagesClient
required
direct messages client
CommunitiesClient
required
communities client
MediaClient
required
media client
WebhooksClient
required
webhooks client
StreamClient
required
stream client
ListsClient
required
lists client
Promise<T>
required
Make an authenticated request to the X APIThis method handles authentication, request formatting, and error handling for all API requests. It automatically adds the appropriate authentication headers based on the client configuration.
boolean
required
Check if the OAuth2 token is expired
Promise<void>
required
Refresh the OAuth2 token
boolean
required
Get the current authentication status
string[]
required
Map OpenAPI security scheme names to internal authentication types
void
required
Validate that the required authentication method is available
string[]
required
Get available authentication types