feat: rename firehose to watchAllOrderBooks, keep firehose as deprecated alias

Author: realfishsam

sdks/python/pmxt/client.py

@@ -1925,7 +1925,7 @@ def watch_order_books(
         except ApiException as e:
             raise self._parse_api_exception(e) from None
 
-    def firehose(
+    def watch_all_order_books(
         self,
         venues: Optional[List[str]] = None,
     ) -> "FirehoseEvent":
@@ -1941,18 +1941,25 @@ def firehose(
             FirehoseEvent with source, symbol, and orderbook
         """
         if not self.is_hosted:
-            raise PmxtError("firehose() requires hosted mode (set pmxt_api_key)")
+            raise PmxtError("watch_all_order_books() requires hosted mode (set pmxt_api_key)")
 
         args: list = [venues] if venues else []
-        data = self._watch_via_ws("firehose", args)
+        data = self._watch_via_ws("watchAllOrderBooks", args)
         if data is not None:
             return FirehoseEvent(
                 source=data.get("_source", ""),
                 symbol=data.get("_symbol", ""),
                 orderbook=_convert_order_book(data),
             )
 
-        raise PmxtError("firehose() requires WebSocket transport — connection failed")
+        raise PmxtError("watch_all_order_books() requires WebSocket transport — connection failed")
+
+    def firehose(
+        self,
+        venues: Optional[List[str]] = None,
+    ) -> "FirehoseEvent":
+        """Deprecated: Use :meth:`watch_all_order_books` instead."""
+        return self.watch_all_order_books(venues)
 
     def watch_trades(
         self,
@@ -2269,7 +2276,8 @@ def _execute_sor_order(self, **kwargs) -> "Order":
                     venue_opts["signature_type"] = account.get("signature_type", 3)
                 venue = venue_cls(**venue_opts)
                 result = venue.create_order(outcome_id=leg["tokenId"], side=leg["side"], amount=leg["shares"], price=leg["price"])
-                fills.append({"venue": leg["venue"], "venueOrderId": result.id, "venueMarketId": leg.get("venueMarketId"), "venueOutcomeId": leg.get("venueOutcomeId"), "shares": getattr(result, "filled", None) or leg["shares"], "price": getattr(result, "price", None) or leg["price"], "status": "filled"})
+                filled = getattr(result, "filled", 0) or 0
+                fills.append({"venue": leg["venue"], "venueOrderId": result.id, "venueMarketId": leg.get("venueMarketId"), "venueOutcomeId": leg.get("venueOutcomeId"), "shares": filled if filled > 0 else leg["shares"], "price": getattr(result, "price", None) or leg["price"], "status": "filled" if filled > 0 else "open"})
             except Exception as e:
                 fills.append({"venue": leg["venue"], "venueMarketId": leg.get("venueMarketId"), "venueOutcomeId": leg.get("venueOutcomeId"), "shares": leg["shares"], "price": leg["price"], "status": "failed", "error": str(e)})
 

sdks/typescript/pmxt/client.ts

@@ -1603,26 +1603,26 @@ export abstract class Exchange {
      * Requires hosted mode (`pmxtApiKey` set).
      *
      * @param venues - Optional venue filter (e.g. ["polymarket", "limitless"])
-     * @returns Next firehose event with source, symbol, and orderbook
+     * @returns Next event with source, symbol, and orderbook
      *
      * @example
      * ```typescript
      * const poly = new Polymarket({ pmxtApiKey: "pmxt_xxx" });
      * while (true) {
-     *   const event = await poly.firehose();
+     *   const event = await poly.watchAllOrderBooks();
      *   console.log(event.source, event.symbol, event.orderbook.bids[0]);
      * }
      * ```
      */
-    async firehose(venues?: string[]): Promise<FirehoseEvent> {
+    async watchAllOrderBooks(venues?: string[]): Promise<FirehoseEvent> {
         await this.initPromise;
 
         if (!this.isHosted) {
-            throw new PmxtError("firehose() requires hosted mode (set pmxtApiKey)");
+            throw new PmxtError("watchAllOrderBooks() requires hosted mode (set pmxtApiKey)");
         }
 
         const args: any[] = venues ? [venues] : [];
-        const wsData = await this.watchViaWs("firehose", args);
+        const wsData = await this.watchViaWs("watchAllOrderBooks", args);
         if (wsData !== null) {
             return {
                 source: (wsData as any)._source || "",
@@ -1631,7 +1631,12 @@ export abstract class Exchange {
             };
         }
 
-        throw new PmxtError("firehose() requires WebSocket transport — connection failed");
+        throw new PmxtError("watchAllOrderBooks() requires WebSocket transport — connection failed");
+    }
+
+    /** @deprecated Use {@link watchAllOrderBooks} instead. */
+    async firehose(venues?: string[]): Promise<FirehoseEvent> {
+        return this.watchAllOrderBooks(venues);
     }
 
     /**
@@ -1897,7 +1902,8 @@ export abstract class Exchange {
                 }
                 const venue = new VenueClass(venueOpts);
                 const order = await venue.createOrder({ outcomeId: leg.tokenId, side: leg.side, amount: leg.shares, price: leg.price });
-                fills.push({ venue: leg.venue, venueOrderId: order.id, venueMarketId: leg.venueMarketId, venueOutcomeId: leg.venueOutcomeId, shares: order.filled || leg.shares, price: order.price || leg.price, status: 'filled' });
+                const filledShares = order.filled || 0;
+                fills.push({ venue: leg.venue, venueOrderId: order.id, venueMarketId: leg.venueMarketId, venueOutcomeId: leg.venueOutcomeId, shares: filledShares > 0 ? filledShares : leg.shares, price: order.price || leg.price, status: filledShares > 0 ? 'filled' : 'open' });
             } catch (err: any) {
                 fills.push({ venue: leg.venue, venueMarketId: leg.venueMarketId, venueOutcomeId: leg.venueOutcomeId, shares: leg.shares, price: leg.price, status: 'failed', error: err.message });
             }