Skip to content

Schemas

PortfolioAnalysisResponse

typescript
interface PortfolioAnalysisResponse {
  successResults: PortfolioAnalysisItemSuccess[];
  failureResults: PortfolioAnalysisItemFailure[];
  totalCount: number;
}

PortfolioAnalysisItemSuccess

typescript
interface PortfolioAnalysisItemSuccess {
  requestKey: string;
  isin: string;
  potentialReturn: number | null;
  lendingRateBps: number | null;
  utilization: number;
  date: string | null;
}

PortfolioAnalysisItemFailure

typescript
interface PortfolioAnalysisItemFailure {
  requestKey: string;
  isin: string;
  errorMessage: string;
}

InstrumentIdentifier

typescript
interface InstrumentIdentifier {
  requestKey: string;
  isin?: string;
  compositeBbgId?: string;
  ticker?: string;
  pset?: string;
  exchangeCode?: string;
  mic?: string;
  countryCode?: string;
}

QuotaResponse

typescript
interface QuotaResponse {
  requestsPerMinute: QuotaResponseItem;
  requestsPerDay: QuotaResponseItem;
  requestsItemsPerDay: QuotaResponseItem;
}

interface QuotaResponseItem {
  current: number;
  max: number;
}

HotStockItem

typescript
interface HotStockItem {
  isin: string;
  actualUtilization: number;
  benchmarkFeeHighestLoanBps: number;
}

Sharegain API Documentation