@nivalis/polymarket-api-types

TypeScript type definitions for the Polymarket API, providing comprehensive type safety for prediction market interactions.

Features

• 🎯 Complete Type Coverage - All Polymarket API entities typed
• 🔒 Type Safety - Branded types for enhanced compile-time safety
• 🚀 Zero Runtime - Pure TypeScript declarations, no runtime overhead
• 📦 Lightweight - Only type definitions, no dependencies
• 🔧 Developer Friendly - Intelligent optional property handling

Installation

pnpm install -D @nivalis/polymarket-api-types

Usage

import type { Event, Market, Trade, Profile } from "@nivalis/polymarket-api-types";

// Use types for API responses
const event: Event = {
  id: "event-123",
  title: "Will Bitcoin reach $100k by 2024?",
  slug: "bitcoin-100k-2024",
  createdAt: "2024-01-01T00:00:00Z" as Datetime,
  updatedAt: "2024-01-01T00:00:00Z" as Datetime,
  // ... other properties
};

const market: Market = {
  id: "market-456",
  question: "Yes or No?",
  slug: "bitcoin-100k-yes-no",
  conditionId: "0x1234567890abcdef",
  createdAt: "2024-01-01T00:00:00Z" as Datetime,
  updatedAt: "2024-01-01T00:00:00Z" as Datetime,
  // ... other properties
};

// Type-safe trading data
const trade: Trade = {
  conditionId: "0x1234567890abcdef",
  eventSlug: "bitcoin-100k-2024",
  proxyWallet: "0xabcdef1234567890",
  transactionHash: "0x9876543210fedcba",
  side: "BUY",
  price: 0.65,
  size: 100,
  timestamp: 1704067200,
  // ... other properties
};

Type System

This library uses an advanced TypeScript pattern for enhanced type safety:

Branded Types

type Datetime = Tagged<string, "DateTime">;
type Integer = Tagged<number, "Int">;
type Float = Tagged<number, "Float">;
type Uri = Tagged<string, "Uri">;

Smart Optional Properties

The library uses a Maybe<T> pattern that gets normalized to proper TypeScript optional properties:

// Internal definition
type RawEvent = {
  id: string;
  title: string;
  description: Maybe<string>; // Optional
  featured: Maybe<boolean>; // Optional
};

License

MIT © Nivalis