List Trade Aggregations

GET 
/trade_aggregations:base_asset_type:counter_asset_type

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.

Request

Path Parameters

base_asset_type stringrequired

Possible values: [native, credit_alphanum4, credit_alphanum12]

The type for the base asset. Either native, credit_alphanum4, or credit_alphanum12.

counter_asset_type stringrequired

Possible values: [native, credit_alphanum4, credit_alphanum12]

The type for the counter asset. Either native, credit_alphanum4, or credit_alphanum12.

Query Parameters

start_time long

The lower time boundary represented as milliseconds since epoch.

end_time long

The upper time boundary represented as milliseconds since epoch.

resolution long

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).

offset long

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.

base_asset_issuer string

The Stellar address of the base asset’s issuer.

base_asset_code string

The code for the base asset.

counter_asset_issuer string

The Stellar address of the counter asset’s issuer.

counter_asset_code any

The code for the counter asset.

order string

Possible values: [asc, desc]

A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.

limit integer

The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.

Responses

200

Success

application/json

Schema

Schema

_embedded object
records object[]
Array [
timestamp string
trade_count string
base_volume string
counter_volume string
avg string
high string
high_r object
n string
d string
low string
low_r object
n string
d string
open string
open_r object
n string
d string
close string
close_r object
n string
d string
]

Example (from schema)

{
  "_embedded": {
    "records": [
      {
        "timestamp": "string",
        "trade_count": "string",
        "base_volume": "string",
        "counter_volume": "string",
        "avg": "string",
        "high": "string",
        "high_r": {
          "n": "string",
          "d": "string"
        },
        "low": "string",
        "low_r": {
          "n": "string",
          "d": "string"
        },
        "open": "string",
        "open_r": {
          "n": "string",
          "d": "string"
        },
        "close": "string",
        "close_r": {
          "n": "string",
          "d": "string"
        }
      }
    ]
  }
}

ListTradeAggregations

{
  "_links": {
    "self": {
      "href": "https://horizon-testnet.stellar.org/trade_aggregations?base_asset_type=native&counter_asset_code=EURT&counter_asset_issuer=GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S&counter_asset_type=credit_alphanum4&resolution=3600000&start_time=1582156800000&end_time=1582178400001"
    },
    "next": {
      "href": "https://horizon-testnet.stellar.org/trade_aggregations?base_asset_type=native&counter_asset_code=EURT&counter_asset_issuer=GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S&counter_asset_type=credit_alphanum4&end_time=1582178400001&resolution=3600000&start_time=1582171200000"
    },
    "prev": {
      "href": ""
    }
  },
  "_embedded": {
    "records": [
      {
        "timestamp": 1582164000000,
        "trade_count": 3,
        "base_volume": "399.3873200",
        "counter_volume": "25.5368082",
        "avg": "0.0639400",
        "high": "0.0652169",
        "high_r": {
          "N": 652169,
          "D": 10000000
        },
        "low": "0.0638338",
        "low_r": {
          "N": 8107550,
          "D": 127010393
        },
        "open": "0.0652169",
        "open_r": {
          "N": 652169,
          "D": 10000000
        },
        "close": "0.0638338",
        "close_r": {
          "N": 8107550,
          "D": 127010393
        }
      },
      {
        "timestamp": 1582167600000,
        "trade_count": 1,
        "base_volume": "149.8415320",
        "counter_volume": "9.7149804",
        "avg": "0.0648350",
        "high": "0.0648350",
        "high_r": {
          "N": 5000000,
          "D": 77118803
        },
        "low": "0.0648350",
        "low_r": {
          "N": 5000000,
          "D": 77118803
        },
        "open": "0.0648350",
        "open_r": {
          "N": 5000000,
          "D": 77118803
        },
        "close": "0.0648350",
        "close_r": {
          "N": 5000000,
          "D": 77118803
        }
      }
    ]
  }
}

Loading...