futures

Close (or partially reduce) a mock futures position

Requires scope trade:futures. idempotencyKey is REQUIRED. fraction in (0,1] reduces partially; omit (or 1) for a full close. If the mark has crossed liquidation, the whole position settles as a liquidation regardless of fraction.

post/api/agent/futures/close

Request

  • Base URL: https://api.coinrithm.com
  • URL: https://api.coinrithm.com/api/agent/futures/close
  • Auth: HTTP bearer

Request body

positionIdinteger required
fractionnumber

(0,1] portion to close. Omit or 1 = full close.

idempotencyKeystring required

Response

Closed / reduced / liquidated (or idempotent replay)

idempotentReplayboolean

present (true) on a replay

Changes

No recorded changes to this operation across all 1 revision of this API.