SDK oficiales

SDK oficiales de X API para TypeScript y Python

X ofrece SDKs oficiales para TypeScript y Python. Estas bibliotecas gestionan la autenticación, la paginación y proporcionan seguridad de tipos completa.

SDK de Python

Soporte asíncrono, anotaciones de tipo, cobertura completa de v2.

SDK de TypeScript

Tipos completos de TypeScript, compatibilidad con ESM, funciona con Node.js.

---

​

¿Por qué usar los SDK oficiales?

Beneficio	Descripción
Siempre actualizados	Mantenidos por X y actualizados con nuevos endpoints
Seguridad de tipos	Definiciones completas de type para todos los objetos y métodos
Autenticación integrada	Compatibilidad con OAuth 2.0 y OAuth 1.0a
Paginación automática	Recorre los resultados sin manejo manual de tokens

---

​

Inicio rápido

Python

​

Instalación

pip install xdk

​

Uso básico

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Buscar publicaciones (devuelve un iterador)
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

​

Instalación

npm install @xdevplatform/xdk

​

Uso básico

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

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

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

---

​

Autenticación

Ambos SDKs admiten varios métodos de autenticación:

Bearer Token (solo App)

La opción más sencilla para leer datos públicos.

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 (Contexto de usuario)

Para acciones en nombre de usuarios (publicar, seguir, 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"
)

# Obtener la URL de autorización
auth_url = auth.get_authorization_url()

# Después de que el usuario autorice, intercambiar el código por tokens
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');

// Después de la autorización, intercambiar el código
const tokens = await oauth2.exchangeCode(authCode, codeVerifier);
const client = new Client({ accessToken: tokens.access_token });

OAuth 1.0a (Contexto de usuario)

Para aplicaciones heredadas o casos de uso específicos.

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étodos disponibles

Los SDK proporcionan métodos para todos los endpoints de X API v2:

Categoría	Python	TypeScript
Publicaciones	client.posts.search_recent()	client.posts.search()
Usuarios	client.users.get_me()	client.users.getMe()
Spaces	client.spaces.get()	client.spaces.findSpaceById()
Listas	client.lists.get()	client.lists.getList()
DMs	client.direct_messages.get()	client.directMessages.lookup()

Consulta la documentación completa de los SDK para ver la referencia detallada de todos los métodos.

---

​

Recursos

Python SDK Docs

Documentación completa del SDK de Python.

TypeScript SDK Docs

Documentación completa del SDK de TypeScript.

Python GitHub

Código fuente y problemas.

TypeScript GitHub

Código fuente y problemas.