ALalpacahq
Rebalancing

List All Runs.

Lists runs.

get/v1/rebalancing/runs

Request

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

Query parameters

account_idstring

Any runs for this account_id will be returned

statusstring

Status of portfolio run to filter by

typestring

Type of portfolio run (full_rebalance, invest_cash)

page_tokeninteger
Example:100

Offset into the result set for pagination. Defaults to 0 when omitted.

limitinteger
Example:100

Maximum number of runs to return. Defaults to 100.

Response

The runs which match the query

next_page_tokeninteger nullable required

Offset to use as the next page_token, or null when there are no more runs. Set only when the page is full (result count equals the requested limit).

Example response

{
  "next_page_token": 100,
  "runs": [
    {
      "account_id": "4db36989-6565-4011-9126-39fe6b3d9bf6",
      "id": "0f9e8a7b-1c2d-4e3f-9a0b-1c2d3e4f5a6b",
      "initiated_from": "api",
      "portfolio_id": "9b2c1d4e-8f7a-4c3b-9d2e-1f0a8b7c6d5e",
      "status": "COMPLETED_SUCCESS",
      "type": "full_rebalance",
      "updated_at": "2025-01-15T16:30:00Z"
    }
  ]
}

Changes

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