Orders

Query historical orders by subaccount or order digests.

Rate limits

  • 480 requests/min or 80 requests/10secs per IP address. (weight = 5)

See more details in API Rate limits

Request

Query subaccount matched orders, ordered by submission index desc.

POST [ARCHIVE_ENDPOINT]

Body

{
  "orders": {
    "product_ids": [
      1,
      2,
      3,
      4
    ],
    "subaccount": "0x12a0b4888021576eb10a67616dd3dd3d9ce206b664656661756c740000000000",
    "max_time": 1679728762,
    "limit": 5
  }
}

Request Parameters

Parameter
Type
Required
Description

subaccount

string

conditional

A bytes32 sent as a hex string; includes the address and the subaccount identifier. must be provided when querying by subaccount.

product_ids

number[]

No

When provided, only return orders for the specified product ids; return orders for all products otherwise.

idx

number / string

No

When provided, only return orders with submission_idx <= idx

max_time

number / string

No

When idx is not provided, max_time (unix epoch in seconds) can be used to only return orders created <= max_time

digests

string[]

conditional

Must be provided when querying by digests. only return orders matching the specified digests. note: cannot specify digests alongside with subaccount , product_ids or max_time

limit

number

No

Max number of orders to return. defaults to 100. max possible of 500. note: when querying by digests limit must be <= total digests provided

Response

{
    "orders": [
        {
            "digest": "0xf4f7a8767faf0c7f72251a1f9e5da590f708fd9842bf8fcdeacbaa0237958fff",
            "subaccount": "0x12a0b4888021576eb10a67616dd3dd3d9ce206b664656661756c740000000000",
            "product_id": 4,
            "submission_idx": "563024",
            "last_fill_submission_idx": "563024",
            "amount": "20000000000000000000",
            "price_x18": "1751900000000000000000",
            "base_filled": "2320000000000000000",
            "quote_filled": "-4064898974794958991797",
            "fee": "812974794958991797",
            "expiration": "4611686020107120163",
            "nonce": "1761323164913106944"
        },
        {
            "digest": "0x0495a88fb3b1c9bed9b643b8e264a391d04cdd48890d81cd7c4006473f28e361",
            "subaccount": "0x12a0b4888021576eb10a67616dd3dd3d9ce206b664656661756c740000000000",
            "product_id": 3,
            "submission_idx": "563019",
            "last_fill_submission_idx": "563019",
            "amount": "-20000000000000000000",
            "price_x18": "1750800000000000000000",
            "base_filled": "-1159999999999999999",
            "quote_filled": "2030293721599999999999",
            "fee": "609278400000000000",
            "expiration": "4611686020107119905",
            "nonce": "1761322893628669952"
        },
        {
            "digest": "0x29078702ad95615f0040eafdccc85cbf92569bf9656be928f9f17c5ccbb52041",
            "subaccount": "0x12a0b4888021576eb10a67616dd3dd3d9ce206b664656661756c740000000000",
            "product_id": 4,
            "submission_idx": "563018",
            "last_fill_submission_idx": "563018",
            "amount": "-20000000000000000000",
            "price_x18": "1750700000000000000000",
            "base_filled": "-1160000000000000000",
            "quote_filled": "2030380837600000000000",
            "fee": "406162400000000000",
            "expiration": "4611686020107119880",
            "nonce": "1761322865074896896"
        },
    ]
}

Response Fields

Field name
Description

digest

The unique hash of the order.

subaccount

The subaccount that placed the order.

product_id

The id of of the product the order was executed for.

submission_idx

Used to uniquely identify the blockchain transaction that generated the order. For multi-fills orders, this is the submission_idx of the first fill.

last_fill_submission_idx

For multi-fills orders, this is the submission_idx of the last fill. For single fill orders, it has the same value as submission_idx.

amount

The original amount of base to buy or sell.

price_x18

The original order price.

base_filled

The total amount of base (e.g: BTC) filled on this order.

quote_filled

The total amount of quote (e.g: USDC) filled on this order.

fee

The total amount of fee paid on this order.

expiration

The original order expiration.

nonce

The original order nonce.

Last updated