diff --git a/api.yaml b/api.yaml index 103372f..3c3106d 100644 --- a/api.yaml +++ b/api.yaml @@ -22279,6 +22279,198 @@ paths: responses: '202': description: Returns an acknowledgement that the action was received. Async process will kick off to perform trades to close out open positions. + content: + application/json: + schema: + $ref: '#/components/schemas/ClosePositionRequestResponse' + /api/prime/trading/v1/accounts/{accountID}/margin/positions/close/requests/{closePositionRequestID}: + get: + summary: Get close position request details + description: Get details of a specific close position request + operationId: trade.margin.positions.close.requests.get + tags: + - Margin + parameters: + - name: accountID + in: path + required: true + description: The ID of the account + schema: + type: string + - name: closePositionRequestID + in: path + required: true + description: The ID of the close position request + schema: + type: string + format: uuid + responses: + '200': + description: Close position request details + content: + application/json: + schema: + $ref: '#/components/schemas/ClosePositionRequestResponse' + /api/prime/trading/v1/accounts/{accountID}/margin/positions/close/requests/{closePositionRequestID}/orders: + get: + summary: List orders for close position request + description: List orders associated with a close position request + operationId: trade.margin.positions.close.requests.orders.list + tags: + - Margin + parameters: + - name: accountID + in: path + required: true + description: The ID of the account + schema: + type: string + - name: closePositionRequestID + in: path + required: true + description: The ID of the close position request + schema: + type: string + format: uuid + responses: + '200': + description: List of orders associated with the close position request + content: + application/json: + schema: + $ref: '#/components/schemas/ClosePositionRequestOrdersResponse' + /api/prime/trading/v1/accounts/{accountID}/margin/collateral/withdrawalrequests: + post: + summary: Create collateral withdrawal request + description: Create a collateral withdrawal request + operationId: trade.margin.collateral.withdrawalrequests.create + tags: + - Margin + parameters: + - name: accountID + in: path + required: true + description: The ID of the account + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - currency + - quantity + properties: + currency: + type: string + description: Currency symbol for withdrawal + quantity: + type: string + format: decimal + description: Amount to withdraw + example: + currency: BTC + quantity: '0.5' + responses: + '201': + description: Collateral withdrawal request created + content: + application/json: + schema: + $ref: '#/components/schemas/CollateralWithdrawalRequestResponse' + get: + summary: List collateral withdrawal requests + description: List all collateral withdrawal requests for an account + operationId: trade.margin.collateral.withdrawalrequests.list + tags: + - Margin + parameters: + - name: accountID + in: path + required: true + description: The ID of the account + schema: + type: string + - name: offset + in: query + required: false + description: Pagination offset + schema: + type: integer + default: 0 + - name: limit + in: query + required: false + description: Number of items per page + schema: + type: integer + default: 50 + maximum: 100 + responses: + '200': + description: List of collateral withdrawal requests + content: + application/json: + schema: + $ref: '#/components/schemas/CollateralWithdrawalRequestsResponse' + /api/prime/trading/v1/accounts/{accountID}/margin/collateral/withdrawalrequests/{requestID}: + get: + summary: Get collateral withdrawal request + description: Get details of a specific collateral withdrawal request + operationId: trade.margin.collateral.withdrawalrequests.get + tags: + - Margin + parameters: + - name: accountID + in: path + required: true + description: The ID of the account + schema: + type: string + - name: requestID + in: path + required: true + description: The ID of the withdrawal request + schema: + type: string + format: uuid + responses: + '200': + description: Collateral withdrawal request details + content: + application/json: + schema: + $ref: '#/components/schemas/CollateralWithdrawalRequestResponse' + /api/prime/trading/v1/accounts/{accountID}/margin/collateral/withdrawalrequests/{requestID}/cancel: + patch: + summary: Cancel collateral withdrawal request + description: Cancel a collateral withdrawal request + operationId: trade.margin.collateral.withdrawalrequests.cancel + tags: + - Margin + parameters: + - name: accountID + in: path + required: true + description: The ID of the account + schema: + type: string + - name: requestID + in: path + required: true + description: The ID of the withdrawal request + schema: + type: string + format: uuid + responses: + '200': + description: Updated collateral withdrawal request + content: + application/json: + schema: + $ref: '#/components/schemas/CollateralWithdrawalRequestResponse' /api/prime/trading/v1/ws: get: summary: Get WebSocket connection @@ -40275,6 +40467,123 @@ components: - apiSecret - clientAccountId - companyRegistrationNumber + ClosePositionOrderResponse: + type: object + required: + - orderId + - closePositionsRequestId + - currency + - side + - quantity + - status + - createdAt + properties: + orderId: + type: string + format: uuid + description: Unique identifier for the order + closePositionsRequestId: + type: string + format: uuid + description: Associated close position request ID + currency: + type: string + description: Currency symbol for the order + side: + $ref: '#/components/schemas/Side' + quantity: + type: string + format: decimal + description: Order quantity + filledQuantity: + type: string + format: decimal + description: Filled quantity + averagePrice: + type: string + format: decimal + description: Average fill price + status: + $ref: '#/components/schemas/OrderStatus' + createdAt: + type: string + format: date-time + description: Timestamp when the order was created + completedAt: + type: string + format: date-time + description: Timestamp when the order was completed + example: + orderId: c3d4e5f6-g7h8-9012-cdef-345678901234 + closePositionsRequestId: b2c3d4e5-f6g7-8901-bcde-f23456789012 + currency: BTC + side: sell + quantity: '0.5' + filledQuantity: '0.5' + averagePrice: '45000.00' + status: completed + createdAt: 2024-01-15T11:05:00.000Z + completedAt: 2024-01-15T11:06:00.000Z + ClosePositionRequestOrdersResponse: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/ClosePositionOrderResponse' + ClosePositionRequestResponse: + type: object + required: + - closePositionsRequestId + - status + - createdAt + properties: + closePositionsRequestId: + type: string + format: uuid + description: Unique identifier for the close position request + status: + type: string + enum: + - pending + - in_progress + - completed + - failed + - cancelled + description: Current status of the close position request + currencies: + type: array + items: + type: string + description: List of currencies to close positions for + all: + type: boolean + description: Whether to close all positions + createdAt: + type: string + format: date-time + description: Timestamp when the request was created + updatedAt: + type: string + format: date-time + description: Timestamp when the request was last updated + completedAt: + type: string + format: date-time + description: Timestamp when the request was completed + failureReason: + type: string + description: Reason for failure if status is failed + example: + closePositionsRequestId: b2c3d4e5-f6g7-8901-bcde-f23456789012 + status: pending + currencies: + - BTC + - ETH + createdAt: 2024-01-15T11:00:00.000Z + updatedAt: 2024-01-15T11:00:00.000Z ClosedByUnion: title: ClosedByUnion type: string @@ -40391,6 +40700,82 @@ components: type: string description: A description for the condition parameter Value which can be shown to an end user. example: A cold wallet + CollateralWithdrawalRequestResponse: + type: object + required: + - requestId + - currency + - quantity + - status + - createdAt + properties: + requestId: + type: string + format: uuid + description: Unique identifier for the withdrawal request + currency: + type: string + description: Currency symbol for the withdrawal + quantity: + type: string + format: decimal + description: Amount requested for withdrawal + status: + type: string + enum: + - pending + - approved + - rejected + - completed + - cancelled + description: Current status of the withdrawal request + createdAt: + type: string + format: date-time + description: Timestamp when the request was created + updatedAt: + type: string + format: date-time + description: Timestamp when the request was last updated + approvedAt: + type: string + format: date-time + description: Timestamp when the request was approved + completedAt: + type: string + format: date-time + description: Timestamp when the request was completed + rejectionReason: + type: string + description: Reason for rejection if status is rejected + example: + requestId: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + currency: BTC + quantity: '0.5' + status: pending + createdAt: 2024-01-15T10:30:00.000Z + updatedAt: 2024-01-15T10:30:00.000Z + CollateralWithdrawalRequestsResponse: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/CollateralWithdrawalRequestResponse' + pagination: + type: object + properties: + offset: + type: integer + description: Current offset for pagination + limit: + type: integer + description: Number of items per page + total: + type: integer + description: Total number of withdrawal requests CommitmentShare: type: object properties: