Fills
The fills API contains private endpoints for querying order fills. It requires a Base64-encoded SHA256 HMAC signature as defined in Authentication.
| HTTP Method | Endpoint |
|---|---|
GET | /fills |
The endpoint supports the following query parameters:
| Parameter | Optionality | Notes |
|---|---|---|
symbol | optional | Filter fills by product symbol, only works in production |
product_id | optional | Filter fills by product ID, only works in production |
product_type | optional | Filter fills by product type, only works in production |
clearing_firm_code | optional | Filter fills by clearing firm code, only works in production |
account_id | optional | Filter fills by account code, only works in production |
connection_id | optional | Filter fills by connection ID, only works in production |
day | optional | Get range for day, overrides begin_time and end_time |
limit | optional | Limit number of fills per page |
begin_time | optional | Begin time for fill time range, see Time for more details |
end_time | optional | End time for fill time range, see Time for more details |
order | optional | Page order, either asc or desc |
cursor | optional | Cursor 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.
Signing up with Bitnomial, Inc. requires additional verification with an FCM to trade futures. Futures accounts are offered by Bitnomial Clearing, LLC, a CFTC-registered FCM and NFA member. Trading in futures involves substantial risks. You should only trade in financial products that you are familiar with and understand the associated risks, and after carefully considering whether such trading is suitable in light of your investment experience, financial position, and investment objectives. Leverage in futures trading can work for you or against you. The risk of loss using leverage can exceed your initial investment amount. See Bitnomial entity affiliation and registration disclosures and FCM financial and risk disclosures.