ALalpacahq
Rebalancing

Update Portfolio by ID

Updates a portfolio. If weights or conditions are changed, all subscribed accounts will be evaluated for rebalancing at the next opportunity (normal market hours). If a cooldown is active on the portfolio, the rebalancing will occur after the cooldown expired.

patch/v1/rebalancing/portfolios/{portfolio_id}

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/rebalancing/portfolios/{portfolio_id}
  • Auth
    HTTP basic

Request body

cooldown_daysinteger required

Used to update portfolio cooldown days.

descriptionstring

Used to update portfolio description.

namestring

Used to update portfolio name.

Example request

{
  "weights": [
    {
      "percent": "50"
    }
  ]
}

Response

The updated portfolio

cooldown_daysinteger required

Count of calendar days following a rebalance before a subscription is eligible to trigger another rebalance

created_atstring

Portfolio creation timestamp

descriptionstring

Text to describe portfolio

idstring

Portfolio ID

namestring

Name of portfolio

rebalancing_conditionsstring

Rebalancing conditions for portfolio

status'active' | 'inactive' | 'needs_adjustment'

Current status of portfolio

updated_atstring

Portfolio updated timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.