RedstoneQueryForSingleSymbol

redstone-api / Exports / RedstoneQueryForSingleSymbol

Class: RedstoneQueryForSingleSymbol

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

Parameters:

Name

Type

params

QueryParams

Returns: RedstoneQueryForSingleSymbol

Overrides: RedstoneQueryForSingleOrSeveralSymbols

Properties

params

Protected params: QueryParams

Inherited from: RedstoneQueryForSingleOrSeveralSymbols.params

Methods

atDate

atDate(date: ConvertableToDate): RedstoneQueryExecutable

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: RedstoneQueryExecutable

query object

Inherited from: RedstoneQueryForSingleOrSeveralSymbols

forLastDays

forLastDays(daysCount: number): RedstoneQueryExecutable

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: RedstoneQueryExecutable

query object

forLastHours

forLastHours(hoursCount: number): RedstoneQueryExecutable

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: RedstoneQueryExecutable

query object

fromDate

fromDate(date: ConvertableToDate): RedstoneQueryForSingleSymbol

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: RedstoneQueryForSingleSymbol

query object

getExecutableQuery

ProtectedgetExecutableQuery(update: any): RedstoneQueryExecutable

Type parameters:

Name

T

Parameters:

Name

Type

update

any

Returns: RedstoneQueryExecutable

Inherited from: RedstoneQueryForSingleOrSeveralSymbols

hoursAgo

hoursAgo(hoursCount: number): RedstoneQueryExecutable

Configures query to fetch the price for X hours ago.

Parameters:

Name

Type

Description

hoursCount

number

Number of hours ago

Returns: RedstoneQueryExecutable

query object

Inherited from: RedstoneQueryForSingleOrSeveralSymbols

latest

latest(): RedstoneQueryExecutable

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

Returns: RedstoneQueryExecutable

query object

Inherited from: RedstoneQueryForSingleOrSeveralSymbols

toDate

toDate(date: ConvertableToDate): RedstoneQueryExecutable

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: RedstoneQueryExecutable

query object

Last updated