Fills

The fills API contains private endpoints for querying order fills. It requires a Base64-encoded SHA256 HMAC signature as defined in Authentication.

HTTP MethodEndpoint
GET/fills

The endpoint supports the following query parameters:

ParameterOptionalityNotes
symboloptionalFilter fills by product symbol, only works in production
product_idoptionalFilter fills by product ID, only works in production
product_typeoptionalFilter fills by product type, only works in production
clearing_firm_codeoptionalFilter fills by clearing firm code, only works in production
account_idoptionalFilter fills by account code, only works in production
connection_idoptionalFilter fills by connection ID, only works in production
dayoptionalGet range for day, overrides begin_time and end_time
limitoptionalLimit number of fills per page
begin_timeoptionalBegin time for fill time range, see Time for more details
end_timeoptionalEnd time for fill time range, see Time for more details
orderoptionalPage order, either asc or desc
cursoroptionalCursor string for paginated query

The endpoint returns a pagination response of the type Pagination<Fill, CursorInfo>. More details on paginated APIs can be found in Pagination. Fill is defined as follows:

export interface Fill {
  symbol: string;
  product_id: number;
  product_type: ProductType;
  order_id: string;
  clearing_firm_code: string;
  time: string;
  connection_id: string;
  account_id: string;
  ack_id: string;
  side: Side;
  price: number;
  quantity_requested: number;
  quantity_filled: number;
  liquidity: Liquidity;
}

export type Liquidity = "Add" | "Remove" | "SpreadLeg";

export type Side = "Bid" | "Ask";

export type ProductType = "Future" | "Spread" | "Option";

Start Trading

Trade US Perpetual Futures, Physical Futures, and Options on the Bitcoin Complex®, XRP, ETH, SOL, and more.