SDK officiels

SDK officiels X API pour TypeScript et Python

X fournit des SDK officiels pour TypeScript et Python. Ces bibliothèques gèrent l’authentification, la pagination et garantissent une sécurité de typage complète.

SDK Python

Prise en charge de l’asynchrone, annotations de type, couverture v2 complète.

SDK TypeScript

Types TypeScript complets, compatibilité ESM, fonctionne avec Node.js.

---

Pourquoi utiliser les SDK officiels ?

Avantage	Description
Toujours à jour	Maintenus par X et mis à jour avec de nouveaux endpoints
Sécurité de typage	Définitions de types complètes pour tous les objets et méthodes
Authentification intégrée	Prise en charge d’OAuth 2.0 et OAuth 1.0a
Pagination automatique	Parcourez les résultats sans gérer manuellement les jetons

---

Démarrage rapide

Python

Installation

pip install xdk

Utilisation de base

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Rechercher des publications (retourne un itérateur)
for page in client.posts.search_recent(query="api", max_results=10):
    if page.data and len(page.data) > 0:
        first_post = page.data[0]
        print(first_post.text)
        break

TypeScript

Installation

npm install @xdevplatform/xdk

Utilisation de base

import { Client } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: 'YOUR_BEARER_TOKEN' });

// Rechercher un utilisateur
const userResponse = await client.users.getByUsername('XDevelopers');
console.log(userResponse.data?.username);

---

Authentification

Les deux SDK prennent en charge plusieurs méthodes d’authentification :

Jeton Bearer (App uniquement)

Option la plus simple pour lire des données publiques.

Python :

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

TypeScript :

import { Client } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: 'YOUR_BEARER_TOKEN' });

OAuth 2.0 (Contexte utilisateur)

Pour effectuer des actions pour le compte des utilisateurs (publication, abonnement, etc.).

Python :

from xdk import Client
from xdk.oauth2_auth import OAuth2PKCEAuth

auth = OAuth2PKCEAuth(
    client_id="YOUR_CLIENT_ID",
    redirect_uri="YOUR_CALLBACK_URL",
    scope="tweet.read users.read offline.access"
)

# Obtenir l’URL d’autorisation
auth_url = auth.get_authorization_url()

# Après l’autorisation de l’utilisateur, échanger le code contre des jetons
tokens = auth.fetch_token(authorization_response=callback_url)
client = Client(bearer_token=tokens["access_token"])

TypeScript :

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');

// Après l’autorisation, échanger le code
const tokens = await oauth2.exchangeCode(authCode, codeVerifier);
const client = new Client({ accessToken: tokens.access_token });

OAuth 1.0a (Contexte utilisateur)

Pour les anciennes applications ou des cas d’usage spécifiques.

Python :

from xdk import Client
from xdk.oauth1_auth import OAuth1

oauth1 = OAuth1(
    api_key="YOUR_API_KEY",
    api_secret="YOUR_API_SECRET",
    access_token="YOUR_ACCESS_TOKEN",
    access_token_secret="YOUR_ACCESS_TOKEN_SECRET"
)

client = Client(auth=oauth1)

TypeScript :

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 });

---

Méthodes disponibles

Les SDK fournissent des méthodes pour tous les endpoints de X API v2 :

Catégorie	Python	TypeScript
Publications	client.posts.search_recent()	client.posts.search()
Utilisateurs	client.users.get_me()	client.users.getMe()
Spaces	client.spaces.get()	client.spaces.findSpaceById()
Listes	client.lists.get()	client.lists.getList()
DM	client.direct_messages.get()	client.directMessages.lookup()

Consultez la documentation complète des SDK pour une référence exhaustive des méthodes.

---

Ressources

Documentation du SDK Python

Documentation complète du SDK Python.

Documentation du SDK TypeScript

Documentation complète du SDK TypeScript.

GitHub Python

Code source et problèmes.

GitHub TypeScript

Code source et problèmes.