Matches
Query historical matches for a given subaccount or provided products.
Rate limits
Dynamic based on
limit
param provided (weight = 2 + limit / 10)E.g: With
limit=100
, you can make up to 200 requests per min or 33 requests / 10 secs.
See more details in API Rate limits
Request
Request Parameters
Parameter | Type | Required | Description |
---|---|---|---|
subaccount | string | No | A |
product_ids | number[] | No | When provided, only return matches for the specified product ids; return matches for all products otherwise. |
idx | number / string | No | When provided, only return matches with |
max_time | number / string | No | When |
limit | number | No | Max number of matches to return. defaults to |
Response
Note:
the response includes a
txs
field which contains the relevant transactions for the returned matches. There are>=1 matches
per transaction.both
matches
andtxs
are in descending order bysubmission_idx
.
use the
submission_idx
to associate a match to it's corresponding transaction.the
fee
provided in the response includes taker / maker fees + sequencer fees. See fees for more details.
Response Fields
Matches
Field name | Description |
---|---|
submission_idx | Wsed to uniquely identify the blockchain transaction that generated the match; you can use it to grab the relevant transaction in the |
digest | The unique hash of the order. |
order.sender | The sender that placed the order. |
order.priceX18 | The original order price. |
order.amount | The original order amount. |
order.expiration | The original order expiration. |
order.nonce | The original order nonce. |
pre_balance | The state of your balance before the match happened. |
post_balance | The state of your balance after the match happened. |
base_filled | The amount of base (e.g: BTC) filled on this match. |
quote_filled | The amount of quote (e.g: USDC) filled on this match. |
fee | The amount of trading fees + sequencer fees paid on this match. |
sequencer_fee | The amount of sequencer fees paid on this match. |
cumulative_base_filled | The total amount of base (e.g: BTC) filled on this order up this match. |
cumulative_quote_filled | The total amount of quote (e.g: USDC) filled up to this match. |
cumulative_fee | The total amount of fee paid up to this match. |
Txs
Field name | Description |
---|---|
submission_idx | Unique identifier of the transaction. |
product_id | Product associated to the transaction. |
amm | Whether the match was against the AMM. |
taker | The taker order. |
maker | The maker order. |
timestamp | The unix epoch in seconds of when the transaction took place. |
Last updated