Method Name
public/compare_ffi_margin
public/compare_ffi_marginInternal debugging RPC to compare python and ffi results.
For get_margin_with_portfolio_delta, the delta portfolio is computed from new_order.
Parameters
| ffi_functionstringrequired FFI function to compare with Python enum get_marginget_all_marginmargin_result_from_orderget_margin_with_portfolio_deltaget_margin_with_open_orders_get_or_raise_ffi_open_orders_margin_get_or_raise_ffi_worst_orders_subset |
| secretstringrequired ... |
| subaccount_idintegerrequired Subaccount ID |
| is_initialboolean Whether initial or maintenance margin. Only applies to get_margin() |
| new_orderobject New order to simulate (only applies to certain ffi functions) |
| new_order.amountstringrequired Order amount in units of the base |
| new_order.directionstringrequired Order direction enum buysell |
| new_order.instrument_namestringrequired Instrument name |
| new_order.limit_pricestringrequired Limit price in quote currency. This field is still required for market orders because it is a component of the signature. However, market orders will not leave a resting order in the book in case of a partial fill. |
| new_order.max_feestringrequired Max fee PER contract, denominated in USDC.Max fee must be > 2 x max(taker_fee, maker_fee) x spot_price + extra_fee / amount.If the order crosses the book, it must be >= 2 x max(taker_fee, maker_fee) x spot_price + base_fee / fill_amount + extra_fee / amount.Note, in this calculation, regardless of the account taker / maker fees, the standard taker / maker fees are used. |
| new_order.nonceintegerrequired Unique nonce defined as (UTC_timestamp in ms)(random_number_up_to_3_digits) (e.g. 1695836058725001, where 001 is the random number).Note, using a random number beyond 3 digits will cause JSON serialization to fail. |
| new_order.signaturestringrequired Ethereum signature of the order |
| new_order.signature_expiry_secintegerrequired Unix timestamp in seconds. Order signature becomes invalid after this time, and the system will cancel the order.Expiry MUST be at least 5 min from now. |
| new_order.signerstringrequired Owner wallet address or registered session key that signed order |
| new_order.subaccount_idintegerrequired Subaccount ID |
| new_order.clientstring Client that submitted the order |
| new_order.extra_feestring Extra fee in USDC added to the total final fee paid by user and directly sent to client / builder (must be between 0.000001 and 1000 USDC). The referral_code field must also be filled out. See Builder Fee page in docs for more info. |
| new_order.is_atomic_signingboolean Used by vaults to determine whether the signature is an EIP-1271 signature. |
| new_order.labelstring Optional user-defined label for the order |
| new_order.mmpboolean Whether the order is tagged for market maker protections (default false) |
| new_order.order_typestring Order type: - limit: limit order (default)- market: market order, note that limit_price is still required for market orders, but unfilled order portion will be marked as cancelledenum limitmarket |
| new_order.reduce_onlyboolean If true, the order will not be able to increase position's size (default false). If the order amount exceeds available position size, the order will be filled up to the position size and the remainder will be cancelled. This flag is only supported for market orders or non-resting limit orders (IOC or FOK) |
| new_order.referral_codestring Optional referral code for the order |
| new_order.reject_post_onlyboolean If true (default), post-only orders that would cross the book are rejected. If false, the limit price is adjusted to be 1 tick away from the BBO instead of rejecting. |
| new_order.reject_timestampinteger UTC timestamp in ms, if provided the matching engine will reject the order with an error if reject_timestamp < server_time. Note that the timestamp must be consistent with the server time: use public/get_time method to obtain current server time. |
| new_order.time_in_forcestring Time in force behaviour: - gtc: good til cancelled (default)- post_only: a limit order that will be rejected if it crosses any order in the book, i.e. acts as a taker order- fok: fill or kill, will be rejected if it is not fully filled- ioc: immediate or cancel, fill at best bid/ask (market) or at limit price (limit), the unfilled portion is cancelledNote that the order will still expire on the signature_expiry_sec timestamp.enum gtcpost_onlyfokioc |
| new_order.trigger_pricestring (Required for trigger orders) "index" or "mark" price to trigger order at |
| new_order.trigger_price_typestring (Required for trigger orders) Trigger with "mark" price as "index" price type not supported yet. enum markindex |
| new_order.trigger_typestring (Required for trigger orders) "stoploss" or "takeprofit" enum stoplosstakeprofit |
Response
| idstring or integerrequired |
| resultobjectrequired |
| result.ffi_cacheobjectrequired FFI cache - includes valuation timestamps, feeds, currencies, assets, instruments and mmps |
| result.ffi_resultobjectrequired FFI result |
| result.new_orderobjectrequired New order passed into ffi |
| result.open_ordersarray of objectsrequired Open orders passed into ffi |
| result.portfolioobjectrequired User portfolio which is sent to ffi |
| result.python_resultobjectrequired Python result |
Example
{request_example_shell}{request_example_javascript}{request_example_python}The above command returns JSON structured like this:
{response_example_json}