---
title: "List All Runs."
method: GET
path: "/v1/rebalancing/runs"
tags: ["Rebalancing"]
---

# List All Runs.

`GET /v1/rebalancing/runs`

Lists runs.

## Query parameters

- `account_id` string
- `status` string
- `type` string
- `page_token` string
- `limit` string

## Response `200`

The runs which match the query

- object
  - `next_page_token` string, nullable, required — Use this token in your next API call to paginate through the dataset and retrieve the next page of results. A null token indicates there are no more data to fetch.
  - `runs` PortfolioRun[], required
    - `account_id` string — Account ID for given run
    - `canceled_at` string — RFC3339 format
    - `completed_at` string — RFC3339 format
    - `failed_orders` Order[] — Array of failed orders for this run
      - `asset_class` 'us_equity' | 'us_option' | 'crypto' | 'ipo' — This represents the category to which the asset belongs to. It serves to identify the nature of the financial instrument, with options including "us_equity" for U.S. equities, "us_option" for U.S. options, "crypto" for cryptocurrencies, and "ipo" for IPO indications of interest. This `asset_class: ipo` value is distinct from the assets API `attributes: ["ipo"]` flag.
      - `asset_id` string, uuid — The asset ID (For options this represents the option contract ID)
      - `cancel_requested_at` string, date-time, nullable — Time when cancellation or bust was requested (if applicable)
      - `canceled_at` string, date-time, nullable — Can be null
      - `client_order_id` string — Client unique order ID
      - `commission` string, decimal — The dollar value commission for this order.
      - `commission_bps` string, decimal — **deprecated**: Please use the commission_type = bps instead and set the desired bps value in the `commission` field. The percent commission you want to charge the end user on the order (expressed in bps). Alpaca will convert the order to a notional amount for purposes of calculating commission.
      - `commission_type` 'notional' | 'qty' | 'bps' — An enum to select how to interpret the value provided in the commission field. - notional: Charge commission on a per order basis. (When the `commission_type` field is omitted from the order request, this is used as the default). - qty: Charge commission on a per qty/contract basis, pro rated. - bps: The percent commission you want to charge the end user on the order (expressed in bps). Alpaca will convert the order to a notional amount for purposes of calculating commission. Commission value in bps can have up to two decimal places.
      - `created_at` string, date-time — Time when order was entered
      - `expired_at` string, date-time, nullable — Can be null
      - `extended_hours` boolean
      - `failed_at` string, date-time, nullable — Can be null
      - `filled_at` string, date-time, nullable — Time the order was filled. Can be null if not filled
      - `filled_avg_price` string, decimal, nullable — Filled average price. Can be 0 until order is processed in case order is passed outside of market hours
      - `filled_qty` string, decimal — Filled quantity
      - `hwm` string, decimal, nullable — The highest (lowest) market price seen since the trailing stop order was submitted.
      - `id` string, uuid, required — Order ID generated by Alpaca
      - `legs` OrderLeg[], nullable — When querying non-simple order_class orders in a nested style, an array of Order entities associated with this order. Otherwise, null.
        - `asset_class` 'us_equity' | 'us_option' | 'crypto' | 'ipo' — This represents the category to which the asset belongs to. It serves to identify the nature of the financial instrument, with options including "us_equity" for U.S. equities, "us_option" for U.S. options, "crypto" for cryptocurrencies, and "ipo" for IPO indications of interest. This `asset_class: ipo` value is distinct from the assets API `attributes: ["ipo"]` flag.
        - `asset_id` string, uuid — The asset ID (For options this represents the option contract ID)
        - `canceled_at` string, date-time, nullable — Can be null
        - `client_order_id` string — Client unique order ID
        - `commission` string, decimal — The dollar value commission you want to charge the end user.
        - `commission_bps` string, decimal — **deprecated**: Please use the commission_type = bps instead and set the desired bps value in the `commission` field. The percent commission you want to charge the end user on the order (expressed in bps). Alpaca will convert the order to a notional amount for purposes of calculating commission.
        - `commission_type` 'notional' | 'qty' | 'bps' — An enum to select how to interpret the value provided in the commission field. - notional: Charge commission on a per order basis. (When the `commission_type` field is omitted from the order request, this is used as the default). - qty: Charge commission on a per qty/contract basis, pro rated. - bps: The percent commission you want to charge the end user on the order (expressed in bps). Alpaca will convert the order to a notional amount for purposes of calculating commission. Commission value in bps can have up to two decimal places.
        - `created_at` string, date-time — Time when order was entered
        - `expired_at` string, date-time, nullable — Can be null
        - `extended_hours` boolean
        - `failed_at` string, date-time, nullable — Can be null
        - `filled_at` string, date-time, nullable — Time the order was filled. Can be null if not filled
        - `filled_avg_price` string, decimal, nullable — Filled average price. Can be 0 until order is processed in case order is passed outside of market hours
        - `filled_qty` string, decimal — Filled quantity
        - `hwm` string, decimal, nullable — The highest (lowest) market price seen since the trailing stop order was submitted.
        - `id` string, uuid, required — Order ID generated by Alpaca
        - `legs` object[], nullable — Always null for an order leg; legs are not nested beyond one level.
        - `limit_price` string, decimal, nullable — Limit price
        - `notional` string, decimal, nullable — Ordered notional amount. If entered, qty will be null. Can take up to 2 decimal points.
        - `order_class` 'simple' | 'bracket' | 'oco' | 'oto' | 'mleg' | '' — The order classes supported by Alpaca vary based on the order's security type. The following provides a comprehensive breakdown of the supported order classes for each category: - Equity trading: simple (or ""), oco, oto, bracket. - Options trading: - simple (or "") - mleg (required for multi-leg complex option strategies) - Crypto trading: simple (or "").
        - `order_type` 'market' | 'limit' | 'stop' | 'stop_limit' | 'trailing_stop' — The order types supported by Alpaca vary based on the order's security type. The following provides a comprehensive breakdown of the supported order types for each category: - Equity trading: market, limit, stop, stop_limit, trailing_stop. - Options trading: market, limit. - Options Multileg trading: market, limit. - Crypto trading: market, limit, stop_limit.
        - `position_intent` 'buy_to_open' | 'buy_to_close' | 'sell_to_open' | 'sell_to_close' — Represents the desired position strategy.
        - `qty` string, decimal, nullable — Ordered quantity. If entered, notional will be null. Can take up to 2 decimal points.
        - `replaced_at` string, date-time, nullable — Can be null
        - `replaced_by` string, uuid, nullable — The order ID that this order was replaced by. (Can be null)
        - `replaces` string, uuid, nullable — The order ID that this order replaces. (Can be null)
        - `side` 'buy' | 'sell' | 'buy_minus' | 'sell_plus' | 'sell_short' | 'sell_short_exempt' | 'undisclosed' | 'cross' | 'cross_short' — Represents what side of the transaction an order was on. Required for all order classes except for `mleg`.
        - `status` 'new' | 'partially_filled' | 'filled' | 'done_for_day' | 'canceled' | 'expired' | 'replaced' | 'pending_cancel' | 'pending_replace' | 'accepted' | 'pending_new' | 'accepted_for_bidding' | 'stopped' | 'rejected' | 'suspended' | 'calculated'
        - `stop_price` string, decimal, nullable — Stop price
        - `submitted_at` string, date-time — Time the order was submitted for execution or, if not yet submitted the created_at time. Because orders are submitted for execution asynchronous to database updates, at times this may be before the created_at time.
        - `swap_fee_bps` string — Fee in basis points on top swap rate charged by the correspondent on every order
        - `swap_rate` string — Swap rate is the exchange rate (without mark-up) used to convert the price into local currency or crypto asset
        - `symbol` string, required — The asset symbol
        - `time_in_force` 'day' | 'gtc' | 'opg' | 'cls' | 'ioc' | 'fok' — The Time-In-Force values supported by Alpaca vary based on the order's security type. Here is a breakdown of the supported TIFs for each specific security type: - Equity trading: day, gtc, opg, cls, ioc, fok. - Options trading: day. - Crypto trading: gtc, ioc. Below are the descriptions of each TIF: - day: A day order is eligible for execution only on the day it is live. By default, the order is only valid during Regular Trading Hours (9:30am - 4:00pm ET). If unfilled after the closing auction, it is automatically canceled. If submitted after the close, it is queued and submitted the following trading day. However, if marked as eligible for extended hours, the order can also execute during supported extended hours. - gtc: The order is good until canceled. Non-marketable GTC limit orders are subject to price adjustments to offset corporate actions affecting the issue. We do not currently support Do Not Reduce (DNR) orders to opt out of such price adjustments. - opg: Use this TIF with a market/limit order type to submit "market on open" (MOO) and "limit on open" (LOO) orders. This order is eligible to execute only in the market opening auction. Any unfilled orders after the open will be cancelled. OPG orders submitted after 9:28am but before 7:00pm ET will be rejected. OPG orders submitted after 7:00pm will be queued and routed to the following day's opening auction. On open/on close orders are routed to the primary exchange. Such orders do not necessarily execute exactly at 9:30am / 4:00pm ET but execute per the exchange's auction rules. - cls: Use this TIF with a market/limit order type to submit "market on close" (MOC) and "limit on close" (LOC) orders. This order is eligible to execute only in the market closing auction. Any unfilled orders after the close will be cancelled. CLS orders submitted after 3:50pm but before 7:00pm ET will be rejected. CLS orders submitted after 7:00pm will be queued and routed to the following day's closing auction. - ioc: An Immediate Or Cancel (IOC) order requires all or part of the order to be executed immediately. Any unfilled portion of the order is canceled. Most market makers who receive IOC orders will attempt to fill the order on a principal basis only, and cancel any unfilled balance. On occasion, this can result in the entire order being cancelled if the market maker does not have any existing inventory of the security in question. - fok: A Fill or Kill (FOK) order is only executed if the entire order quantity can be filled, otherwise the order is canceled.
        - `trail_percent` string, decimal, nullable — The percent value away from the high water mark for trailing stop orders.
        - `trail_price` string, decimal, nullable — The dollar value away from the high water mark for trailing stop orders.
        - `type` 'market' | 'limit' | 'stop' | 'stop_limit' | 'trailing_stop' — The order types supported by Alpaca vary based on the order's security type. The following provides a comprehensive breakdown of the supported order types for each category: - Equity trading: market, limit, stop, stop_limit, trailing_stop. - Options trading: market, limit. - Options Multileg trading: market, limit. - Crypto trading: market, limit, stop_limit.
        - `updated_at` string, date-time — Time of most recent change to the order
        - `usd` object — Nested object to encompass the USD equivalent fields for the local currency fields
      - `limit_price` string, decimal, nullable — Limit price
      - `notional` string, decimal, nullable — Ordered notional amount. If entered, qty will be null. Can take up to 2 decimal points.
      - `order_class` 'simple' | 'bracket' | 'oco' | 'oto' | 'mleg' | '' — The order classes supported by Alpaca vary based on the order's security type. The following provides a comprehensive breakdown of the supported order classes for each category: - Equity trading: simple (or ""), oco, oto, bracket. - Options trading: - simple (or "") - mleg (required for multi-leg complex option strategies) - Crypto trading: simple (or "").
      - `order_type` 'market' | 'limit' | 'stop' | 'stop_limit' | 'trailing_stop' — The order types supported by Alpaca vary based on the order's security type. The following provides a comprehensive breakdown of the supported order types for each category: - Equity trading: market, limit, stop, stop_limit, trailing_stop. - Options trading: market, limit. - Options Multileg trading: market, limit. - Crypto trading: market, limit, stop_limit.
      - `position_intent` 'buy_to_open' | 'buy_to_close' | 'sell_to_open' | 'sell_to_close' — Represents the desired position strategy.
      - `qty` string, decimal, nullable — Ordered quantity. If entered, notional will be null. Can take up to 2 decimal points.
      - `replaced_at` string, date-time, nullable — Can be null
      - `replaced_by` string, uuid, nullable — The order ID that this order was replaced by. (Can be null)
      - `replaces` string, uuid, nullable — The order ID that this order replaces. (Can be null)
      - `side` 'buy' | 'sell' | 'buy_minus' | 'sell_plus' | 'sell_short' | 'sell_short_exempt' | 'undisclosed' | 'cross' | 'cross_short' — Represents what side of the transaction an order was on. Required for all order classes except for `mleg`.
      - `status` 'new' | 'partially_filled' | 'filled' | 'done_for_day' | 'canceled' | 'expired' | 'replaced' | 'pending_cancel' | 'pending_replace' | 'accepted' | 'pending_new' | 'accepted_for_bidding' | 'stopped' | 'rejected' | 'suspended' | 'calculated'
      - `stop_price` string, decimal, nullable — Stop price
      - `submitted_at` string, date-time — Time the order was submitted for execution or, if not yet submitted the created_at time. Because orders are submitted for execution asynchronous to database updates, at times this may be before the created_at time.
      - `swap_fee_bps` string — Fee in basis points on top swap rate charged by the correspondent on every order
      - `swap_rate` string — Swap rate is the exchange rate (without mark-up) used to convert the price into local currency or crypto asset
      - `symbol` string, required — The asset symbol
      - `time_in_force` 'day' | 'gtc' | 'opg' | 'cls' | 'ioc' | 'fok' — The Time-In-Force values supported by Alpaca vary based on the order's security type. Here is a breakdown of the supported TIFs for each specific security type: - Equity trading: day, gtc, opg, cls, ioc, fok. - Options trading: day. - Crypto trading: gtc, ioc. Below are the descriptions of each TIF: - day: A day order is eligible for execution only on the day it is live. By default, the order is only valid during Regular Trading Hours (9:30am - 4:00pm ET). If unfilled after the closing auction, it is automatically canceled. If submitted after the close, it is queued and submitted the following trading day. However, if marked as eligible for extended hours, the order can also execute during supported extended hours. - gtc: The order is good until canceled. Non-marketable GTC limit orders are subject to price adjustments to offset corporate actions affecting the issue. We do not currently support Do Not Reduce (DNR) orders to opt out of such price adjustments. - opg: Use this TIF with a market/limit order type to submit "market on open" (MOO) and "limit on open" (LOO) orders. This order is eligible to execute only in the market opening auction. Any unfilled orders after the open will be cancelled. OPG orders submitted after 9:28am but before 7:00pm ET will be rejected. OPG orders submitted after 7:00pm will be queued and routed to the following day's opening auction. On open/on close orders are routed to the primary exchange. Such orders do not necessarily execute exactly at 9:30am / 4:00pm ET but execute per the exchange's auction rules. - cls: Use this TIF with a market/limit order type to submit "market on close" (MOC) and "limit on close" (LOC) orders. This order is eligible to execute only in the market closing auction. Any unfilled orders after the close will be cancelled. CLS orders submitted after 3:50pm but before 7:00pm ET will be rejected. CLS orders submitted after 7:00pm will be queued and routed to the following day's closing auction. - ioc: An Immediate Or Cancel (IOC) order requires all or part of the order to be executed immediately. Any unfilled portion of the order is canceled. Most market makers who receive IOC orders will attempt to fill the order on a principal basis only, and cancel any unfilled balance. On occasion, this can result in the entire order being cancelled if the market maker does not have any existing inventory of the security in question. - fok: A Fill or Kill (FOK) order is only executed if the entire order quantity can be filled, otherwise the order is canceled.
      - `trail_percent` string, decimal, nullable — The percent value away from the high water mark for trailing stop orders.
      - `trail_price` string, decimal, nullable — The dollar value away from the high water mark for trailing stop orders.
      - `type` 'market' | 'limit' | 'stop' | 'stop_limit' | 'trailing_stop' — The order types supported by Alpaca vary based on the order's security type. The following provides a comprehensive breakdown of the supported order types for each category: - Equity trading: market, limit, stop, stop_limit, trailing_stop. - Options trading: market, limit. - Options Multileg trading: market, limit. - Crypto trading: market, limit, stop_limit.
      - `updated_at` string, date-time — Time of most recent change to the order
      - `usd` object — Nested object to encompass the USD equivalent fields for the local currency fields
    - `id` string — Run ID
    - `initiated_from` 'system' | 'api' — system or api
    - `orders` Order[] — Array of executed orders for this run
      - `asset_class` 'us_equity' | 'us_option' | 'crypto' | 'ipo' — This represents the category to which the asset belongs to. It serves to identify the nature of the financial instrument, with options including "us_equity" for U.S. equities, "us_option" for U.S. options, "crypto" for cryptocurrencies, and "ipo" for IPO indications of interest. This `asset_class: ipo` value is distinct from the assets API `attributes: ["ipo"]` flag.
      - `asset_id` string, uuid — The asset ID (For options this represents the option contract ID)
      - `cancel_requested_at` string, date-time, nullable — Time when cancellation or bust was requested (if applicable)
      - `canceled_at` string, date-time, nullable — Can be null
      - `client_order_id` string — Client unique order ID
      - `commission` string, decimal — The dollar value commission for this order.
      - `commission_bps` string, decimal — **deprecated**: Please use the commission_type = bps instead and set the desired bps value in the `commission` field. The percent commission you want to charge the end user on the order (expressed in bps). Alpaca will convert the order to a notional amount for purposes of calculating commission.
      - `commission_type` 'notional' | 'qty' | 'bps' — An enum to select how to interpret the value provided in the commission field. - notional: Charge commission on a per order basis. (When the `commission_type` field is omitted from the order request, this is used as the default). - qty: Charge commission on a per qty/contract basis, pro rated. - bps: The percent commission you want to charge the end user on the order (expressed in bps). Alpaca will convert the order to a notional amount for purposes of calculating commission. Commission value in bps can have up to two decimal places.
      - `created_at` string, date-time — Time when order was entered
      - `expired_at` string, date-time, nullable — Can be null
      - `extended_hours` boolean
      - `failed_at` string, date-time, nullable — Can be null
      - `filled_at` string, date-time, nullable — Time the order was filled. Can be null if not filled
      - `filled_avg_price` string, decimal, nullable — Filled average price. Can be 0 until order is processed in case order is passed outside of market hours
      - `filled_qty` string, decimal — Filled quantity
      - `hwm` string, decimal, nullable — The highest (lowest) market price seen since the trailing stop order was submitted.
      - `id` string, uuid, required — Order ID generated by Alpaca
      - `legs` OrderLeg[], nullable — When querying non-simple order_class orders in a nested style, an array of Order entities associated with this order. Otherwise, null.
        - `asset_class` 'us_equity' | 'us_option' | 'crypto' | 'ipo' — This represents the category to which the asset belongs to. It serves to identify the nature of the financial instrument, with options including "us_equity" for U.S. equities, "us_option" for U.S. options, "crypto" for cryptocurrencies, and "ipo" for IPO indications of interest. This `asset_class: ipo` value is distinct from the assets API `attributes: ["ipo"]` flag.
        - `asset_id` string, uuid — The asset ID (For options this represents the option contract ID)
        - `canceled_at` string, date-time, nullable — Can be null
        - `client_order_id` string — Client unique order ID
        - `commission` string, decimal — The dollar value commission you want to charge the end user.
        - `commission_bps` string, decimal — **deprecated**: Please use the commission_type = bps instead and set the desired bps value in the `commission` field. The percent commission you want to charge the end user on the order (expressed in bps). Alpaca will convert the order to a notional amount for purposes of calculating commission.
        - `commission_type` 'notional' | 'qty' | 'bps' — An enum to select how to interpret the value provided in the commission field. - notional: Charge commission on a per order basis. (When the `commission_type` field is omitted from the order request, this is used as the default). - qty: Charge commission on a per qty/contract basis, pro rated. - bps: The percent commission you want to charge the end user on the order (expressed in bps). Alpaca will convert the order to a notional amount for purposes of calculating commission. Commission value in bps can have up to two decimal places.
        - `created_at` string, date-time — Time when order was entered
        - `expired_at` string, date-time, nullable — Can be null
        - `extended_hours` boolean
        - `failed_at` string, date-time, nullable — Can be null
        - `filled_at` string, date-time, nullable — Time the order was filled. Can be null if not filled
        - `filled_avg_price` string, decimal, nullable — Filled average price. Can be 0 until order is processed in case order is passed outside of market hours
        - `filled_qty` string, decimal — Filled quantity
        - `hwm` string, decimal, nullable — The highest (lowest) market price seen since the trailing stop order was submitted.
        - `id` string, uuid, required — Order ID generated by Alpaca
        - `legs` object[], nullable — Always null for an order leg; legs are not nested beyond one level.
        - `limit_price` string, decimal, nullable — Limit price
        - `notional` string, decimal, nullable — Ordered notional amount. If entered, qty will be null. Can take up to 2 decimal points.
        - `order_class` 'simple' | 'bracket' | 'oco' | 'oto' | 'mleg' | '' — The order classes supported by Alpaca vary based on the order's security type. The following provides a comprehensive breakdown of the supported order classes for each category: - Equity trading: simple (or ""), oco, oto, bracket. - Options trading: - simple (or "") - mleg (required for multi-leg complex option strategies) - Crypto trading: simple (or "").
        - `order_type` 'market' | 'limit' | 'stop' | 'stop_limit' | 'trailing_stop' — The order types supported by Alpaca vary based on the order's security type. The following provides a comprehensive breakdown of the supported order types for each category: - Equity trading: market, limit, stop, stop_limit, trailing_stop. - Options trading: market, limit. - Options Multileg trading: market, limit. - Crypto trading: market, limit, stop_limit.
        - `position_intent` 'buy_to_open' | 'buy_to_close' | 'sell_to_open' | 'sell_to_close' — Represents the desired position strategy.
        - `qty` string, decimal, nullable — Ordered quantity. If entered, notional will be null. Can take up to 2 decimal points.
        - `replaced_at` string, date-time, nullable — Can be null
        - `replaced_by` string, uuid, nullable — The order ID that this order was replaced by. (Can be null)
        - `replaces` string, uuid, nullable — The order ID that this order replaces. (Can be null)
        - `side` 'buy' | 'sell' | 'buy_minus' | 'sell_plus' | 'sell_short' | 'sell_short_exempt' | 'undisclosed' | 'cross' | 'cross_short' — Represents what side of the transaction an order was on. Required for all order classes except for `mleg`.
        - `status` 'new' | 'partially_filled' | 'filled' | 'done_for_day' | 'canceled' | 'expired' | 'replaced' | 'pending_cancel' | 'pending_replace' | 'accepted' | 'pending_new' | 'accepted_for_bidding' | 'stopped' | 'rejected' | 'suspended' | 'calculated'
        - `stop_price` string, decimal, nullable — Stop price
        - `submitted_at` string, date-time — Time the order was submitted for execution or, if not yet submitted the created_at time. Because orders are submitted for execution asynchronous to database updates, at times this may be before the created_at time.
        - `swap_fee_bps` string — Fee in basis points on top swap rate charged by the correspondent on every order
        - `swap_rate` string — Swap rate is the exchange rate (without mark-up) used to convert the price into local currency or crypto asset
        - `symbol` string, required — The asset symbol
        - `time_in_force` 'day' | 'gtc' | 'opg' | 'cls' | 'ioc' | 'fok' — The Time-In-Force values supported by Alpaca vary based on the order's security type. Here is a breakdown of the supported TIFs for each specific security type: - Equity trading: day, gtc, opg, cls, ioc, fok. - Options trading: day. - Crypto trading: gtc, ioc. Below are the descriptions of each TIF: - day: A day order is eligible for execution only on the day it is live. By default, the order is only valid during Regular Trading Hours (9:30am - 4:00pm ET). If unfilled after the closing auction, it is automatically canceled. If submitted after the close, it is queued and submitted the following trading day. However, if marked as eligible for extended hours, the order can also execute during supported extended hours. - gtc: The order is good until canceled. Non-marketable GTC limit orders are subject to price adjustments to offset corporate actions affecting the issue. We do not currently support Do Not Reduce (DNR) orders to opt out of such price adjustments. - opg: Use this TIF with a market/limit order type to submit "market on open" (MOO) and "limit on open" (LOO) orders. This order is eligible to execute only in the market opening auction. Any unfilled orders after the open will be cancelled. OPG orders submitted after 9:28am but before 7:00pm ET will be rejected. OPG orders submitted after 7:00pm will be queued and routed to the following day's opening auction. On open/on close orders are routed to the primary exchange. Such orders do not necessarily execute exactly at 9:30am / 4:00pm ET but execute per the exchange's auction rules. - cls: Use this TIF with a market/limit order type to submit "market on close" (MOC) and "limit on close" (LOC) orders. This order is eligible to execute only in the market closing auction. Any unfilled orders after the close will be cancelled. CLS orders submitted after 3:50pm but before 7:00pm ET will be rejected. CLS orders submitted after 7:00pm will be queued and routed to the following day's closing auction. - ioc: An Immediate Or Cancel (IOC) order requires all or part of the order to be executed immediately. Any unfilled portion of the order is canceled. Most market makers who receive IOC orders will attempt to fill the order on a principal basis only, and cancel any unfilled balance. On occasion, this can result in the entire order being cancelled if the market maker does not have any existing inventory of the security in question. - fok: A Fill or Kill (FOK) order is only executed if the entire order quantity can be filled, otherwise the order is canceled.
        - `trail_percent` string, decimal, nullable — The percent value away from the high water mark for trailing stop orders.
        - `trail_price` string, decimal, nullable — The dollar value away from the high water mark for trailing stop orders.
        - `type` 'market' | 'limit' | 'stop' | 'stop_limit' | 'trailing_stop' — The order types supported by Alpaca vary based on the order's security type. The following provides a comprehensive breakdown of the supported order types for each category: - Equity trading: market, limit, stop, stop_limit, trailing_stop. - Options trading: market, limit. - Options Multileg trading: market, limit. - Crypto trading: market, limit, stop_limit.
        - `updated_at` string, date-time — Time of most recent change to the order
        - `usd` object — Nested object to encompass the USD equivalent fields for the local currency fields
      - `limit_price` string, decimal, nullable — Limit price
      - `notional` string, decimal, nullable — Ordered notional amount. If entered, qty will be null. Can take up to 2 decimal points.
      - `order_class` 'simple' | 'bracket' | 'oco' | 'oto' | 'mleg' | '' — The order classes supported by Alpaca vary based on the order's security type. The following provides a comprehensive breakdown of the supported order classes for each category: - Equity trading: simple (or ""), oco, oto, bracket. - Options trading: - simple (or "") - mleg (required for multi-leg complex option strategies) - Crypto trading: simple (or "").
      - `order_type` 'market' | 'limit' | 'stop' | 'stop_limit' | 'trailing_stop' — The order types supported by Alpaca vary based on the order's security type. The following provides a comprehensive breakdown of the supported order types for each category: - Equity trading: market, limit, stop, stop_limit, trailing_stop. - Options trading: market, limit. - Options Multileg trading: market, limit. - Crypto trading: market, limit, stop_limit.
      - `position_intent` 'buy_to_open' | 'buy_to_close' | 'sell_to_open' | 'sell_to_close' — Represents the desired position strategy.
      - `qty` string, decimal, nullable — Ordered quantity. If entered, notional will be null. Can take up to 2 decimal points.
      - `replaced_at` string, date-time, nullable — Can be null
      - `replaced_by` string, uuid, nullable — The order ID that this order was replaced by. (Can be null)
      - `replaces` string, uuid, nullable — The order ID that this order replaces. (Can be null)
      - `side` 'buy' | 'sell' | 'buy_minus' | 'sell_plus' | 'sell_short' | 'sell_short_exempt' | 'undisclosed' | 'cross' | 'cross_short' — Represents what side of the transaction an order was on. Required for all order classes except for `mleg`.
      - `status` 'new' | 'partially_filled' | 'filled' | 'done_for_day' | 'canceled' | 'expired' | 'replaced' | 'pending_cancel' | 'pending_replace' | 'accepted' | 'pending_new' | 'accepted_for_bidding' | 'stopped' | 'rejected' | 'suspended' | 'calculated'
      - `stop_price` string, decimal, nullable — Stop price
      - `submitted_at` string, date-time — Time the order was submitted for execution or, if not yet submitted the created_at time. Because orders are submitted for execution asynchronous to database updates, at times this may be before the created_at time.
      - `swap_fee_bps` string — Fee in basis points on top swap rate charged by the correspondent on every order
      - `swap_rate` string — Swap rate is the exchange rate (without mark-up) used to convert the price into local currency or crypto asset
      - `symbol` string, required — The asset symbol
      - `time_in_force` 'day' | 'gtc' | 'opg' | 'cls' | 'ioc' | 'fok' — The Time-In-Force values supported by Alpaca vary based on the order's security type. Here is a breakdown of the supported TIFs for each specific security type: - Equity trading: day, gtc, opg, cls, ioc, fok. - Options trading: day. - Crypto trading: gtc, ioc. Below are the descriptions of each TIF: - day: A day order is eligible for execution only on the day it is live. By default, the order is only valid during Regular Trading Hours (9:30am - 4:00pm ET). If unfilled after the closing auction, it is automatically canceled. If submitted after the close, it is queued and submitted the following trading day. However, if marked as eligible for extended hours, the order can also execute during supported extended hours. - gtc: The order is good until canceled. Non-marketable GTC limit orders are subject to price adjustments to offset corporate actions affecting the issue. We do not currently support Do Not Reduce (DNR) orders to opt out of such price adjustments. - opg: Use this TIF with a market/limit order type to submit "market on open" (MOO) and "limit on open" (LOO) orders. This order is eligible to execute only in the market opening auction. Any unfilled orders after the open will be cancelled. OPG orders submitted after 9:28am but before 7:00pm ET will be rejected. OPG orders submitted after 7:00pm will be queued and routed to the following day's opening auction. On open/on close orders are routed to the primary exchange. Such orders do not necessarily execute exactly at 9:30am / 4:00pm ET but execute per the exchange's auction rules. - cls: Use this TIF with a market/limit order type to submit "market on close" (MOC) and "limit on close" (LOC) orders. This order is eligible to execute only in the market closing auction. Any unfilled orders after the close will be cancelled. CLS orders submitted after 3:50pm but before 7:00pm ET will be rejected. CLS orders submitted after 7:00pm will be queued and routed to the following day's closing auction. - ioc: An Immediate Or Cancel (IOC) order requires all or part of the order to be executed immediately. Any unfilled portion of the order is canceled. Most market makers who receive IOC orders will attempt to fill the order on a principal basis only, and cancel any unfilled balance. On occasion, this can result in the entire order being cancelled if the market maker does not have any existing inventory of the security in question. - fok: A Fill or Kill (FOK) order is only executed if the entire order quantity can be filled, otherwise the order is canceled.
      - `trail_percent` string, decimal, nullable — The percent value away from the high water mark for trailing stop orders.
      - `trail_price` string, decimal, nullable — The dollar value away from the high water mark for trailing stop orders.
      - `type` 'market' | 'limit' | 'stop' | 'stop_limit' | 'trailing_stop' — The order types supported by Alpaca vary based on the order's security type. The following provides a comprehensive breakdown of the supported order types for each category: - Equity trading: market, limit, stop, stop_limit, trailing_stop. - Options trading: market, limit. - Options Multileg trading: market, limit. - Crypto trading: market, limit, stop_limit.
      - `updated_at` string, date-time — Time of most recent change to the order
      - `usd` object — Nested object to encompass the USD equivalent fields for the local currency fields
    - `portfolio_id` string — Portfolio ID for given run
    - `reason` string — Explainer text in case of failed runs
    - `skipped_orders` SkippedOrder[] — Array of skipped order for this run
      - `currency` string — Currency of the order
      - `notional` string — Notional value of the order
      - `reason` string, required — Reason for the order being skipped
      - `reason_details` string, required — Formatted error message with the cause of the skip
      - `side` string — Side of the order (buy, sell, sell_short)
      - `symbol` string, required — Symbol for which the adjustment was skipped
    - `status` 'QUEUED' | 'IN_PROGRESS' | 'CANCELED' | 'CANCELED_MID_RUN' | 'ERROR' | 'TIMEOUT' | 'COMPLETED_ADJUSTED' | 'COMPLETED_SUCCESS' — | Status | Final | Represented State | Notes | |:------------------:|:-----:|:--------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------:| | QUEUED | No | The run has been queued, waiting for our system to process it. | Runs only executed when the US market is open and there's at least 15 minutes before the market closes. | | IN_PROGRESS | No | Portfolio adjustment is in progress. | | | CANCELED | Yes | Portfolio run canceled, before being picked up by Alpaca's background processing | | | CANCELED_MID_RUN | Yes | Portfolio run canceled while executing. | The portfolio's state is in between the pre-run and post-run state, manual remediation or job re-run is recommended. | | ERROR | Yes | There was an error while rebalancing the portfolio. | The portfolio's state is in between the pre-run and post-run state, manual remediation or job re-run is recommended. | | TIMEOUT | Yes | A timeout occurred while rebalancing the portfolio. | The portfolio's state is in between the pre-run and post-run state, manual remediation or job re-run is recommended. | | COMPLETED_ADJUSTED | Yes | The portfolio has been adjusted | The adjustments have been prepared, but the run details haven't yet updated with the list of resulting orders | | COMPLETED_SUCCESS | Yes | The portfolio has been adjusted, run status updated | |
    - `type` 'full_rebalance' | 'invest_cash' — full_rebalance or invest_cash
    - `updated_at` string — RFC3339 format
    - `weights` PortfolioWeights[] — Considered weighting for this run
      - `percent` string — Must be a positive value, up to two decimal places
      - `symbol` string — Must be fractionable asset. Only provided if type = "asset"
      - `type` string — Possible values of cash or asset

---

[API](https://skmtc.net/alpacahq/apis/gift-city-extensions-api.md) · [All operations](https://skmtc.net/alpacahq/apis/gift-city-extensions-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/alpacahq/gift-city-extensions-api/revisions/62e3378bb273/schema)