TypeScript SDK Quickstart

npm install @xpoz/xpoz

import { XpozClient } from "@xpoz/xpoz";

// Pass access key directly
const client = new XpozClient({ apiKey: "your-api-key" });
await client.connect();

// Or use the XPOZ_API_KEY environment variable
const client = new XpozClient();
await client.connect();

const client = new XpozClient({
  apiKey: "your-api-key",
  serverUrl: "https://mcp.xpoz.ai/mcp",
  timeoutMs: 600_000, // 10 minutes
});
await client.connect();

import { XpozClient } from "@xpoz/xpoz";

const client = new XpozClient({ apiKey: "your-api-key" });
await client.connect();

// Get a Twitter user profile
const user = await client.twitter.getUser("elonmusk");
console.log(`${user.name} — ${user.followersCount?.toLocaleString()} followers`);

// Search for posts
const results = await client.twitter.searchPosts("artificial intelligence", {
  startDate: "2025-01-01",
});
for (const post of results.data) {
  console.log(post.text, post.likeCount);
}

await client.close();

const client = new XpozClient({ apiKey: "your-api-key" });
await client.connect();
try {
  const results = await client.twitter.searchPosts("AI");
} finally {
  await client.close();
}

await using client = new XpozClient({ apiKey: "your-api-key" });
await client.connect();

const user = await client.twitter.getUser("elonmusk");
// client.close() is called automatically when the block exits

const results = await client.twitter.searchPosts("AI", {
  fields: ["id", "text", "likeCount", "retweetCount", "createdAtDate"],
});

const user = await client.twitter.getUser("elonmusk", {
  fields: ["id", "username", "name", "followersCount", "description"],
});

// Exact phrase
await client.twitter.searchPosts('"machine learning"');

// Boolean operators
await client.twitter.searchPosts('"deep learning" AND python');
await client.twitter.searchPosts("tensorflow OR pytorch");
await client.twitter.searchPosts("climate AND policy");

// Grouping
await client.twitter.searchPosts('(AI OR "artificial intelligence") AND ethics');