Skip to content

Query Fill Records

Endpoint Information

Endpoint: GET /api/v1/orders/filled

Description: Flexible query of order fill records, supports multiple filtering conditions, pagination, and sorting

Authentication: API Key credential authentication

Query Parameters

ParameterTypeRequiredDescription
order_iduuidNoOrder ID
order_hashstringNoOrder hash
takerstringNoTaker address
tx_hashstringNoTransaction hash
fill_quantity_minstringNoMinimum fill quantity
fill_quantity_maxstringNoMaximum fill quantity
fill_amount_minstringNoMinimum fill amount
fill_amount_maxstringNoMaximum fill amount
fee_amount_minstringNoMinimum fee amount
fee_amount_maxstringNoMaximum fee amount
incentive_amount_minstringNoMinimum incentive amount
incentive_amount_maxstringNoMaximum incentive amount
block_number_minlongNoMinimum block number
block_number_maxlongNoMaximum block number
statusenumNoFill status (see OrderStatus)
created_afterstringNoCreated after
created_beforestringNoCreated before
sort_bystringNoSort field
sort_orderstringNoSort direction
pageintNoPage number
page_sizeintNoPage size

Response Parameters

FieldTypeDescription
totalintTotal records
pageintCurrent page
page_sizeintPage size
total_pagesintTotal pages
fillsobject arrayFill record list
fills[].iduuidFill record unique identifier
fills[].order_iduuidOrder ID
fills[].order_hashstringOrder hash
fills[].takerstringTaker address
fills[].fill_quantitystringFill quantity
fills[].fill_amountstringFill amount
fills[].fee_amountstringFee amount
fills[].incentive_amountstringIncentive amount
fills[].tx_hashstringTransaction hash
fills[].block_numberlongBlock number
fills[].statusenumFill status (see OrderStatus)
fills[].created_atstringCreation time

Request Example

bash
curl -X GET "/api/v1/orders/filled?page=1&page_size=20" \
     -H "X-API-Key: YOUR_API_KEY" \
     -H "Content-Type: application/json"

Response Example

json
{
    "code": 0,
    "data": {
        "total": 100,
        "page": 1,
        "page_size": 20,
        "total_pages": 5,
        "fills": [
            {
                "id": "550e8400-e29b-41d4-a716-446655440000",
                "order_id": "660e8400-e29b-41d4-a716-446655440001",
                "order_hash": "0x1234567890abcdef...",
                "taker": "0xabcdef1234567890...",
                "fill_quantity": "50",
                "fill_amount": "7512500000000000000000",
                "fee_amount": "75125000000000000000",
                "incentive_amount": "500000000000000000",
                "tx_hash": "0xfedcba0987654321...",
                "block_number": 12345678,
                "status": "partially_filled",
                "created_at": "2025-01-17T03:10:00Z"
            }
        ]
    }
}

Enum Types

OrderStatus - Order Status

EnumDescription
partially_filledPartially filled
filledFully filled

Notes

  • Fill records are sorted by creation time in descending order
  • Can query by multiple condition combinations
  • Supports filtering by amount range, quantity range, etc.