Skip to main content
Client for general operations This client provides methods for interacting with the general endpoints of the X API. It handles authentication, request formatting, and response parsing for all general related operations.

​
Constructors

​
constructor

• new GeneralClient(client): GeneralClient Creates a new general client instance

​
Parameters

NameTypeDescription
clientClientThe main X API client instance

​
Returns

GeneralClient

​
Defined in

general/client.ts:33

​
Methods

​
getOpenApiSpec

▸ getOpenApiSpec(): Promise<GetOpenApiSpecResponse> Get OpenAPI Spec. Retrieves the full OpenAPI Specification in JSON format. (See https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)

​
Returns

Promise<GetOpenApiSpecResponse> Promise resolving to the API response

​
Defined in

general/client.ts:46