Skip to main content
POST
/
v1beta1
/
get_trade_stats
Get Trade Stats
curl --request POST \
  --url https://traderapi.us-east-1.privatelink.preprod.polymarketexchange.com/api/v1beta1/get_trade_stats \
  --header 'Content-Type: application/json' \
  --data '
{
  "bars": 123,
  "end_time": "2023-11-07T05:31:56Z",
  "end_trade_date": {
    "day": 123,
    "month": 123,
    "year": 123
  },
  "start_time": "2023-11-07T05:31:56Z",
  "start_trade_date": {
    "day": 123,
    "month": 123,
    "year": 123
  },
  "symbol": "<string>"
}
'
{
  "bar_end_time": [
    "2023-11-07T05:31:56Z"
  ],
  "bar_start_time": [
    "2023-11-07T05:31:56Z"
  ],
  "bars": [
    {
      "cleared_notional": "<string>",
      "cleared_trade_count": "<string>",
      "cleared_volume": "<string>",
      "first": "<string>",
      "high": "<string>",
      "last": "<string>",
      "low": "<string>",
      "notional": "<string>",
      "total_trade_count": "<string>",
      "volume": "<string>"
    }
  ],
  "stats": {
    "cleared_notional": "<string>",
    "cleared_trade_count": "<string>",
    "cleared_volume": "<string>",
    "first": "<string>",
    "high": "<string>",
    "last": "<string>",
    "low": "<string>",
    "notional": "<string>",
    "total_trade_count": "<string>",
    "volume": "<string>"
  }
}

Body

application/json
bars
integer<int32>

Number of individual bars to include for the given time window.

end_time
string<date-time>

End time for the trade data time window.

end_trade_date
object

Date represents a whole or partial calendar date.

start_time
string<date-time>

Start time for the trade data time window.

start_trade_date
object

Date represents a whole or partial calendar date.

symbol
string

Symbol to filter upon.

Response

A successful response.

bar_end_time
string<date-time>[]

The end of the time window corresponding to the same index as the bars array.

bar_start_time
string<date-time>[]

The start of the time window corresponding to the same index as the bars array.

bars
object[]

The stats calculated in the given time window, split into individual time slices.

stats
object

TradeStats are a collection of stats on a set of trades.