What is net settlement?
Net settlement takes into account all trades that have been executed within a session. It nets the buy and sell trades per asset pair which will identify the total amount to be settled for the session.
What endpoints can Platforms use to fetch the net settlement amount?
Platforms may use the following endpoints to fetch the net settlement amount:
-
GET /positions -
GET /trades
Using GET /positions
To obtain the net settlement amount using the GET /positions endpoint, Platforms should:
-
Include the parameter
position_active_trades_only. This parameter will filter those trades which will be settled; and -
Query the endpoint after the cutoff (e.g., cutoff is 00:00:00 EST, hence Platform must query after 00:00:00 EST).
Using GET /trades
To fetch the net settlement amount using the GET /trades endpoint, Platforms should:
-
Include the parameter
trade_state=active. This parameter will filter trades with an active status; and -
Include trade session timing
transaction_timestamp[lt]=< trade session end time > &transaction_timestamp[gte]=< trade session start time >(e.g., trading session is 00:00:00 - 11:59:59 EST). Please note that the correct timestamp format is used.
For more details regarding API documentation, please visit our Web API page here.