Skip to main content
PATCH
Adjust covered margin call amount

Authorizations

Authorization
string
header
required

Bearer token used for protected REST API requests.

Body

application/json

Covered margin-call payload. accountId, symbol, and amount are required.

Payload for setting covered margin call amount for an open position.

accountId
string
required

Trading account containing the position.

symbol
string
required

Position symbol.

amount
number
required

New covered margin-call amount. Must be zero or greater.

Required range: x >= 0

Response

Covered margin-call update result.

Response returned after covered margin call is changed.

status
string

success or failed.

message
string

Human-readable result.

accountId
string

Trading account id.

symbol
string

Position symbol.

amount
number

Requested covered margin amount.

newCoveredMarginCall
number

Covered margin call value after update.

maintenanceMargin
number

Maintenance margin after recalculation.

tradingPower
number

Trading power after recalculation.