Get Rebalance Status API
The Get Rebalance Status API allows you to check the status of an ongoing portfolio rebalancing operation. Monitor the progress of individual rebalance items (ticker allocations), view execution details, and track any failures.
Endpoint
GET /user/portfolios/{portfolioId}/rebalance/{rebalanceId}Authentication
All requests require the IdToken obtained from the authentication flow:
Authorization: Bearer <ID_TOKEN>
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| portfolioId | string | Yes | The portfolio ID (e.g., "default") |
| rebalanceId | string | Yes | The rebalance operation ID from Portfolio Rebalancer API |
Request Format
Request Body: No request body is required for this endpoint.
Response Format
| Field | Type | Description |
|---|---|---|
| message | string | Confirmation message |
| rebalanceId | string | Unique identifier for this rebalancing operation |
| status | string | Overall rebalance status (see Status Values below) |
| reason | string | Reason for status (e.g., why it was cancelled or suspended) |
| summary | object | Summary of rebalance progress with total, success, failed counts |
| items | array | Array of rebalance items with execution details |
Overall Rebalance Status:
| Status | Description |
|---|---|
| PENDING | Rebalancing is queued for execution |
| IN_PROGRESS | Rebalancing is currently executing |
| SCHEDULED | Rebalancing is scheduled for a future date/time |
| SUCCESS | All items have completed successfully |
| PARTIAL_SUCCESS | Some items completed successfully, some failed |
| FAILED | Rebalancing failed and did not execute any items |
Item-Level Status:
| Status | Description |
|---|---|
| PLANNED | Item is planned and waiting to execute |
| SUBMITTED | Item has been submitted to the broker |
| SUCCESS | Item execution completed successfully |
| FAILED | Item execution failed |
Execution Modes
| Mode | Description |
|---|---|
| IMMEDIATE | Rebalancing will execute immediately |
| SCHEDULED | Rebalancing is scheduled for a future date/time |