Class AnalyticsAPI

Represents a class for handling operations related to making analytics queries from the voidnode server.

Hierarchy

BaseAPI
- AnalyticsAPI

Index

Constructors

Properties

premia streamIndex

Methods

cancelAllStreams getVaultDayData

Constructors

constructor

new AnalyticsAPI(premia): AnalyticsAPI
Construct a new BaseAPI object.
Parameters
- premia: Premia
  
  An instance of the Premia SDK.
Returns AnalyticsAPI
Inherited from BaseAPI.constructor
- Defined in src/api/baseAPI.ts:25

Properties

`Readonly` premia

premia: Premia

The Premia SDK instance.

`Protected` streamIndex

streamIndex: number = 0

The current index of quote streams. Used to cancel stale streams.

Methods

cancelAllStreams

cancelAllStreams(): Promise<void>
Cancels all ongoing streams.

Returns Promise<void>
Inherited from BaseAPI.cancelAllStreams
- Defined in src/api/baseAPI.ts:34

getVaultDayData

getVaultDayData(vaultAddress, startTime?, limit?, skip?): Promise<VaultDayData[]>
Retrieves daily data for a specific vault using its address.
Parameters
- vaultAddress: string
  
  The address of the vault for which daily data should be retrieved.
- Optional startTime: number = 0
  
  The timestamp (in seconds) from when the data should start being retrieved (default is 0).
- Optional limit: number = 1000
  
  The maximum number of data points to return (default is 1000).
- Optional skip: number = 0
  
  The number of data points to skip from the start of the results (default is 0).
Returns Promise<VaultDayData[]>
A promise that resolves to an array of VaultDayData objects, containing daily information about the vault at the specified address.
- Defined in src/api/analyticsAPI.ts:22

Generated using TypeDoc