HorizonRequestTradeAggregations class

This endpoint displays trade data based on filters set in the arguments. This is done by dividing a given time range into segments and aggregating statistics, for a given asset pair (base, counter) over each of these segments. The duration of the segments is specified with the resolution parameter. The start and end of the time range are given by startTime and endTime respectively, which are both rounded to the nearest multiple of resolution since epoch. The individual segments are also aligned with multiples of resolution since epoch. If you want to change this alignment, the segments can be offset by specifying the offset parameter.s https://developers.stellar.org/docs/data/horizon/api-reference/list-trade-aggregations

Inheritance

Constructors

HorizonRequestTradeAggregations({required RequestAssetType baseAssetType, required RequestAssetType counterAssetType, int? startTime, int? endtTime, int? resolution, int? offset, String? baseAssetCode, String? baseAssetIssuer, String? counterAssetCode, String? counterAssetIssuer, HorizonQueryOrder? order, int? limit})
const

Properties

baseAssetCode → String?
The code for the base asset. Required if the baseAssetType is not native.
final
baseAssetIssuer → String?
The Stellar address of the base asset’s issuer. Required if the baseAssetType is not native.
final
baseAssetType → RequestAssetType
The type for the base asset
final
counterAssetCode → String?
The code for the counter asset. Required if the counterAssetType is not native.
final
counterAssetIssuer → String?
The Stellar address of the counter asset’s issuer. Required if the counterAssetType is not native.
final
counterAssetType → RequestAssetType
The type for the counter asset.
final
endtTime → int?
The upper time boundary represented as milliseconds since epoch.
final
hashCode → int
The hash code for this object.
no setterinherited
limit → int?
The maximum number of records returned.
final
method → String
no setteroverride
offset → int?
Segments can be offset using this parameter. Expressed in milliseconds. Can only be used if the resolution is greater than 1 hour. Value must be in whole hours, less than the provided resolution, and less than 24 hours.
final
order → HorizonQueryOrder?
A designation of the order in which records should appear.
final
paginationParams → HorizonPaginationParams?
finalinherited
pathParameters → List<String>
no setterinherited
queryParameters → Map<String, dynamic>
no setteroverride
resolution → int?
The segment duration represented as milliseconds. Supported values are 1 minute (60000), 5 minutes (300000), 15 minutes (900000), 1 hour (3600000), 1 day (86400000) and 1 week (604800000).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startTime → int?
The lower time boundary represented as milliseconds since epoch.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onResonse(Map<String, dynamic> result) → Map<String, dynamic>
inherited
toRequest(int v) → HorizonRequestDetails
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited