Source

lib/horizon/trade_aggregation_call_builder.d.ts

  1. import { Asset } from "@stellar/stellar-base";
  2. import { CallBuilder } from "./call_builder";
  3. import { HorizonApi } from "./horizon_api";
  4. import { ServerApi } from "./server_api";
  5. /**
  6. * Trade Aggregations facilitate efficient gathering of historical trade data.
  7. *
  8. * Do not create this object directly, use {@link Horizon.Server#tradeAggregation}.
  9. *
  10. * @augments CallBuilder
  11. * @private
  12. * @class
  13. *
  14. * @param {string} serverUrl serverUrl Horizon server URL.
  15. * @param {Asset} base base asset
  16. * @param {Asset} counter counter asset
  17. * @param {number} start_time lower time boundary represented as millis since epoch
  18. * @param {number} end_time upper time boundary represented as millis since epoch
  19. * @param {number} resolution segment duration as millis since epoch. *Supported values are 1 minute (60000), 5 minutes (300000), 15 minutes (900000), 1 hour (3600000), 1 day (86400000) and 1 week (604800000).
  20. * @param {number} offset 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.
  21. */
  22. export declare class TradeAggregationCallBuilder extends CallBuilder<ServerApi.CollectionPage<TradeAggregationRecord>> {
  23. constructor(serverUrl: URI, base: Asset, counter: Asset, start_time: number, end_time: number, resolution: number, offset: number);
  24. /**
  25. * @private
  26. * @param {number} resolution Trade data resolution in milliseconds
  27. * @returns {boolean} true if the resolution is allowed
  28. */
  29. private isValidResolution;
  30. /**
  31. * @private
  32. * @param {number} offset Time offset in milliseconds
  33. * @param {number} resolution Trade data resolution in milliseconds
  34. * @returns {boolean} true if the offset is valid
  35. */
  36. private isValidOffset;
  37. }
  38. interface TradeAggregationRecord extends HorizonApi.BaseResponse {
  39. timestamp: number | string;
  40. trade_count: number | string;
  41. base_volume: string;
  42. counter_volume: string;
  43. avg: string;
  44. high: string;
  45. low: string;
  46. open: string;
  47. close: string;
  48. }
  49. export {};