/binance/trades/aggregated

POST /api/binance/trades/aggregated

Price: 10 credits

Get aggregate (compressed) trades for a trading pair

How to use it

Get aggregate trades for a Binance spot trading pair (e.g. 'BTCUSDT'). Aggregate trades compress all individual trades that filled at the same price from a single order into one record, making them ideal for volume analysis. Each record carries the aggregate id, price, quantity, the first and last underlying trade ids it covers, execution time, whether the buyer was the maker, and the best-match flag. By default the most recent trades are returned; pass from_id to start at a specific aggregate id, or start_time/end_time (unix milliseconds) for a time range. Ordered oldest to newest.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• symbol string required — Trading pair symbol, uppercase, no separator (examples: "BTCUSDT", "ETHUSDT")
• count integer required — Number of aggregate trades to return (min: 1)
• from_id integer nullable — Return aggregate trades starting from this aggregate id (min: 0)
• start_time integer nullable — Start of the range, unix milliseconds (min: 0)
• end_time integer nullable — End of the range, unix milliseconds (min: 0)

Response

• @type string (default: "BinanceAggTrade")
• agg_id integer required
• price number nullable
• quantity number nullable
• first_trade_id integer nullable
• last_trade_id integer nullable
• traded_at integer nullable
• is_buyer_maker boolean nullable
• is_best_match boolean nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Trading pair not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.