|
1 | 1 | { |
2 | | - "_generated": "Auto-generated by extract-jsdoc.js on 2026-06-02T00:34:44.916Z. Do not edit manually.", |
| 2 | + "_generated": "Auto-generated by extract-jsdoc.js on 2026-06-08T08:31:38.004Z. Do not edit manually.", |
3 | 3 | "methods": { |
4 | 4 | "has": { |
5 | 5 | "summary": "HTTP verb for the endpoint (e.g. GET, POST). */", |
|
566 | 566 | "type": "UnifiedEvent[]", |
567 | 567 | "description": "Filtered array of events" |
568 | 568 | }, |
569 | | - "source": "BaseExchange.ts:1317" |
| 569 | + "source": "BaseExchange.ts:1318" |
570 | 570 | }, |
571 | 571 | "watchOrderBook": { |
572 | 572 | "summary": "Watch order book updates in real-time via WebSocket.", |
|
595 | 595 | "type": "OrderBook", |
596 | 596 | "description": "Promise that resolves with the current orderbook state" |
597 | 597 | }, |
598 | | - "source": "BaseExchange.ts:1413" |
| 598 | + "source": "BaseExchange.ts:1414" |
599 | 599 | }, |
600 | 600 | "watchOrderBooks": { |
601 | 601 | "summary": "Watch multiple order books simultaneously via WebSocket.", |
|
624 | 624 | "type": "Record<string, OrderBook>", |
625 | 625 | "description": "Promise that resolves with order books keyed by ID" |
626 | 626 | }, |
627 | | - "source": "BaseExchange.ts:1426" |
| 627 | + "source": "BaseExchange.ts:1427" |
628 | 628 | }, |
629 | 629 | "unwatchOrderBook": { |
630 | 630 | "summary": "Unsubscribe from a previously watched order book stream.", |
|
641 | 641 | "type": "void", |
642 | 642 | "description": "Result" |
643 | 643 | }, |
644 | | - "source": "BaseExchange.ts:1454" |
| 644 | + "source": "BaseExchange.ts:1455" |
645 | 645 | }, |
646 | 646 | "watchTrades": { |
647 | 647 | "summary": "Watch trade executions in real-time via WebSocket.", |
|
676 | 676 | "type": "Trade[]", |
677 | 677 | "description": "Promise that resolves with recent trades" |
678 | 678 | }, |
679 | | - "source": "BaseExchange.ts:1467" |
| 679 | + "source": "BaseExchange.ts:1468" |
680 | 680 | }, |
681 | 681 | "watchAddress": { |
682 | 682 | "summary": "Stream activity for a public wallet address", |
|
699 | 699 | "type": "SubscribedAddressSnapshot", |
700 | 700 | "description": "Promise that resolves with the latest SubscribedAddressSnapshot snapshot" |
701 | 701 | }, |
702 | | - "source": "BaseExchange.ts:1481" |
| 702 | + "source": "BaseExchange.ts:1482" |
703 | 703 | }, |
704 | 704 | "unwatchAddress": { |
705 | 705 | "summary": "Stop watching a previously registered wallet address and release its resource updates.", |
|
716 | 716 | "type": "void", |
717 | 717 | "description": "Result" |
718 | 718 | }, |
719 | | - "source": "BaseExchange.ts:1494" |
| 719 | + "source": "BaseExchange.ts:1495" |
720 | 720 | }, |
721 | 721 | "close": { |
722 | 722 | "summary": "Close all WebSocket connections and clean up resources.", |
|
726 | 726 | "type": "void", |
727 | 727 | "description": "Result" |
728 | 728 | }, |
729 | | - "source": "BaseExchange.ts:1503" |
| 729 | + "source": "BaseExchange.ts:1504" |
730 | 730 | }, |
731 | 731 | "fetchMarketMatches": { |
732 | 732 | "summary": "Find the same or related market on other venues. Two modes:", |
|
743 | 743 | "type": "MatchResult[]", |
744 | 744 | "description": "Array of matched markets with relation and confidence" |
745 | 745 | }, |
746 | | - "source": "BaseExchange.ts:1517" |
| 746 | + "source": "BaseExchange.ts:1518" |
747 | 747 | }, |
748 | 748 | "fetchMatches": { |
749 | 749 | "summary": "fetchMatches", |
|
760 | 760 | "type": "MatchResult[]", |
761 | 761 | "description": "Result" |
762 | 762 | }, |
763 | | - "source": "BaseExchange.ts:1533" |
| 763 | + "source": "BaseExchange.ts:1534" |
764 | 764 | }, |
765 | 765 | "fetchEventMatches": { |
766 | 766 | "summary": "Find the same or related event on other venues. Two modes:", |
|
777 | 777 | "type": "EventMatchResult[]", |
778 | 778 | "description": "Array of matched events with market-level match details" |
779 | 779 | }, |
780 | | - "source": "BaseExchange.ts:1541" |
| 780 | + "source": "BaseExchange.ts:1542" |
781 | 781 | }, |
782 | 782 | "compareMarketPrices": { |
783 | 783 | "summary": "Compare live prices for the same market across venues. Finds identity matches and returns side-by-side best bid/ask prices so you can spot price differences at a glance.", |
|
794 | 794 | "type": "PriceComparison[]", |
795 | 795 | "description": "Array of price comparisons across venues" |
796 | 796 | }, |
797 | | - "source": "BaseExchange.ts:1557" |
| 797 | + "source": "BaseExchange.ts:1558" |
798 | 798 | }, |
799 | 799 | "fetchRelatedMarkets": { |
800 | 800 | "summary": "Find related markets across venues. Discovers subset/superset market relationships", |
|
811 | 811 | "type": "PriceComparison[]", |
812 | 812 | "description": "Array of subset/superset matches with live prices" |
813 | 813 | }, |
814 | | - "source": "BaseExchange.ts:1567" |
| 814 | + "source": "BaseExchange.ts:1568" |
815 | 815 | }, |
816 | 816 | "fetchMatchedMarkets": { |
817 | 817 | "summary": "fetchMatchedMarkets", |
|
828 | 828 | "type": "MatchedMarketPair[]", |
829 | 829 | "description": "Result" |
830 | 830 | }, |
831 | | - "source": "BaseExchange.ts:1578" |
| 831 | + "source": "BaseExchange.ts:1579" |
832 | 832 | }, |
833 | 833 | "fetchMatchedPrices": { |
834 | 834 | "summary": "fetchMatchedPrices", |
|
845 | 845 | "type": "MatchedPricePair[]", |
846 | 846 | "description": "Array of matched market pairs with prices from each venue" |
847 | 847 | }, |
848 | | - "source": "BaseExchange.ts:1586" |
| 848 | + "source": "BaseExchange.ts:1587" |
849 | 849 | }, |
850 | 850 | "fetchHedges": { |
851 | 851 | "summary": "fetchHedges", |
|
862 | 862 | "type": "PriceComparison[]", |
863 | 863 | "description": "Array of subset/superset matches with live prices" |
864 | 864 | }, |
865 | | - "source": "BaseExchange.ts:1597" |
| 865 | + "source": "BaseExchange.ts:1598" |
866 | 866 | }, |
867 | 867 | "fetchArbitrage": { |
868 | 868 | "summary": "fetchArbitrage", |
|
879 | 879 | "type": "ArbitrageOpportunity[]", |
880 | 880 | "description": "Array of arbitrage opportunities sorted by spread" |
881 | 881 | }, |
882 | | - "source": "BaseExchange.ts:1607" |
| 882 | + "source": "BaseExchange.ts:1608" |
883 | 883 | }, |
884 | 884 | "watchPrices": { |
885 | 885 | "summary": "Watch AMM price updates for a market address (Limitless only).", |
|
950 | 950 | "description": "Result" |
951 | 951 | }, |
952 | 952 | "exchangeOnly": "polymarket", |
953 | | - "source": "index.ts:143" |
| 953 | + "source": "index.ts:144" |
954 | 954 | }, |
955 | 955 | "preWarmMarket": { |
956 | 956 | "summary": "Pre-warm the SDK's internal caches for a market outcome.", |
|
968 | 968 | "description": "Result" |
969 | 969 | }, |
970 | 970 | "exchangeOnly": "polymarket", |
971 | | - "source": "index.ts:209" |
| 971 | + "source": "index.ts:210" |
972 | 972 | }, |
973 | 973 | "getEventById": { |
974 | 974 | "summary": "Fetch a single event by its numeric ID (Probable only).", |
|
0 commit comments