GitHub repository
Source code, issues, and releases.
Installation
Quick start
Key features
| Feature | Description |
|---|---|
| Type safety | Complete TypeScript definitions for all endpoints and parameters |
| Authentication | Bearer Token, OAuth 2.0 with PKCE, and OAuth 1.0a |
| Automatic pagination | Async iteration support for paginated endpoints |
| Streaming | Event-driven streaming with automatic reconnection |
| Full API coverage | Users, Posts, Lists, Bookmarks, Communities, and more |
Authentication
- Bearer Token
- OAuth 2.0
- OAuth 1.0a
Common methods
| Category | Method |
|---|---|
| Posts | client.posts.search() |
| Users | client.users.getMe() |
| Spaces | client.spaces.findSpaceById() |
| Lists | client.lists.getList() |
| DMs | client.directMessages.lookup() |
Learn more
Installation
Package managers, TypeScript setup, and requirements.
Authentication
Detailed guide for all auth methods.
Pagination
Async iteration and paginated responses.
Streaming
Event-driven streaming with reconnection.
API Reference
Complete client, interface, and type reference.