/v1/accounts/{accountId}/execution/positions/{positionId}/closePOSTAuthorization
bearerAuth *Bearer <token>
Token in: header
Path Parameters
accountId *string
Min length:
1positionId *string
Pattern:
^(?:0|[1-9][0-9]*)$Header Parameters
idempotency-key *string
Min length:
1Max length: 128Request Body
application/jsonrequiredclientOrderId *string
Caller-defined execution identity, unique within a connected account.
Pattern:
^[A-Za-z0-9._:-]+$Min length: 1Max length: 31volume?string
Pattern:
^-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$deviationPoints?integer
Default:
20Min: 0Max: 10000fillPolicy?"auto" | "fok" | "ioc" | "return"
Default:
"auto"Response
200 · The broker command reached a confirmed terminal outcome
commandId *string (uuid)
operation *"order.submit" | "order.modify" | "order.cancel" | "position.modify" | "position.close"
outcome *"accepted" | "rejected" | "commit_unknown" | "unresolved"
status *"placed" | "filled" | "partially_filled" | "canceled" | "expired" | "modified" | "rejected" | "unknown"
retcode *integernull
retcodeExternal *integernull
retcodeDescription *string
orderId?string
Pattern:
^(?:0|[1-9][0-9]*)$dealId?string
Pattern:
^(?:0|[1-9][0-9]*)$positionId?string
Pattern:
^(?:0|[1-9][0-9]*)$clientOrderId?string
Caller-defined execution identity, unique within a connected account.
Pattern:
^[A-Za-z0-9._:-]+$Min length: 1Max length: 31volume *string
Pattern:
^-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$price *string
Pattern:
^-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$bid?string
Pattern:
^-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$ask?string
Pattern:
^-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$recovered *boolean
observedAt *string (date-time)
latencyMs *number
Min:
0202 · The broker commit is not yet known and can be reconciled by command ID
commandId *string (uuid)
operation *"order.submit" | "order.modify" | "order.cancel" | "position.modify" | "position.close"
outcome *"accepted" | "rejected" | "commit_unknown" | "unresolved"
status *"placed" | "filled" | "partially_filled" | "canceled" | "expired" | "modified" | "rejected" | "unknown"
retcode *integernull
retcodeExternal *integernull
retcodeDescription *string
orderId?string
Pattern:
^(?:0|[1-9][0-9]*)$dealId?string
Pattern:
^(?:0|[1-9][0-9]*)$positionId?string
Pattern:
^(?:0|[1-9][0-9]*)$clientOrderId?string
Caller-defined execution identity, unique within a connected account.
Pattern:
^[A-Za-z0-9._:-]+$Min length: 1Max length: 31volume *string
Pattern:
^-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$price *string
Pattern:
^-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$bid?string
Pattern:
^-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$ask?string
Pattern:
^-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$recovered *boolean
observedAt *string (date-time)
latencyMs *number
Min:
0400 · Invalid request
error *object | object
401 · Invalid API key
error *object | object
403 · Insufficient API key scope or connected account slot limit
error *object | object
404 · Resource not found
error *object | object
409 · Account is not active
error *object | object
413 · Request body too large
error *object | object
422 · The broker or terminal rejected the operation
error *object | object
429 · Rate limit exceeded
error *object | object
500 · Unexpected failure
error *object | object
503 · Capacity exhausted, upstream unavailable, or history coverage unsettled
error *object | object
504 · Upstream request timed out
error *object | object
Request example
curl -X POST "https://api.fivesocket.com/v1/accounts/<accountId>/execution/positions/<positionId>/close" \ -H "idempotency-key: <idempotency-key>" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{ "clientOrderId": "string", "volume": "string", "deviationPoints": 20, "fillPolicy": "auto" }'