@pear-protocol/hyperliquid-sdk
Version:
React SDK for Pear Protocol Hyperliquid API integration
40 lines (39 loc) • 1.39 kB
TypeScript
import type { ApiResponse } from '../types';
export type PortfolioInterval = '1d' | '1w' | '1m' | '1y' | 'all';
export interface PortfolioBucketDto {
periodStart: string;
periodEnd: string;
volume: number;
openInterest: number;
winningTradesCount: number;
winningTradesUsd: number;
losingTradesCount: number;
losingTradesUsd: number;
}
export interface PortfolioOverallDto {
totalWinningTradesCount: number;
totalLosingTradesCount: number;
totalWinningUsd: number;
totalLosingUsd: number;
currentOpenInterest: number;
currentTotalVolume: number;
unrealizedPnl: number;
totalTrades: number;
}
export interface PortfolioIntervalsDto {
oneDay: PortfolioBucketDto[];
oneWeek: PortfolioBucketDto[];
oneMonth: PortfolioBucketDto[];
oneYear: PortfolioBucketDto[];
all: PortfolioBucketDto[];
}
export interface PortfolioResponseDto {
intervals: PortfolioIntervalsDto;
overall: PortfolioOverallDto;
}
/**
* Get portfolio summary buckets and overall metrics
* Returns bucketed volume, open interest snapshot, win/loss trade counts, and overall metrics filtered to PEAR fills (cloid LIKE 0x50454152%)
* Caller should supply an accessToken from localStorage.getItem('accessToken')
*/
export declare function getPortfolio(baseUrl: string, accessToken: string): Promise<ApiResponse<PortfolioResponseDto>>;