Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
X API v2 向け公式 TypeScript XDK クライアントライブラリのインストールと使用方法。認証、型付きレスポンス、ページネーション、ストリーミングの例を含みます。
npm install @xdevplatform/xdk
yarn add @xdevplatform/xdk
pnpm add @xdevplatform/xdk
import { Client } from '@xdevplatform/xdk';
const client = new Client({ bearerToken: 'YOUR_BEARER_TOKEN' });
const userResponse = await client.users.getByUsername('XDevelopers');
console.log(userResponse.data?.username);
| 機能 | 説明 |
|---|---|
| 型安全性 | すべてのエンドポイントとパラメーターに対する完全な TypeScript 定義 |
| 認証 | Bearer Token、PKCE 付き OAuth 2.0、および OAuth 1.0a |
| 自動ページネーション | ページネーション対応エンドポイントで非同期イテレーションをサポート |
| ストリーミング | 自動再接続を備えたイベント駆動型ストリーミング |
| 完全な API カバレッジ | Users、Posts、Lists、Bookmarks、Communities ほか |
import { Client } from '@xdevplatform/xdk';
const client = new Client({ bearerToken: 'YOUR_BEARER_TOKEN' });
import { Client, OAuth2, generateCodeVerifier, generateCodeChallenge } from '@xdevplatform/xdk';
const oauth2 = new OAuth2({
clientId: 'YOUR_CLIENT_ID',
clientSecret: 'YOUR_CLIENT_SECRET',
redirectUri: 'https://your-app.com/callback',
scope: ['tweet.read', 'users.read', 'offline.access'],
});
const codeVerifier = generateCodeVerifier();
const codeChallenge = await generateCodeChallenge(codeVerifier);
oauth2.setPkceParameters(codeVerifier, codeChallenge);
const authUrl = await oauth2.getAuthorizationUrl('state');
const tokens = await oauth2.exchangeCode(authCode, codeVerifier);
const client = new Client({ accessToken: tokens.access_token });
import { Client, OAuth1 } from '@xdevplatform/xdk';
const oauth1 = new OAuth1({
apiKey: 'YOUR_API_KEY',
apiSecret: 'YOUR_API_SECRET',
accessToken: 'YOUR_ACCESS_TOKEN',
accessTokenSecret: 'YOUR_ACCESS_TOKEN_SECRET'
});
const client = new Client({ oauth1: oauth1 });
| カテゴリ | メソッド |
|---|---|
| Posts | client.posts.search() |
| Users | client.users.getMe() |
| Spaces | client.spaces.findSpaceById() |
| Lists | client.lists.getList() |
| DMs | client.directMessages.lookup() |