predimarkets 0.1.0 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # predimarkets
 
-Official TypeScript client for the [Predimarkets](https://predimarkets.com) API — matching, oracle resolution and settlement for prediction markets.
+Official TypeScript client for the [Predimarkets](https://predimarkets.com) API — markets, bets, settlement and webhooks for prediction markets.
 
 Zero runtime dependencies. Runs on Node 18+, Bun, Deno and Cloudflare Workers.
 
@@ -19,7 +19,7 @@ const { markets } = await client.markets.list({ status: 'open' });
 const market = markets[0];
 
 // Price the bet before you place it.
-const quote = await client.parimutuel.quote({
+const quote = await client.quotes.get({
   marketId: market.id,
   outcomeId: market.outcomes[0].id,
   stake: 100,
@@ -43,21 +43,18 @@ user placing the bet. Keep the key server-side — it must never reach a browser
 await client.markets.list({ status: 'open', limit: 20 });
 await client.markets.get('will-france-win-the-world-cup-2026'); // id or slug
 await client.markets.priceHistory(market.id, { timeframe: '1D' });
-await client.markets.orderBook(market.id);
 ```
 
-Search is semantic, not just keyword — queries are ranked by embedding similarity
-fused with full-text, so a question finds the market that answers it even when
-they share no words:
+Search is semantic, not just keyword — queries are ranked by meaning, so a
+question finds the market that answers it even when they share no words:
 
 ```ts
 await client.markets.search('who wants to be president');
 ```
 
-## Orders
+## Bets
 
-Parimutuel markets take an `amount` — the money the user is staking, debited and
-staked 1:1, with no share price to reason about:
+`amount` is the money the user is staking. That is all a market needs:
 
 ```ts
 await client.orders.create({
@@ -65,13 +62,12 @@ await client.orders.create({
 });
 ```
 
-Order-book markets take a `quantity`, plus a `price` for limit orders:
+Quote first if you want to show the user what they stand to win:
 
 ```ts
-await client.orders.create({
-  marketId, outcomeId, userId: 'user-123',
-  side: 'buy', type: 'limit', quantity: 1000, price: 0.65,
-});
+const quote = await client.quotes.get({ marketId, outcomeId, stake: 100 });
+// quote.multiplier — the return they lock in
+// quote.estimated_payout — what they take home if it hits
 ```
 
 ## Positions and trades
@@ -81,18 +77,19 @@ await client.positions.list({ userId: 'user-123' });
 await client.trades.list({ userId: 'user-123', limit: 50 });
 ```
 
-## Multi-outcome markets
+## Markets with more than two outcomes
+
+Pass `multiOutcome`:
 
 ```ts
-const state = await client.parimutuel.categorical.state(marketId);
-await client.parimutuel.categorical.quote({ marketId, outcomeId, stake: 50 });
+const state = await client.marketState.get(marketId, { multiOutcome: true });
+const quote = await client.quotes.get({ marketId, outcomeId, stake: 50, multiOutcome: true });
 ```
 
 An outcome that is out of the running (knocked out, lost) comes back with
 `eliminated: true` and takes no new bets — the API rejects them with
-`OUTCOME_ELIMINATED`. Render it as dead rather than hiding it: its share of the
-pool is real, so the remaining outcomes' percentages will not add to 100 without
-it.
+`OUTCOME_ELIMINATED`. Render it as dead rather than hiding it, so the remaining
+outcomes' percentages still add up for the user.
 
 ## Webhooks
 
@@ -148,7 +145,7 @@ try {
 handling already applied:
 
 ```ts
-await client.request('GET', '/markets/:id/milestone-live'.replace(':id', marketId));
+await client.request('GET', `/markets/${marketId}/milestone-live`);
 ```
 
 ## License

package/dist/index.cjs

@@ -22,7 +22,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Webhooks = exports.SIGNATURE_HEADER = exports.Predimarkets = exports.PredimarketsError = exports.VERSION = void 0;
-exports.VERSION = '0.1.0';
+exports.VERSION = '0.2.0';
 const DEFAULT_BASE_URL = 'https://api.predimarkets.com';
 const DEFAULT_TIMEOUT_MS = 30_000;
 // ─────────────────────────────────────────────────────────────────────────────
@@ -58,7 +58,8 @@ class Predimarkets {
     orders;
     positions;
     trades;
-    parimutuel;
+    quotes;
+    marketState;
     webhooks;
     apiKey;
     baseUrl;
@@ -80,7 +81,8 @@ class Predimarkets {
         this.orders = new Orders(this);
         this.positions = new Positions(this);
         this.trades = new Trades(this);
-        this.parimutuel = new Parimutuel(this);
+        this.quotes = new Quotes(this);
+        this.marketState = new MarketState(this);
         this.webhooks = new Webhooks();
     }
     /** Escape hatch: call any endpoint the SDK doesn't wrap yet. */
@@ -187,10 +189,10 @@ class Orders {
         this.client = client;
     }
     /**
-     * Place an order.
+     * Place a bet.
      *
-     * For parimutuel markets pass `amount` (the money staked). For order-book
-     * markets pass `quantity`, plus `price` when `type` is 'limit'.
+     * Pass `amount` — the money the user is staking. That is all a live market
+     * needs; `quantity`/`price` exist only for legacy share-based markets.
      */
     create(params) {
         return this.client.request('POST', '/orders', {
@@ -239,44 +241,45 @@ class Trades {
         });
     }
 }
-class CategoricalParimutuel {
+class Quotes {
     client;
     constructor(client) {
         this.client = client;
     }
-    /** Price a stake on one outcome of a multi-outcome market, before placing it. */
-    quote(params) {
-        return this.client.request('GET', '/parimutuel-categorical/quote', {
-            query: { market_id: params.marketId, outcome_id: params.outcomeId, stake: params.stake },
-        });
-    }
-    /** Live pool state: per-outcome pool, probability and multiplier. */
-    state(marketIdOrSlug) {
-        return this.client.request('GET', `/parimutuel-categorical/markets/${encodeURIComponent(marketIdOrSlug)}`);
-    }
-}
-class Parimutuel {
-    client;
-    categorical;
-    constructor(client) {
-        this.client = client;
-        this.categorical = new CategoricalParimutuel(client);
-    }
-    /** Price a stake before placing it: fee, locked multiplier, estimated payout. */
-    quote(params) {
-        return this.client.request('GET', '/parimutuel/quote', {
+    /**
+     * Price a stake before it is placed: the fee, the return the user locks in, and
+     * what they would take home if the outcome hits.
+     *
+     * Set `multiOutcome` for markets with more than two runners.
+     */
+    get(params) {
+        const path = params.multiOutcome
+            ? '/parimutuel-categorical/quote'
+            : '/parimutuel/quote';
+        return this.client.request('GET', path, {
             query: {
                 market_id: params.marketId,
                 outcome_id: params.outcomeId,
                 stake: params.stake,
-                side: params.side,
             },
         });
     }
-    /** Live pool state for a binary parimutuel market. */
-    state(marketIdOrSlug) {
-        return this.client.request('GET', `/parimutuel/markets/${encodeURIComponent(marketIdOrSlug)}`);
+}
+class MarketState {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Live state of a market: the current price and return on every outcome.
+     *
+     * Set `multiOutcome` for markets with more than two runners.
+     */
+    get(marketIdOrSlug, options = {}) {
+        const base = options.multiOutcome ? '/parimutuel-categorical' : '/parimutuel';
+        return this.client.request('GET', `${base}/markets/${encodeURIComponent(marketIdOrSlug)}`);
     }
+    /** What a user's open ticket is worth right now. */
     ticketValue(marketIdOrSlug, ticketId) {
         return this.client.request('GET', `/parimutuel/markets/${encodeURIComponent(marketIdOrSlug)}/tickets/${encodeURIComponent(ticketId)}/value`);
     }

package/dist/index.d.ts

@@ -19,7 +19,7 @@
  *     amount: 100,
  *   });
  */
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.2.0";
 /**
  * Any non-2xx response from the API.
  *
@@ -97,13 +97,14 @@ export interface CreateOrderParams {
     side?: OrderSide;
     type?: OrderType;
     /**
-     * Parimutuel: the amount of money the user is staking. Preferred — it is
-     * debited and staked 1:1, with no separate share price to reason about.
+     * The amount of money the user is staking. This is what you want for every
+     * live market: it is debited and staked 1:1, with no share price to reason
+     * about.
      */
     amount?: number;
-    /** Order book: number of shares. */
+    /** Legacy share-based markets only. Prefer `amount`. */
     quantity?: number;
-    /** Order book limit orders: price per share, 0–1. */
+    /** Legacy share-based limit orders only: price per share, 0–1. */
     price?: number;
     /** Hard cap on total spend including fees. Buy orders only. */
     maxSpend?: number;
@@ -111,16 +112,26 @@ export interface CreateOrderParams {
 export interface QuoteParams {
     marketId: string;
     outcomeId: string;
+    /** How much money the user wants to stake. */
     stake: number;
-    /** Binary parimutuel only. */
-    side?: 'yes' | 'no';
+    /** True for markets with more than two runners. */
+    multiOutcome?: boolean;
+}
+export interface Quote {
+    /** What the user takes home if this outcome hits. */
+    estimated_payout?: number;
+    /** The return locked in at the moment the bet is placed. */
+    multiplier?: number;
+    fee?: number;
+    [key: string]: unknown;
 }
 export declare class Predimarkets {
     readonly markets: Markets;
     readonly orders: Orders;
     readonly positions: Positions;
     readonly trades: Trades;
-    readonly parimutuel: Parimutuel;
+    readonly quotes: Quotes;
+    readonly marketState: MarketState;
     readonly webhooks: Webhooks;
     private readonly apiKey;
     private readonly baseUrl;
@@ -164,10 +175,10 @@ declare class Orders {
     private readonly client;
     constructor(client: Predimarkets);
     /**
-     * Place an order.
+     * Place a bet.
      *
-     * For parimutuel markets pass `amount` (the money staked). For order-book
-     * markets pass `quantity`, plus `price` when `type` is 'limit'.
+     * Pass `amount` — the money the user is staking. That is all a live market
+     * needs; `quantity`/`price` exist only for legacy share-based markets.
      */
     create(params: CreateOrderParams): Promise<unknown>;
 }
@@ -190,22 +201,29 @@ declare class Trades {
         offset?: number;
     }): Promise<unknown>;
 }
-declare class CategoricalParimutuel {
+declare class Quotes {
     private readonly client;
     constructor(client: Predimarkets);
-    /** Price a stake on one outcome of a multi-outcome market, before placing it. */
-    quote(params: QuoteParams): Promise<unknown>;
-    /** Live pool state: per-outcome pool, probability and multiplier. */
-    state(marketIdOrSlug: string): Promise<unknown>;
+    /**
+     * Price a stake before it is placed: the fee, the return the user locks in, and
+     * what they would take home if the outcome hits.
+     *
+     * Set `multiOutcome` for markets with more than two runners.
+     */
+    get(params: QuoteParams): Promise<Quote>;
 }
-declare class Parimutuel {
+declare class MarketState {
     private readonly client;
-    readonly categorical: CategoricalParimutuel;
     constructor(client: Predimarkets);
-    /** Price a stake before placing it: fee, locked multiplier, estimated payout. */
-    quote(params: QuoteParams): Promise<unknown>;
-    /** Live pool state for a binary parimutuel market. */
-    state(marketIdOrSlug: string): Promise<unknown>;
+    /**
+     * Live state of a market: the current price and return on every outcome.
+     *
+     * Set `multiOutcome` for markets with more than two runners.
+     */
+    get(marketIdOrSlug: string, options?: {
+        multiOutcome?: boolean;
+    }): Promise<unknown>;
+    /** What a user's open ticket is worth right now. */
     ticketValue(marketIdOrSlug: string, ticketId: string): Promise<unknown>;
 }
 /** Header Predimarkets signs every webhook with. */

package/dist/index.js

@@ -19,7 +19,7 @@
  *     amount: 100,
  *   });
  */
-export const VERSION = '0.1.0';
+export const VERSION = '0.2.0';
 const DEFAULT_BASE_URL = 'https://api.predimarkets.com';
 const DEFAULT_TIMEOUT_MS = 30_000;
 // ─────────────────────────────────────────────────────────────────────────────
@@ -54,7 +54,8 @@ export class Predimarkets {
     orders;
     positions;
     trades;
-    parimutuel;
+    quotes;
+    marketState;
     webhooks;
     apiKey;
     baseUrl;
@@ -76,7 +77,8 @@ export class Predimarkets {
         this.orders = new Orders(this);
         this.positions = new Positions(this);
         this.trades = new Trades(this);
-        this.parimutuel = new Parimutuel(this);
+        this.quotes = new Quotes(this);
+        this.marketState = new MarketState(this);
         this.webhooks = new Webhooks();
     }
     /** Escape hatch: call any endpoint the SDK doesn't wrap yet. */
@@ -182,10 +184,10 @@ class Orders {
         this.client = client;
     }
     /**
-     * Place an order.
+     * Place a bet.
      *
-     * For parimutuel markets pass `amount` (the money staked). For order-book
-     * markets pass `quantity`, plus `price` when `type` is 'limit'.
+     * Pass `amount` — the money the user is staking. That is all a live market
+     * needs; `quantity`/`price` exist only for legacy share-based markets.
      */
     create(params) {
         return this.client.request('POST', '/orders', {
@@ -234,44 +236,45 @@ class Trades {
         });
     }
 }
-class CategoricalParimutuel {
+class Quotes {
     client;
     constructor(client) {
         this.client = client;
     }
-    /** Price a stake on one outcome of a multi-outcome market, before placing it. */
-    quote(params) {
-        return this.client.request('GET', '/parimutuel-categorical/quote', {
-            query: { market_id: params.marketId, outcome_id: params.outcomeId, stake: params.stake },
-        });
-    }
-    /** Live pool state: per-outcome pool, probability and multiplier. */
-    state(marketIdOrSlug) {
-        return this.client.request('GET', `/parimutuel-categorical/markets/${encodeURIComponent(marketIdOrSlug)}`);
-    }
-}
-class Parimutuel {
-    client;
-    categorical;
-    constructor(client) {
-        this.client = client;
-        this.categorical = new CategoricalParimutuel(client);
-    }
-    /** Price a stake before placing it: fee, locked multiplier, estimated payout. */
-    quote(params) {
-        return this.client.request('GET', '/parimutuel/quote', {
+    /**
+     * Price a stake before it is placed: the fee, the return the user locks in, and
+     * what they would take home if the outcome hits.
+     *
+     * Set `multiOutcome` for markets with more than two runners.
+     */
+    get(params) {
+        const path = params.multiOutcome
+            ? '/parimutuel-categorical/quote'
+            : '/parimutuel/quote';
+        return this.client.request('GET', path, {
             query: {
                 market_id: params.marketId,
                 outcome_id: params.outcomeId,
                 stake: params.stake,
-                side: params.side,
             },
         });
     }
-    /** Live pool state for a binary parimutuel market. */
-    state(marketIdOrSlug) {
-        return this.client.request('GET', `/parimutuel/markets/${encodeURIComponent(marketIdOrSlug)}`);
+}
+class MarketState {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Live state of a market: the current price and return on every outcome.
+     *
+     * Set `multiOutcome` for markets with more than two runners.
+     */
+    get(marketIdOrSlug, options = {}) {
+        const base = options.multiOutcome ? '/parimutuel-categorical' : '/parimutuel';
+        return this.client.request('GET', `${base}/markets/${encodeURIComponent(marketIdOrSlug)}`);
     }
+    /** What a user's open ticket is worth right now. */
     ticketValue(marketIdOrSlug, ticketId) {
         return this.client.request('GET', `/parimutuel/markets/${encodeURIComponent(marketIdOrSlug)}/tickets/${encodeURIComponent(ticketId)}/value`);
     }

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "predimarkets",
-  "version": "0.1.0",
-  "description": "Official TypeScript client for the Predimarkets API \u2014 matching, oracle resolution and settlement for prediction markets.",
+  "version": "0.2.0",
+  "description": "Official TypeScript client for the Predimarkets API \u2014 markets, bets, settlement and webhooks for prediction markets.",
   "keywords": [
     "predimarkets",
     "prediction-markets",
-    "parimutuel",
     "betting",
+    "markets",
     "sdk",
-    "api-client"
+    "api-client",
+    "typescript"
   ],
   "homepage": "https://predimarkets.com",
   "license": "MIT",