portfolios:write scope.
Inspect the schedule
GET /v2/portfolios/{portfolioId} returns the current schedule. The object
includes status, frequency, intervalMs, nextDueAt, and
lastRebalanceAt. A portfolio can have a null schedule.
Start or resume automation
nextDueAt. The scheduler can then run it on the next
cycle. A portfolio without a schedule returns 400.
Pause automation
Trigger one rebalance
202 and starts an asynchronous operation. A short cooldown
prevents duplicate manual triggers for the same portfolio.
Poll the operation
state is completed, failed, or
cancelled. Usually, the state changes from accepted to running and then
to a final state.
See the endpoint references for
start,
stop,
manual rebalance, and
operation status.
Operational guidance
- Keep API keys on your backend.
- Treat a rebalance as asynchronous. Poll the returned operation.
- Respect
Retry-Afterwhen manual rebalances return429. - Read the portfolio again after each change. Do not keep a separate schedule state in the client.
- Monitor failed operations before attempting another rebalance.