Ctrl+K

List close position requests

get/api/prime/trading/v1/accounts/{accountId}/margin/positions/close/requests

List all close position requests for an account with optional filters on status and creation date.

Path Parameters

  • accountIdstringRequired
    The ID of the account

Query Parameters

  • offsetintegerDefault: 0
    Pagination offset.
  • limitintegerDefault: 500
    Number of items per page.
    Maximum: <= 500
  • statusstring
    Filter by close position request status. Multiple statuses can be provided as comma-separated values.
    Enum: pending in_progress completed failed cancelled
  • dateGtestring<date-time>
    Return close position requests with a `creationDate` that is greater than or equal to the given timestamp.
  • dateLtstring<date-time>
    Return close position requests with a `creationDate` that is less than the given timestamp.

200 Response

data array[object] required
Example: {"closePositionsRequestId":"b2c3d4e5-f6g7-8901-bcde-f23456789012","accountId":"f230fdebfa084ffebc7e00515f54603f","enterpriseId":"a130kjebfa084ffebc7e00515f54603f","status":"pending","bitgoUserId":"user123","creationDate":"2024-01-15T11:00:00.000Z"}
closePositionsRequestId string <uuid>required
Unique identifier for the close position request
accountId string required
The ID of the account
enterpriseId string required
Enterprise ID associated with the request
status string required
Status of a close position request or order
Allowed values: pending in_progress completed failed
bitgoUserId string required
BitGo user ID who initiated the request
creationDate string <date-time>required
Timestamp when the request was created

default Response

error string required
errorName string required
reqId string required