@pear-protocol/core-sdk 0.0.24 → 1.0.0

package/dist/core/index.d.ts

@@ -4,7 +4,9 @@ import { ClientHeaders } from '../types.js';
 
 declare class Core {
     private client;
-    constructor(client: HttpClient);
+    private clientId?;
+    constructor(client: HttpClient, clientId?: string | null);
+    private withClientId;
     accounts: {
         list: (query?: HttpTypes.TradeAccountListParamsInput, headers?: ClientHeaders) => Promise<{
             accounts: {
@@ -180,6 +182,25 @@ declare class Core {
         }>;
         restore: (id: string, headers?: ClientHeaders) => Promise<void>;
     };
+    apiKeys: {
+        list: (headers?: ClientHeaders) => Promise<{
+            id: string;
+            label: string;
+            scope: "read" | "read_write";
+            keyPrefix: string;
+            lastUsedAt: string | null;
+            expiresAt: string | null;
+            revokedAt: string | null;
+            createdAt: string;
+        }[]>;
+        create: (body: HttpTypes.CreateApiKeyInput, headers?: ClientHeaders) => Promise<{
+            id: string;
+            label: string;
+            scope: "read" | "read_write";
+            key: string;
+        }>;
+        revoke: (id: string, headers?: ClientHeaders) => Promise<void>;
+    };
     executions: {
         list: (query: HttpTypes.ExecutionListParamsInput, headers?: ClientHeaders) => Promise<{
             limit: number;
@@ -405,6 +426,68 @@ declare class Core {
             data: Record<string, string>;
         }>;
     };
+    markets: {
+        list: (query: HttpTypes.MarketsQueryParamsInput, headers?: ClientHeaders) => Promise<{
+            markets: {
+                connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                instrumentId: string;
+                displaySymbol: string;
+                base: string;
+                quote: string;
+                price: string;
+                volume24h: string;
+                change24h: string;
+                openInterest: string;
+                fundingRate: string;
+                tradeability: {
+                    status: "tradable" | "reduce_only" | "not_tradable";
+                    reason: string | null;
+                };
+                updatedAt: number;
+            }[];
+            totals: {
+                markets: number;
+                volume24h: string;
+                openInterest: string;
+            };
+        }>;
+        baskets: (query: HttpTypes.MarketBasketsQueryParamsInput, headers?: ClientHeaders) => Promise<{
+            limit: number;
+            offset: number;
+            count: number;
+            markets: {
+                connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                basketKey: string;
+                displaySymbol: string;
+                longInstrumentIds: string[];
+                shortInstrumentIds: string[];
+                price: string;
+                priceChange24h: string;
+                weightRatio: string;
+                weightRatioChange24h: string;
+                netFunding: string;
+                volume24h: string;
+                openInterest: string;
+                tradeability: {
+                    status: "tradable" | "reduce_only" | "not_tradable";
+                    reason: string | null;
+                };
+                updatedAt: number;
+                hasMaterializedStats: boolean;
+            }[];
+        }>;
+    };
+    oracle: {
+        btcdom: (headers?: ClientHeaders) => Promise<{
+            id: string;
+            category: "btcdom";
+            source: "coingecko";
+            oracle: {
+                value: number;
+                unit: "cent" | "percent";
+            } | null;
+        }>;
+    };
     positions: {
         list: (query: HttpTypes.PositionListParamsInput, headers?: ClientHeaders) => Promise<{
             positions: {
@@ -430,6 +513,177 @@ declare class Core {
             }[];
         }>;
     };
+    portfolio: {
+        overview: (query?: HttpTypes.PortfolioQueryInput, headers?: ClientHeaders) => Promise<{
+            intervals: {
+                oneDay: {
+                    periodStart: string;
+                    periodEnd: string;
+                    volume: number;
+                    openInterest: number;
+                    winningTradesCount: number;
+                    winningTradesUsd: number;
+                    losingTradesCount: number;
+                    losingTradesUsd: number;
+                }[];
+                oneWeek: {
+                    periodStart: string;
+                    periodEnd: string;
+                    volume: number;
+                    openInterest: number;
+                    winningTradesCount: number;
+                    winningTradesUsd: number;
+                    losingTradesCount: number;
+                    losingTradesUsd: number;
+                }[];
+                oneMonth: {
+                    periodStart: string;
+                    periodEnd: string;
+                    volume: number;
+                    openInterest: number;
+                    winningTradesCount: number;
+                    winningTradesUsd: number;
+                    losingTradesCount: number;
+                    losingTradesUsd: number;
+                }[];
+                oneYear: {
+                    periodStart: string;
+                    periodEnd: string;
+                    volume: number;
+                    openInterest: number;
+                    winningTradesCount: number;
+                    winningTradesUsd: number;
+                    losingTradesCount: number;
+                    losingTradesUsd: number;
+                }[];
+                all: {
+                    periodStart: string;
+                    periodEnd: string;
+                    volume: number;
+                    openInterest: number;
+                    winningTradesCount: number;
+                    winningTradesUsd: number;
+                    losingTradesCount: number;
+                    losingTradesUsd: number;
+                }[];
+            } | null;
+            overall: {
+                totalWinningTradesCount: number;
+                totalLosingTradesCount: number;
+                totalWinningUsd: number;
+                totalLosingUsd: number;
+                currentOpenInterest: number;
+                currentTotalVolume: number;
+                unrealizedPnl: number;
+                realizedPnl: number;
+                totalFees: number;
+                totalTrades: number;
+            };
+        }>;
+        analytics: (query?: HttpTypes.PortfolioAnalyticsQueryInput, headers?: ClientHeaders) => Promise<{
+            config: {
+                rollingWindowDays: number;
+                startDate: string;
+                endDate: string;
+            };
+            portfolio: {
+                realizedOnly: {
+                    pnlAbsolute: number;
+                    pnlPercent: number | null;
+                    hitRate: number | null;
+                    profitFactor: number | null;
+                    avgWinSize: number | null;
+                    avgLossSize: number | null;
+                    avgReturnPerWin: number | null;
+                    avgReturnPerLoss: number | null;
+                    maxDrawdown: number | null;
+                    sharpeRatio: number | null;
+                    sortinoRatio: number | null;
+                };
+                realizedPlusUnrealized: {
+                    pnlAbsolute: number;
+                    pnlPercent: number | null;
+                    hitRate: number | null;
+                    profitFactor: number | null;
+                    avgWinSize: number | null;
+                    avgLossSize: number | null;
+                    avgReturnPerWin: number | null;
+                    avgReturnPerLoss: number | null;
+                    maxDrawdown: number | null;
+                    sharpeRatio: number | null;
+                    sortinoRatio: number | null;
+                };
+                realizedHitRate: number | null;
+                profitFactor: number | null;
+                avgWinSize: number | null;
+                avgLossSize: number | null;
+                breakevenHitRate: number | null;
+                cushion: number | null;
+            };
+            assets: {
+                asset: string;
+                realizedOnly: {
+                    pnlAbsolute: number;
+                    pnlPercent: number | null;
+                    hitRate: number | null;
+                    profitFactor: number | null;
+                    avgWinSize: number | null;
+                    avgLossSize: number | null;
+                    avgReturnPerWin: number | null;
+                    avgReturnPerLoss: number | null;
+                    maxDrawdown: number | null;
+                    sharpeRatio: number | null;
+                    sortinoRatio: number | null;
+                };
+                realizedPlusUnrealized: {
+                    pnlAbsolute: number;
+                    pnlPercent: number | null;
+                    hitRate: number | null;
+                    profitFactor: number | null;
+                    avgWinSize: number | null;
+                    avgLossSize: number | null;
+                    avgReturnPerWin: number | null;
+                    avgReturnPerLoss: number | null;
+                    maxDrawdown: number | null;
+                    sharpeRatio: number | null;
+                    sortinoRatio: number | null;
+                };
+                unrealizedReturnPerDay: number | null;
+            }[];
+            pairs: {
+                key: string;
+                longAssets: string[];
+                shortAssets: string[];
+                trades: number;
+                wins: number;
+                losses: number;
+                hitRate: number | null;
+                avgWinSize: number | null;
+                avgLossSize: number | null;
+                expectancy: number | null;
+                totalPnl: number;
+                bookPercent: number | null;
+            }[];
+            series?: {
+                date: string;
+                trades: number;
+                wins: number;
+                losses: number;
+                dayPnl: number;
+                hitRate: number | null;
+                winLossRatio: number | null;
+                rollingHitRate: number | null;
+                rollingWinLossRatio: number | null;
+                dailyReturn: number | null;
+                cumulativeReturn: number;
+                equity: number;
+                drawdown: number;
+                rollingSharpe: number | null;
+                rollingSortino: number | null;
+                rollingVolatility: number | null;
+            }[] | undefined;
+        }>;
+    };
     prices: {
         list: (query: HttpTypes.PricesQueryParams, headers?: ClientHeaders) => Promise<{
             mid: Record<string, string>;
@@ -1163,6 +1417,29 @@ declare class Core {
                         track: "PEAK" | "TROUGH";
                         threshold: number;
                     };
+                } | {
+                    type: "funding_rate";
+                    data: {
+                        connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                        symbol: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "prediction_market";
+                    data: {
+                        source: "kalshi" | "polymarket";
+                        marketKey: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "btc_dominance";
+                    data: {
+                        source: "coingecko";
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
                 };
                 context: {
                     type: "MARKET";
@@ -1264,6 +1541,29 @@ declare class Core {
                         track: "PEAK" | "TROUGH";
                         threshold: number;
                     };
+                } | {
+                    type: "funding_rate";
+                    data: {
+                        connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                        symbol: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "prediction_market";
+                    data: {
+                        source: "kalshi" | "polymarket";
+                        marketKey: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "btc_dominance";
+                    data: {
+                        source: "coingecko";
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
                 };
                 context: {
                     type: "MARKET";
@@ -1417,6 +1717,29 @@ declare class Core {
                     data: {
                         priceSource: "mark" | "mid";
                     };
+                } | {
+                    type: "funding_rate";
+                    data: {
+                        connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                        symbol: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "prediction_market";
+                    data: {
+                        source: "kalshi" | "polymarket";
+                        marketKey: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "btc_dominance";
+                    data: {
+                        source: "coingecko";
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
                 };
                 context: {
                     type: "MARKET";
@@ -1501,6 +1824,29 @@ declare class Core {
                         track: "PEAK" | "TROUGH";
                         threshold: number;
                     };
+                } | {
+                    type: "funding_rate";
+                    data: {
+                        connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                        symbol: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "prediction_market";
+                    data: {
+                        source: "kalshi" | "polymarket";
+                        marketKey: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "btc_dominance";
+                    data: {
+                        source: "coingecko";
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
                 };
                 context: {
                     type: "MARKET";
@@ -1602,6 +1948,29 @@ declare class Core {
                         track: "PEAK" | "TROUGH";
                         threshold: number;
                     };
+                } | {
+                    type: "funding_rate";
+                    data: {
+                        connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                        symbol: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "prediction_market";
+                    data: {
+                        source: "kalshi" | "polymarket";
+                        marketKey: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "btc_dominance";
+                    data: {
+                        source: "coingecko";
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
                 };
                 context: {
                     type: "MARKET";
@@ -1755,6 +2124,29 @@ declare class Core {
                     data: {
                         priceSource: "mark" | "mid";
                     };
+                } | {
+                    type: "funding_rate";
+                    data: {
+                        connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                        symbol: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "prediction_market";
+                    data: {
+                        source: "kalshi" | "polymarket";
+                        marketKey: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "btc_dominance";
+                    data: {
+                        source: "coingecko";
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
                 };
                 context: {
                     type: "MARKET";
@@ -1839,6 +2231,29 @@ declare class Core {
                         track: "PEAK" | "TROUGH";
                         threshold: number;
                     };
+                } | {
+                    type: "funding_rate";
+                    data: {
+                        connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                        symbol: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "prediction_market";
+                    data: {
+                        source: "kalshi" | "polymarket";
+                        marketKey: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "btc_dominance";
+                    data: {
+                        source: "coingecko";
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
                 };
                 context: {
                     type: "MARKET";
@@ -1940,6 +2355,29 @@ declare class Core {
                         track: "PEAK" | "TROUGH";
                         threshold: number;
                     };
+                } | {
+                    type: "funding_rate";
+                    data: {
+                        connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                        symbol: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "prediction_market";
+                    data: {
+                        source: "kalshi" | "polymarket";
+                        marketKey: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "btc_dominance";
+                    data: {
+                        source: "coingecko";
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
                 };
                 context: {
                     type: "MARKET";
@@ -2093,6 +2531,29 @@ declare class Core {
                     data: {
                         priceSource: "mark" | "mid";
                     };
+                } | {
+                    type: "funding_rate";
+                    data: {
+                        connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                        symbol: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "prediction_market";
+                    data: {
+                        source: "kalshi" | "polymarket";
+                        marketKey: string;
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
+                } | {
+                    type: "btc_dominance";
+                    data: {
+                        source: "coingecko";
+                        track: "PEAK" | "TROUGH";
+                        threshold: number;
+                    };
                 };
                 context: {
                     type: "MARKET";
@@ -2149,7 +2610,7 @@ declare class Core {
             profile: {
                 id: string;
                 displayName: string;
-                role: "basic" | "pro";
+                role: "basic" | "pro" | "admin";
                 address: string | null;
                 email: string | null;
                 emailVerified: boolean;
@@ -2210,6 +2671,170 @@ declare class Core {
             }[];
         }>;
     };
+    tca: {
+        execution: (executionId: string, headers?: ClientHeaders) => Promise<{
+            fillMetrics: {
+                id: string;
+                fillId: string;
+                tradeAccountId: string;
+                connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                symbol: string;
+                status: "FINAL";
+                createdAt: string;
+                updatedAt: string;
+                benchmarkId?: string | undefined;
+                executionId?: string | undefined;
+                positionId?: string | undefined;
+                cloid?: string | undefined;
+                exchangeFillId?: string | undefined;
+                slippageBps?: string | undefined;
+                slippageQuote?: string | undefined;
+                slippageUsd?: string | undefined;
+                implementationShortfallBps?: string | undefined;
+                spreadCostQuote?: string | undefined;
+                spreadCostUsd?: string | undefined;
+                tradeFee?: string | undefined;
+                pearFee?: string | undefined;
+                totalCostUsd?: string | undefined;
+                gatewayLatencyMs?: number | undefined;
+                timeToFillMs?: number | undefined;
+                quoteAsset?: string | undefined;
+                notionalQuote?: string | undefined;
+                notionalUsd?: string | undefined;
+                submittedAt?: string | undefined;
+                acknowledgedAt?: string | undefined;
+                exchangeExecutedAt?: string | undefined;
+                timingGranularity?: "BATCH" | "LEG" | undefined;
+                benchmark?: {
+                    id: string;
+                    executionId: string;
+                    legIndex: number;
+                    connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                    symbol: string;
+                    side: "BUY" | "SELL";
+                    source: string;
+                    timestamp: string;
+                    createdAt: string;
+                    orderId?: string | undefined;
+                    cloid?: string | undefined;
+                    decisionPrice?: string | undefined;
+                    arrivalMid?: string | undefined;
+                    arrivalBid?: string | undefined;
+                    arrivalAsk?: string | undefined;
+                    markPrice?: string | undefined;
+                    indexPrice?: string | undefined;
+                    quoteAsset?: string | undefined;
+                    usdConversionPrice?: string | undefined;
+                } | undefined;
+            }[];
+            summary?: {
+                id: string;
+                executionId: string;
+                tradeAccountId: string;
+                connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                fillCount: number;
+                status: "FINAL";
+                createdAt: string;
+                updatedAt: string;
+                notionalQuote?: string | undefined;
+                notionalUsd?: string | undefined;
+                weightedSlippageBps?: string | undefined;
+                totalSlippageUsd?: string | undefined;
+                totalTradeFee?: string | undefined;
+                totalPearFee?: string | undefined;
+                totalCostUsd?: string | undefined;
+            } | undefined;
+        }>;
+        position: (positionId: string, query?: HttpTypes.TcaPositionQueryParamsInput, headers?: ClientHeaders) => Promise<{
+            limit: number;
+            fillMetrics: {
+                id: string;
+                fillId: string;
+                tradeAccountId: string;
+                connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                symbol: string;
+                status: "FINAL";
+                createdAt: string;
+                updatedAt: string;
+                benchmarkId?: string | undefined;
+                executionId?: string | undefined;
+                positionId?: string | undefined;
+                cloid?: string | undefined;
+                exchangeFillId?: string | undefined;
+                slippageBps?: string | undefined;
+                slippageQuote?: string | undefined;
+                slippageUsd?: string | undefined;
+                implementationShortfallBps?: string | undefined;
+                spreadCostQuote?: string | undefined;
+                spreadCostUsd?: string | undefined;
+                tradeFee?: string | undefined;
+                pearFee?: string | undefined;
+                totalCostUsd?: string | undefined;
+                gatewayLatencyMs?: number | undefined;
+                timeToFillMs?: number | undefined;
+                quoteAsset?: string | undefined;
+                notionalQuote?: string | undefined;
+                notionalUsd?: string | undefined;
+                submittedAt?: string | undefined;
+                acknowledgedAt?: string | undefined;
+                exchangeExecutedAt?: string | undefined;
+                timingGranularity?: "BATCH" | "LEG" | undefined;
+                benchmark?: {
+                    id: string;
+                    executionId: string;
+                    legIndex: number;
+                    connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                    symbol: string;
+                    side: "BUY" | "SELL";
+                    source: string;
+                    timestamp: string;
+                    createdAt: string;
+                    orderId?: string | undefined;
+                    cloid?: string | undefined;
+                    decisionPrice?: string | undefined;
+                    arrivalMid?: string | undefined;
+                    arrivalBid?: string | undefined;
+                    arrivalAsk?: string | undefined;
+                    markPrice?: string | undefined;
+                    indexPrice?: string | undefined;
+                    quoteAsset?: string | undefined;
+                    usdConversionPrice?: string | undefined;
+                } | undefined;
+            }[];
+            nextCursor?: string | undefined;
+        }>;
+        summary: (query?: HttpTypes.TcaSummaryQueryParamsInput, headers?: ClientHeaders) => Promise<{
+            limit: number;
+            summaries: {
+                id: string;
+                executionId: string;
+                tradeAccountId: string;
+                connector: "hyperliquid" | "binance" | "bybit" | "okx" | "lighter";
+                fillCount: number;
+                status: "FINAL";
+                createdAt: string;
+                updatedAt: string;
+                notionalQuote?: string | undefined;
+                notionalUsd?: string | undefined;
+                weightedSlippageBps?: string | undefined;
+                totalSlippageUsd?: string | undefined;
+                totalTradeFee?: string | undefined;
+                totalPearFee?: string | undefined;
+                totalCostUsd?: string | undefined;
+            }[];
+            totals: {
+                executionCount: number;
+                fillCount: number;
+                notionalQuote?: string | undefined;
+                notionalUsd?: string | undefined;
+                totalSlippageUsd?: string | undefined;
+                totalTradeFee?: string | undefined;
+                totalPearFee?: string | undefined;
+                totalCostUsd?: string | undefined;
+            };
+            nextCursor?: string | undefined;
+        }>;
+    };
 }
 
 export { Core };