LimestoneQueryForSingleSymbol

limestone-api / Exports / LimestoneQueryForSingleSymbol

Class: LimestoneQueryForSingleSymbol

Hierarchy

• LimestoneQueryForSingleOrSeveralSymbols

  ↳ LimestoneQueryForSingleSymbol

Table of contents

Constructors

• constructor

Properties

• params

Methods

• atDate

• forLastDays

• forLastHours

• fromDate

• getExecutableQuery

• hoursAgo

• latest

• toDate

Constructors

constructor

+ new LimestoneQueryForSingleSymbol(params: QueryParams): LimestoneQueryForSingleSymbol

Parameters:

Name	Type
params	QueryParams

Returns: LimestoneQueryForSingleSymbol

Overrides: LimestoneQueryForSingleOrSeveralSymbols

Defined in: limestone-query.ts:102

Properties

params

• Protected params: QueryParams

Inherited from: LimestoneQueryForSingleOrSeveralSymbols.params

Defined in: limestone-query.ts:58

Methods

atDate

▸ atDate(date: ConvertableToDate): LimestoneQueryExecutable

Configures query to fetch the price for a specific date.

Parameters:

Name	Type	Description
date	ConvertableToDate	Date for the historical price (date | timestamp | string)

Returns: LimestoneQueryExecutable

query object

Inherited from: LimestoneQueryForSingleOrSeveralSymbols

Defined in: limestone-query.ts:97

forLastDays

▸ forLastDays(daysCount: number): LimestoneQueryExecutable

Configures query to fetch the price for the last few days

Parameters:

Name	Type	Description
daysCount	number	Number of days in the time range

Returns: LimestoneQueryExecutable

query object

Defined in: limestone-query.ts:154

forLastHours

▸ forLastHours(hoursCount: number): LimestoneQueryExecutable

Configures query to fetch the price for the last few hours

Parameters:

Name	Type	Description
hoursCount	number	Number of hours in the time range

Returns: LimestoneQueryExecutable

query object

Defined in: limestone-query.ts:139

fromDate

▸ fromDate(date: ConvertableToDate): LimestoneQueryForSingleSymbol

Configures query to fetch the price in a time range. It is important to use fromDate with toDate query methods

Parameters:

Name	Type	Description
date	ConvertableToDate	Start date/time for the time range

Returns: LimestoneQueryForSingleSymbol

query object

Defined in: limestone-query.ts:113

getExecutableQuery

▸ ProtectedgetExecutableQuery(update: any): LimestoneQueryExecutable

Type parameters:

Name

T

Parameters:

Name	Type
update	any

Returns: LimestoneQueryExecutable

Inherited from: LimestoneQueryForSingleOrSeveralSymbols

Defined in: limestone-query.ts:65

hoursAgo

▸ hoursAgo(hoursCount: number): LimestoneQueryExecutable

Configures query to fetch the price for X hours ago.

Parameters:

Name	Type	Description
hoursCount	number	Number of hours ago

Returns: LimestoneQueryExecutable

query object

Inherited from: LimestoneQueryForSingleOrSeveralSymbols

Defined in: limestone-query.ts:86

latest

▸ latest(): LimestoneQueryExecutable

Configures query to fetch the latest price/prices It doesn't support any params

Returns: LimestoneQueryExecutable

query object

Inherited from: LimestoneQueryForSingleOrSeveralSymbols

Defined in: limestone-query.ts:77

toDate

▸ toDate(date: ConvertableToDate): LimestoneQueryExecutable

Configures query to fetch the price in a time range. toDate method should go after the fromDate

Parameters:

Name	Type	Description
date	ConvertableToDate	End date/time for the time range

Returns: LimestoneQueryExecutable

query object

Defined in: limestone-query.ts:126