Skip to main content

SDK Reference

The TrendZap SDK provides a simple interface for integrating TrendZap into your applications.

Installation​

npm install @trendzap/sdk
# or
pnpm add @trendzap/sdk
# or
yarn add @trendzap/sdk

Quick Start​

import { TrendZapClient } from '@trendzap/sdk';
import { createWalletClient, http } from 'viem';
import { arbitrum } from 'viem/chains';

const client = new TrendZapClient({
  chain: 'arbitrum',
  walletClient: createWalletClient({
    chain: arbitrum,
    transport: http(),
  }),
});

// Get active markets
const markets = await client.markets.list({ status: 'active' });

// Place a bet
await client.markets.bet('market-id', 'OVER', '10');

Configuration​

TrendZapClientConfig​

interface TrendZapClientConfig {
  chain: 'arbitrum' | 'arbitrum-sepolia';
  walletClient?: WalletClient;
  publicClient?: PublicClient;
  oracleUrl?: string;
}
PropertyTypeRequiredDescription
chainstringYesNetwork to connect to
walletClientWalletClientNoFor write operations
publicClientPublicClientNoFor read operations
oracleUrlstringNoCustom oracle URL

Markets Module​

markets.create()​

Create a new prediction market.

const market = await client.markets.create({
  postUrl: 'https://twitter.com/user/status/123',
  platform: 'twitter',
  metric: 'likes',
  threshold: 100000,
  endTime: Date.now() + 86400000,
});

markets.get()​

Get market details by ID.

const market = await client.markets.get('market-id');

markets.list()​

List markets with optional filters.

const markets = await client.markets.list({
  status: 'active',
  platform: 'twitter',
  limit: 10,
});

markets.bet()​

Place a bet on a market.

const txHash = await client.markets.bet('market-id', 'OVER', '10');

markets.claim()​

Claim winnings from a resolved market.

const txHash = await client.markets.claim('market-id');

Positions Module​

positions.get()​

Get user's position in a market.

const position = await client.positions.get('market-id', '0x...');

positions.listByUser()​

List all positions for a user.

const positions = await client.positions.listByUser('0x...');

Metrics Module​

metrics.get()​

Get current social metrics.

const metrics = await client.metrics.get(
  'https://twitter.com/user/status/123',
  'twitter',
  'likes'
);

Utils Module​

utils.calculateProbability()​

Calculate implied odds from stakes.

const odds = client.utils.calculateProbability(
  totalOverStake,
  totalUnderStake
);
// { over: 0.65, under: 0.35 }

utils.estimatePayout()​

Estimate potential payout.

const payout = client.utils.estimatePayout(
  totalOver,
  totalUnder,
  'OVER',
  betAmount
);

Error Handling​

import { TrendZapError, MarketNotFoundError } from '@trendzap/sdk';

try {
  await client.markets.bet('invalid-id', 'OVER', '10');
} catch (error) {
  if (error instanceof MarketNotFoundError) {
    console.error('Market does not exist');
  }
}

TypeScript Types​

import type {
  Market,
  Position,
  Platform,
  MetricType,
  Outcome,
} from '@trendzap/sdk';