Skip to main content
Alpaca logo
  • Category: commerce
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 100
  • Triggers: 0
  • Slug: ALPACA
  • Version: 20261101_00

Tools

Slug: ALPACA_ADD_ASSET_TO_WATCHLISTAdds a ticker symbol to an existing watchlist identified by ID, for tracking a security. With Alpaca’s standard live API configuration, the target is the paper account’s watchlist.

Input Parameters

string
required
The ticker symbol to add to the watchlist (e.g., ‘AAPL’, ‘TSLA’, ‘MSFT’).
string
required
The unique identifier of the watchlist to add the symbol to (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_ADD_ASSET_TO_WATCHLIST_BY_NAMEAdd an asset to a watchlist by name. Use when you need to add a symbol to a specific watchlist identified by its name. If a watchlist with the specified name does not exist, it will be created automatically and the symbol will be added to it. The asset will be appended to the end of the watchlist’s asset list.

Input Parameters

string
required
Name of the watchlist. If a watchlist with this name does not exist, it will be created.
string
required
Symbol to add to the watchlist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_CREATE_WATCHLISTCreates a new watchlist for the authenticated account. Use this action when you need to: - Create a new watchlist to track specific securities - Set up initial symbols for a watchlist at creation time - Organize tracked symbols under a named watchlist Note: This action creates a watchlist at the account level (using v2 API). The name must be unique within the account and contain only alphanumeric characters, spaces, hyphens, and underscores (up to 64 characters).

Input Parameters

string
required
The watchlist name (up to 64 characters). The name must contain only alphanumeric characters, spaces, hyphens, and underscores.
array
List of ticker symbols to include in the watchlist. Symbols can be added or removed later.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_CREATE_WATCHLIST_FOR_ACCOUNTCreates a watchlist for the authenticated account using the supplied name and symbols. An account ID is required as input but does not select the account.

Input Parameters

string
required
The watchlist name
array
required
The new list of symbol names to watch
string
required
Unique identifier of an account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_DELETE_ALL_OPEN_POSITIONSLiquidates all open positions at market, with an option to cancel open orders first. Results report individual liquidation attempts; partial success is possible. With Alpaca’s standard live API configuration, the target is the paper account.

Input Parameters

boolean
If true is specified, cancel all open orders before liquidating all positions. Use this when you want a clean liquidation without worrying about new orders filling during the liquidation process.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_DELETE_ALL_ORDERS_FOR_ACCOUNTAttempts to cancel all open orders for a specified trading account and returns per-order results when provided. A 404 response is returned as an empty results list with HTTP status 404; successfully cancelled orders cannot be restored.

Input Parameters

string
required
The unique identifier of the trading account. Orders will be cancelled for this account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_DELETE_UNSUBSCRIBE_ACCOUNTDelete a rebalancing subscription to unsubscribe an account. This action permanently removes the specified subscription. Use when you need to unsubscribe an account from rebalancing services. This action is irreversible once executed. Note: If the subscription_id is invalid, a 400 error is returned. If the subscription does not exist, a 404 error is returned.

Input Parameters

string
required
The unique identifier of the rebalancing subscription to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_DELETE_WATCHLIST_BY_IDDelete a watchlist by its unique identifier. Use when you need to remove an entire watchlist that is no longer needed. This action is irreversible once executed — the watchlist and all its contents cannot be recovered. Note: If the watchlist_id is invalid or does not exist, a 404 error is returned.

Input Parameters

string
required
The unique identifier of the watchlist to delete (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_ACCOUNTRetrieves account information for the authenticated Alpaca account. Use this action when you need to check account status, available buying power, cash balance, equity, margin information, day trade count, or other account details. This is a read-only operation that returns the current state of the authenticated account. The response includes important account flags such as trading_blocked, account_blocked, pattern_day_trader, and shorting_enabled which indicate any restrictions on the account’s trading capabilities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_ACCOUNT_ACTIVITIESRetrieves account activities for the authenticated Alpaca account. Use this action when you need to retrieve transaction history, dividend payments, interest payments, fees, transfers, or other account-related activities. Supports filtering by date range, account ID, and sorting direction. Results are paginated using page_token for efficient retrieval of large datasets.

Input Parameters

string
Date filter in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format. Returns activities on this specific date. Cannot be used with ‘after’ parameter.
string
Start date filter in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format. Cannot be used with ‘date’ parameter.
string
End date filter in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format. Returns activities up to this date.
string ("asc" | "desc")
Sort direction for activity results.
integer
Maximum number of activities to return in the response (1-1000, default 25).
string
ID of a single account to filter by. If not provided, returns activities for all accounts.
string
Activity ID of the end of your current page of results. Use for pagination to retrieve subsequent pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_ACCOUNT_ACTIVITIES2Retrieves account activities for the authenticated Alpaca account using the v2 API, including trade fills and non-trade activities. Supports date range and activity type filters, sorting, and page-token pagination; multiple activity types can be requested.

Input Parameters

string
The date for which you want to see activities. Format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ. Cannot be used with ‘after’ parameter.
string
The response will contain only activities submitted after this date. Cannot be used with ‘date’ parameter.
string
The response will contain only activities submitted before this date. Cannot be used with ‘date’ parameter.
string ("asc" | "desc")
Sort direction for activity results.
integer
The maximum number of entries to return in the response (1-10000, default 25).
string
The ID of the end of your current page of results. Use for pagination.
string
A comma-separated list of the activity types to include in the response. If unspecified, activities of all types will be returned. Valid types: transfer, div, int, fee, comm, interest, other, JNLC, JNLS, FILL, ACATS, CSD, CSW, ESIGN.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_ACCOUNT_ACTIVITIES_BY_ACTIVITY_TYPERetrieves account activities of a specific type for the authenticated Alpaca account. Use when you need to filter account activities by a specific type such as trade fills, dividends, interest payments, fees, or transfers. Supports date range filtering, pagination, and sorting. This endpoint is useful for retrieving a specific category of account transactions rather than all activities. Note: date parameter cannot be used with ‘after’ parameter. Use ‘date’ for a single day or ‘until’/‘after’ for date ranges.

Input Parameters

string
The date for which you want to see activities in YYYY-MM-DD format. Cannot be used with ‘after’ parameter.
string
Start date filter. The response will contain only activities submitted after this date in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format. Cannot be used with ‘date’ parameter.
string
End date filter. The response will contain only activities submitted before this date in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format. Cannot be used with ‘date’ parameter.
string ("asc" | "desc")
Sort direction for activity results.
integer
The maximum number of entries to return in the response (default 25).
string
The ID of the end of your current page of results for pagination.
string ("FILL" | "TRANSFER" | "DIV" | "INT" | "FEE" | "COMM" | "INTEREST" | "OTHER" | "JNLC" | "JNLS" | "ACATS" | "CASH_IN" | "CASH_OUT" | "ASSIGN" | "EXER")
required
The activity type to filter by. Common types include: FILL (trade executions), TRANSFER, DIV (dividends), INT (interest), FEE, COMM (commissions), INTEREST, JNLC (journal long), JNLS (journal short), ASSIGN, EXER, ACATS, CASH_IN, CASH_OUT.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_ACCOUNT_CONFIGRetrieves the current trading account configuration settings for the authenticated Alpaca account. Use this action when you need to check the current trading account settings such as day-trading margin call (DTMC) checks, fractional trading status, shorting permissions, trade suspension status, and trade confirmation email preferences. This is a read-only operation that returns the current configuration without any modifications. The account is determined from the authentication credentials.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_ACCOUNT_PORTFOLIO_HISTORYRetrieves the portfolio history statistics for an Alpaca trading account. Portfolio history provides a time series of equity values, profit/loss metrics, and other performance data over a specified time period. Use when you need to analyze account performance over time, track equity curves, or review historical P&L. Note: The timeframe parameter auto-selects based on the period: 1Min for <7 days, 15Min for <30 days, or 1D otherwise.

Input Parameters

string ("1D" | "1W" | "1M" | "3M" | "6M" | "1A")
Duration of portfolio history data.
string
End date for the data in YYYY-MM-DD format. Defaults to current market date.
string ("1Min" | "5Min" | "15Min" | "1H" | "1D")
Time resolution for portfolio history data points.
boolean
If true, include extended hours in results. Only effective for timeframe less than 1D.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_ACCOUNT_PORTFOLIO_HISTORY1Retrieves the portfolio history statistics for a trading account. Portfolio history provides a time series of equity values, profit/loss metrics, and optionally cashflow data over a specified time period. Use when you need to analyze account performance over time, track equity curves, or review historical P&L. Note: The timeframe parameter auto-selects based on the period: 1Min for <7 days, 15Min for <30 days, or 1D otherwise.

Input Parameters

string
End timestamp in RFC3339 format (e.g., 2024-01-15T16:00:00Z).
string
Start timestamp in RFC3339 format (e.g., 2024-01-15T09:30:00Z).
string ("1D" | "1W" | "1M" | "3M" | "6M" | "1A")
Duration of portfolio history data.
string
End date for the data in YYYY-MM-DD format. Defaults to current market date.
string ("ALL" | "DAY")
Defines how baseline values for Profit and Loss are calculated.
string ("1Min" | "5Min" | "15Min" | "1H" | "1D")
Time resolution for portfolio history data points.
string
The unique identifier of the trading account. Not required - the authenticated account is used automatically.
boolean
If true, include extended hours in results. Only effective for timeframe less than 1D.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_ACCOUNTS_POSITIONSBulk fetches all open positions for the authenticated account. Use when you need to retrieve all current positions, monitor overall portfolio holdings, or check unrealized P&L across the entire account. This action does not require an account_id parameter as it automatically uses the account associated with the API credentials. Note: This action returns positions for the account associated with the authenticated API key. Use this read-only action to get a complete view of the account’s open positions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_ALL_OPEN_POSITIONSRetrieves all open positions for the authenticated Alpaca trading account, including holdings and unrealized P&L. This read-only action uses the account associated with the credentials.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_ALL_ORDERSRetrieves all orders for an account based on specified filter criteria. Returns a list of orders with their current status, filled quantity, prices, and any nested legs for complex orders. Use when you need to query historical or current orders for a trading account, such as checking open positions or reviewing trade history. By default, only open orders are returned. Use status=‘all’ to include closed orders, or status=‘closed’ for only closed/canceled orders.

Input Parameters

string
Only include orders submitted after this timestamp (exclusive). Format: ISO8601.
integer
Maximum number of orders to return. Defaults to 50, maximum is 500.
string
Only include orders submitted until this timestamp (exclusive). Format: ISO8601.
boolean
If true, nested multi-leg orders are included under the legs field.
string ("open" | "closed" | "all")
Possible status filter values for querying orders.
string
Comma-separated list of symbols to filter by (e.g., ‘AAPL,TSLA,MSFT’).
string ("asc" | "desc")
Possible direction values for ordering results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_ALPACA_DATA_CRYPTO_US_BARSRetrieves historical OHLCV bars for crypto symbols at a selected location, aggregated by the specified timeframe. Results are sorted by symbol, then timestamp.

Input Parameters

string
Inclusive end of interval in RFC-3339 format or YYYY-MM-DD. Defaults to the current time.
string ("us" | "us-1" | "eu-1")
required
Crypto location for the data source. Values: ‘us’ (Alpaca US), ‘us-1’ (Kraken US), ‘eu-1’ (Kraken EU)
string
Sort order for bar data. Values: ‘asc’ (ascending) or ‘desc’ (descending). Default: ‘asc’
integer
Maximum number of data points to return. Default: 1000, max: 10000
string
Inclusive start of interval in RFC-3339 format or YYYY-MM-DD. Defaults to the beginning of the current day.
string
required
A comma-separated list of crypto symbols (e.g., ‘BTC/USD,LTC/USD’)
string
required
Bar aggregation timeframe. Format: number + unit (e.g., ‘1Min’, ‘1Hour’, ‘1Day’). Valid units: Min (1-59), Hour (1-23), Day, Week, Month (1-12)
string
Pagination token for continuing results from a previous response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_BARS_FOR_MULTIPLE_CRYPTO_SYMBOLSRetrieves historical OHLCV bars for multiple crypto symbols from the US market data location. Results are sorted by symbol and then timestamp; use the returned next page token to continue through available bars.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000
string
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
string
required
The comma-separated list of crypto symbols to query for. Note, currently all crypto symbols must be appended with ‘USD’, e.g., ‘BTCUSD,ETHUSD’ would get both BTC and ETH
string
A comma separated list of which crypto exchanges to pull the data from. Alpaca currently supports ‘ERSX’, ‘CBSE’, and ‘FTXU’
string
required
Timeframe for the aggregation. Values are customizable, frequently used examples: 1Min, 15Min, 1Hour, 1Day. Limits: 1Min-59Min, 1Hour-23Hour
string
Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_BARS_FOR_MULTIPLE_STOCK_SYMBOLSRetrieves OHLCV (Open, High, Low, Close, Volume) bars for multiple stock symbols. Use this action when you need to: - Get historical price data for multiple stock symbols - Analyze price trends over a specific timeframe - Fetch aggregated bar data for stock analysis - Backtest trading strategies on multiple stocks Results are sorted by symbol first, then by bar timestamp. If the limit is reached for one symbol, subsequent requests with the next_page_token will retrieve bars for remaining symbols. Note: This endpoint uses the data.alpaca.markets base URL and requires appropriate data subscriptions for SIP and OTC feeds.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
string ("iex" | "sip" | "otc")
Market data feed sources for stock data.
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000.
string
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
string
required
The comma-separated list of stock ticker symbols to query for.
string
required
Timeframe for the aggregation. Values are customizable, frequently used examples: 1Min, 15Min, 1Hour, 1Day. Limits: 1Min-59Min, 1Hour-23Hour
string ("raw" | "split" | "dividend" | "all")
Corporate action adjustment options for stock bars data.
string
Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_BARS_FOR_STOCK_SYMBOLRetrieves historical OHLCV (Open, High, Low, Close, Volume) bars for a single stock symbol. Use this action when you need to analyze historical price movements and trading activity for a specific stock ticker over a given timeframe. The bars are aggregated based on the specified timeframe (e.g., 1 minute, 15 minutes, 1 hour, 1 day). Note: This endpoint uses the data.alpaca.markets base URL.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca.
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000.
string
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
string
required
The stock ticker symbol to query for
string
required
Timeframe for the aggregation. Format: number + unit (e.g., ‘1Min’, ‘15Min’, ‘1Hour’, ‘1Day’). Valid units: Min (1-59), Hour (1-23), Day
string ("raw" | "split" | "dividend" | "all")
Corporate action adjustment types for bars data.
string
Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_BARS_STOCKSRetrieves historical OHLCV (Open, High, Low, Close, Volume) bars for a single stock symbol. Use this action when you need to analyze historical price movements and trading activity for a specific stock ticker over a given timeframe. The bars are aggregated based on the specified timeframe (e.g., 1 minute, 15 minutes, 1 hour, 1 day). Results are sorted by timestamp and support pagination via the next_page_token field when the limit is reached and more data is available. Note: This endpoint uses the data.alpaca.markets base URL and requires appropriate data subscriptions for SIP and OTC feeds.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000.
string
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
string
required
The stock ticker symbol to query for
string
required
Timeframe for the aggregation. Values are customizable, frequently used examples: 1Min, 15Min, 1Hour, 1Day. Limits: 1Min-59Min, 1Hour-23Hour
string ("raw" | "split" | "dividend" | "all")
Corporate action adjustment types for bars data. Use ‘raw’ for no adjustment, ‘split’ for split adjustment, ‘dividend’ for dividend adjustment, or ‘all’ for all adjustments.
string
Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CALENDARRetrieves market calendar information for trading days from the Alpaca Trading API. Use this action when you need to: - Get market open and close times for specific dates - Check trading session times - Verify market operating hours for date ranges - Plan trading activities around market hours This is a read-only operation that returns market calendar data.

Input Parameters

string
The last date to retrieve data for (inclusive), in YYYY-MM-DD format
string
The first date to retrieve data for (inclusive), in YYYY-MM-DD format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CLOCKRetrieves the current market clock information from the Alpaca Trading API. Use this action when you need to: - Check if the market is currently open - Determine when the next market open or close will occur - Plan trading activities based on market hours - Verify server time for timestamp-sensitive operations This is a read-only operation that returns the current state of the market clock including whether the market is open and the timestamps for the next open and close.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CONDITIONSRetrieves the mapping of condition codes to their names from Alpaca Markets API for the specified type (trade or quote conditions) and tape. Use this action when you need to: - Decode condition codes from stock market data - Get the list of all valid condition codes and their meanings for a specific type - Translate raw condition code integers to human-readable names - Understand the meaning of condition codes from trade or quote data This is a read-only action that queries the stocks meta conditions endpoint.

Input Parameters

string ("A" | "B" | "C")
required
The tape/exchange group for conditions. ‘A’ and ‘B’ return CTS conditions, ‘C’ returns UTP conditions.
string ("trade" | "quote")
required
The type of conditions to retrieve. Must be either ‘trade’ or ‘quote’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_LATEST_QUOTESRetrieves the latest bid and ask prices for specified crypto symbols at a specific location. Use when you need real-time quote data for cryptocurrency trading, such as checking current market prices before placing orders or monitoring price movements.

Input Parameters

string
required
Location for the crypto data. Common values include ‘us’ for US market data.
string
required
Comma-separated list of crypto symbols to query. Note, all crypto symbols must be appended with ‘USD’, e.g., ‘BTC/USD,ETH/USD’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_PERP_LATEST_BARSRetrieves the latest OHLCV (Open, High, Low, Close, Volume) bars for crypto perpetual futures symbols. Use this action when you need real-time or near real-time price data for crypto perpetual futures contracts for a specific location (e.g., ‘global’). Returns the most recent bar for each requested symbol, including open, high, low, close prices, volume, trade count, and volume-weighted average price.

Input Parameters

string
required
Location for the crypto perps data. Common values include ‘global’ for global market data.
string
required
A comma-separated list of crypto perpetual symbols to get latest bars for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_PERP_LATEST_ORDER_BOOKSRetrieves the latest bid and ask orderbook data for specified crypto perpetual futures symbols. Use when you need real-time orderbook data for crypto perpetual futures trading, such as checking current market depth before placing orders or analyzing liquidity. Returns the most recent orderbook for each requested symbol, including bid and ask price levels with their sizes.

Input Parameters

string
required
Location for the crypto perps data. Common values include ‘global’ for global market data.
string
required
Comma-separated list of crypto perpetual symbols to get orderbooks for (e.g., BTCUSD.P,ETHUSD.P)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_PERP_LATEST_PRICINGRetrieves the latest pricing data for specified crypto perpetual futures symbols. Use when you need real-time pricing data for crypto perpetual futures trading, such as checking current market prices, index prices, mark prices, funding rates, or open interest before placing orders or analyzing the market. Returns the most recent pricing data for each requested symbol, including timestamp, funding timestamp, open interest, index price, mark price, and funding rate.

Input Parameters

string
required
Location for the crypto perps data. Common values include ‘global’ for global market data.
string
required
Comma-separated list of crypto perpetual symbols to get pricing for (e.g., BTCUSDT.P,ETHUSDT.P)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_PERP_LATEST_QUOTESRetrieves the latest bid and ask prices for specified crypto perpetual futures symbols for a specific location. Use when you need real-time quote data for crypto perpetual futures trading, such as checking current market prices before placing orders or monitoring price movements.

Input Parameters

string
required
Location for the crypto perps data. Common values include ‘global’ for global market data.
string
required
Comma-separated list of crypto perpetual symbols to get quotes for (e.g., BTCUSD.P,ETHUSD.P)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_PERP_LATEST_TRADESRetrieves the latest trade data for specified crypto perpetual futures symbols. Use when you need real-time trade data for crypto perpetual futures trading, such as monitoring recent trades, analyzing price movements, or tracking trading volume. Returns the most recent trade for each requested symbol, including price, size, timestamp, and tick direction.

Input Parameters

string
required
Location for the crypto perps data. Common values include ‘global’ for global market data.
string
required
Comma-separated list of crypto perpetual symbols to get trades for (e.g., BTCUSD.P,ETHUSD.P)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_PERPS_GLOBAL_LATEST_BARSRetrieves the latest global OHLCV bars for crypto perpetual futures symbols, including trade count and volume-weighted average price. Use for real-time or near real-time price data for crypto perpetual futures contracts.

Input Parameters

string
required
A comma-separated list of crypto perpetual symbols to get latest bars for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_PERPS_GLOBAL_LATEST_PRICINGRetrieves the latest global pricing data for crypto perpetual futures symbols, including mark price, index price, open interest, and funding rate.

Input Parameters

string
required
Comma-separated list of crypto perpetual symbols to get pricing for (e.g., BTCUSD.P,ETHUSD.P)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_PERPS_GLOBAL_LATEST_QUOTESRetrieves the latest global bid and ask quotes for specified crypto perpetual futures symbols. Use for current market prices or monitoring price movements.

Input Parameters

string
required
Comma-separated list of crypto perpetual symbols to get quotes for (e.g., BTCUSD.P,ETHUSD.P)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_PERPS_GLOBAL_LATEST_TRADESRetrieves the latest trade data for specified crypto perpetual futures symbols. Use when you need real-time trade data for crypto perpetual futures trading, such as monitoring recent trades, analyzing price movements, or tracking trading volume.

Input Parameters

string
required
Comma-separated list of crypto perpetual symbols to get trades for (e.g., BTCUSDT.P,ETHUSDT.P)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_SNAPSHOTSRetrieves snapshots (latest trade, latest quote, minute bar, daily bar, and previous daily bar) for multiple cryptocurrency symbols in a specific location. Use this action when you need comprehensive real-time market data for crypto symbols, such as building a crypto dashboard, checking current market conditions across multiple assets, or analyzing price movements before trading. Note: This endpoint uses the data.alpaca.markets base URL for crypto market data.

Input Parameters

string ("us" | "us-1" | "us-2" | "eu-1" | "bs-1")
required
The location/exchange to pull the data from. Supported locations: us, us-1, us-2, eu-1, bs-1
string
required
Comma-separated list of crypto symbols to query for. Note: all crypto symbols must be appended with USD (e.g., BTC/USD,ETH/USD)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_US_LATEST_BARSRetrieves the latest OHLCV (Open, High, Low, Close, Volume) bars for US crypto symbols. Use this action when you need real-time or near real-time price data for multiple crypto trading pairs. Returns the most recent bar for each requested symbol, including open, high, low, close prices, volume, trade count, and volume-weighted average price.

Input Parameters

string
required
A comma-separated list of US crypto symbols to get latest bars for (e.g., BTC/USD,ETH/USD)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_US_LATEST_ORDER_BOOKSRetrieves the latest bid and ask orderbook data for specified crypto symbols in the US market. Use when you need real-time orderbook data for cryptocurrency trading in the US market, such as checking current market depth before placing orders or analyzing liquidity. Returns the most recent orderbook for each requested symbol, including bid and ask price levels with their sizes.

Input Parameters

string
required
Comma-separated list of US crypto symbols to get orderbooks for (e.g., BTC/USD,ETH/USD). Note, all crypto symbols must be appended with ‘USD’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_US_LATEST_QUOTESRetrieves the latest bid and ask prices for specified crypto symbols in the US location. Use when you need real-time quote data for cryptocurrency trading in the US market, such as checking current market prices before placing orders or monitoring price movements.

Input Parameters

string
required
Comma-separated list of crypto symbols to query. Note, all crypto symbols must be appended with ‘USD’, e.g., ‘BTC/USD,ETH/USD’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_US_LATEST_TRADESRetrieves the latest trade data for specified crypto symbols in the US location. Use when you need real-time trade data for cryptocurrency trading, such as monitoring recent trades, analyzing price movements, or tracking trading volume.

Input Parameters

string
required
Comma-separated list of crypto symbols to get trades for (e.g., BTC/USD,ETH/USD)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_US_QUOTESRetrieves historical bid and ask quotes for specified crypto symbols in the US location, sorted by symbol and then timestamp. Use the data to analyze spreads, backtest strategies, or study market microstructure.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 or YYYY-MM-DD format. Defaults to current time if real-time access is available.
string ("asc" | "desc")
Sort order for historical data.
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000.
string
Filter data equal to or after this time in RFC-3339 or YYYY-MM-DD format. Defaults to beginning of current day (>=15 min ago). Historical quotes for US-1 location only go back to October 14, 2025.
string
required
Comma-separated list of crypto symbols to query. Note: all crypto symbols must use format ‘BTC/USD’, e.g., ‘BTC/USD,ETH/USD’
string
Pagination token to continue from. The value to pass here is returned in responses when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_US_SNAPSHOTSRetrieves snapshots (latest trade, latest quote, minute bar, daily bar, and previous daily bar) for multiple cryptocurrency symbols in the US market location. Use this action when you need comprehensive real-time market data for multiple crypto symbols in the US market, such as building a crypto dashboard, checking current market conditions across multiple assets, or analyzing price movements before trading.

Input Parameters

string
required
Comma-separated list of crypto symbols to query for. Symbols should use slash format (e.g., BTC/USD,ETH/USD)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_CRYPTO_US_TRADESRetrieves historical trade data for specified US crypto symbols. Use when you need to: - Get historical trade data for US crypto symbols at once - Analyze trading volume and price movements over time - Build datasets for backtesting or research - Query trades within a specific time range Results are sorted by symbol first, then by trade timestamp. If the response contains more data than the limit allows, use the next_page_token to continue fetching.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format or YYYY-MM-DD. Defaults to current time.
string
Sort order for the results. Must be ‘asc’ or ‘desc’, defaults to ‘asc’.
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000.
string
Filter data equal to or after this time in RFC-3339 format or YYYY-MM-DD. Defaults to the beginning of current day.
string
required
Comma-separated list of crypto symbols to query for (e.g., BTC/USD,LTC/USD)
string
Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_EXCHANGESRetrieves a list of supported stock exchanges with their short codes and full names from the Alpaca Market Data API. Use this action when you need to: - Get the mapping between exchange codes and full names - Understand what exchange codes like ‘Z’, ‘V’, ‘N’ mean in market data - Parse exchange identifiers in trading data responses This is a read-only operation that queries the stocks meta exchanges endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_LATEST_BAR_FOR_STOCK_SYMBOLRetrieves the latest OHLCV (Open, High, Low, Close, Volume) bar for a single stock symbol. Use this action when you need real-time or near real-time price bar data for a specific stock trading symbol. This is useful for dashboards, price monitoring, and triggering alerts based on current market conditions. Returns the most recent bar including open, high, low, close prices, volume, trade count, and volume-weighted average price.

Input Parameters

string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
string
required
The stock ticker symbol to query for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_LATEST_BARS_FOR_CRYPTO_SYMBOLRetrieves the latest OHLCV bar for a cryptocurrency pair in Alpaca’s US location. The bar includes opening, high, low and closing prices, volume, trade count and volume-weighted average price.

Input Parameters

string
required
The crypto symbol to query for. Use slash notation with USD suffix, e.g. BTC/USD, ETH/USD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_LATEST_BARS_FOR_CRYPTO_SYMBOLSRetrieves the latest OHLCV (Open, High, Low, Close, Volume) bars for multiple crypto symbols. Use this action when you need real-time or near real-time price bar data for multiple cryptocurrency pairs simultaneously. This is useful for dashboards, price monitoring, and triggering alerts based on current market conditions. The response includes the most recent bar for each requested symbol, containing open, high, low, close prices, volume, trade count, and volume-weighted average price.

Input Parameters

string ("us" | "us-1" | "us-2" | "eu-1" | "bs-1")
required
The crypto location to pull data from. Use ‘us’ for Alpaca US data, ‘us-1’ for Kraken US data, ‘eu-1’ for Kraken EU data, or ‘bs-1’ for Binance US data.
string
required
Comma-separated list of crypto symbols to get latest bars for. Use slash notation with USD suffix, e.g., ‘BTC/USD,ETH/USD’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_LATEST_BARS_FOR_MULTIPLE_STOCK_SYMBOLSRetrieves the latest OHLCV (Open, High, Low, Close, Volume) bars for multiple stock symbols. Use this action when you need real-time or near real-time price bar data for multiple stock trading symbols simultaneously. This is useful for dashboards, price monitoring, and triggering alerts based on current market conditions. The response includes the most recent bar for each requested symbol, containing open, high, low, close prices, volume, trade count, and volume-weighted average price.

Input Parameters

string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
string
required
A comma-separated list of stock ticker symbols to query for (e.g., AAPL,TSLA,MSFT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_LATEST_ORDER_BOOKS_FOR_CRYPTORetrieves the latest bid and ask orderbook data for specified crypto symbols. Use when you need real-time orderbook data for cryptocurrency trading, such as checking current market depth before placing orders or analyzing liquidity. Returns the most recent orderbook for each requested symbol, including bid and ask price levels with their sizes.

Input Parameters

string
required
Location for the crypto data. Common values include ‘us’ for US market data.
string
required
Comma-separated list of crypto symbols to get orderbooks for (e.g., BTC/USD,ETH/USD)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_LATEST_QUOTE_FOR_CRYPTO_SYMBOLRetrieves the latest bid and ask prices for a specified crypto symbol. Use when you need real-time quote data for a specific cryptocurrency, such as checking current market prices before placing an order or monitoring price movements.

Input Parameters

string
required
The crypto symbol to query for. Format: ‘BTC/USD’, ‘ETH/USD’, ‘SOL/USD’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_LATEST_QUOTE_FOR_STOCK_SYMBOLRetrieves the latest NBBO (National Best Bid and Offer) quote for a single stock symbol. Use this action when you need real-time or near real-time bid and ask prices for a specific stock trading symbol. This is useful for checking market conditions before placing an order or monitoring price movements for a single symbol. Note: This endpoint uses the data.alpaca.markets base URL for stock data.

Input Parameters

string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
string
required
The stock ticker symbol to query for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_LATEST_QUOTES_FOR_MULTIPLE_CRYPTO_SYMBOLSRetrieves the latest bid and ask prices for specified crypto symbols. Use when you need real-time quote data for cryptocurrency trading, such as checking current market prices before placing orders or monitoring price movements.

Input Parameters

string
required
Comma-separated list of crypto symbols to query. Use format like ‘BTC/USD,ETH/USD’
string
Crypto exchange (not used for v1beta3 endpoint, kept for backwards compatibility)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_LATEST_QUOTES_FOR_MULTIPLE_STOCK_SYMBOLSRetrieves the latest NBBO (National Best Bid and Offer) quotes for multiple stock symbols. Use this action when you need real-time or near real-time bid and ask prices for multiple stock trading symbols simultaneously. This is useful for checking market conditions before placing orders, monitoring price movements, or evaluating spread opportunities. The response includes the most recent quote for each requested symbol, containing bid price, ask price, bid size, ask size, and exchange information.

Input Parameters

string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
string
required
A comma-separated list of stock ticker symbols to query for (e.g., AAPL,TSLA,MSFT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_LATEST_TRADE_FOR_STOCK_SYMBOLRetrieves the latest trade data for a single stock symbol. Use this action when you need the most recent trade information for a specific stock ticker, such as checking current market price and volume before placing an order or monitoring real-time price movements for a single symbol. This provides the single most recent trade including price, size, exchange, and timestamp. Note: This endpoint uses the data.alpaca.markets base URL for stock market data.

Input Parameters

string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
string
required
The stock ticker symbol to query for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_LATEST_TRADES_FOR_MULTIPLE_CRYPTO_SYMBOLSRetrieves the latest trade data for specified crypto symbols. Use when you need real-time trade data for cryptocurrency trading, such as monitoring recent trades, analyzing price movements, or tracking trading volume.

Input Parameters

string
required
Comma-separated list of crypto symbols to query. Note, all crypto symbols must be appended with ‘USD’, e.g., ‘BTCUSD,ETHUSD’
string ("ERSX" | "CBSE" | "FTXU")
required
Which crypto exchange to pull data from. Supported: ERSX, CBSE, FTXU

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_LATEST_TRADES_FOR_MULTIPLE_STOCK_SYMBOLSRetrieves the latest trade data for multiple stock symbols. Use this action when you need real-time or near real-time trade data for multiple stock trading symbols simultaneously. This is useful for dashboards, trade monitoring, and triggering alerts based on current market conditions. The response includes the most recent trade for each requested symbol, containing price, size, timestamp, exchange, and trade conditions.

Input Parameters

string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
string
required
A comma-separated list of stock ticker symbols to query for (e.g., AAPL,TSLA,MSFT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_MARKET_CALENDARRetrieves market calendar information for a specific exchange from the Alpaca Trading API. Use this action when you need to: - Get market open and close times for a specific exchange (NYSE, NASDAQ, etc.) - Check trading session times for a particular market - Verify market operating hours for specific date ranges - Plan trading activities around specific market hours This is a read-only operation that returns market calendar data for the specified exchange.

Input Parameters

string
The last date to retrieve data for (inclusive), in YYYY-MM-DD format
string
The first date to retrieve data for (inclusive), in YYYY-MM-DD format
string
required
The market exchange to query (e.g., ‘NYSE’, ‘NASDAQ’, ‘CRYPTO’, ‘FX’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_META_EXCHANGESRetrieves US stock exchange identifiers and names from the Alpaca Market Data API. The returned exchange type is set to “exchange” by the action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_MOST_ACTIVESRetrieves the most active stocks by trading volume or trade count. Use this action when you need to: - Fetch top traded stocks for the current period - Monitor market liquidity and activity - Build trading signals based on volume or trade frequency - Analyze market breadth through most active stocks Note: This endpoint uses data.alpaca.markets base URL and provides real-time SIP data for US stock markets.

Input Parameters

string ("volume" | "trades")
Metric used for ranking most active stocks.
integer
Number of top most active stocks to return. Range: 1-100, default: 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_NEWSRetrieves news articles for specified crypto symbols from the Alpaca Market Data API. Use this action when you need to: - Fetch the latest news for crypto assets (BTCUSD, ETHUSD, etc.) - Monitor news sentiment for trading decisions - Build news-based signals or alerts - Get historical news for specific time periods Note: The data.alpaca.markets endpoint is used for news API requests.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
string ("DESC" | "ASC")
Sort order for news articles.
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000.
string
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
string
required
The comma-separated list of crypto symbols to query for. Note, currently all crypto symbols must be appended with ‘USD’, e.g., ‘BTCUSD,ETHUSD’
string
Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows.
boolean
Boolean indicator to include content for news articles (if available)
boolean
Boolean indicator to exclude news articles that do not contain content

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_OPEN_POSITIONFetches a single open position by symbol or asset ID. Use when you need to retrieve detailed information about a specific position, including cost basis, shares traded, market value, and unrealized P&L. This action is useful for checking the current status of a particular holding, monitoring P&L for a specific symbol, or verifying position details after placing or closing orders. Returns real-time updated information as price data changes. Note: The position must be currently open to be retrieved through this endpoint. Once closed, the position will no longer be queryable.

Input Parameters

string
required
The symbol (e.g., AAPL) or asset ID (UUID format) of the position to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_OPTION_BARSRetrieves historical OHLCV (Open, High, Low, Close, Volume) bars for options contracts. Use this action when you need to analyze historical price movements and trading activity for specific option contracts over a given timeframe. The bars are aggregated based on the specified timeframe (e.g., 1 minute, 5 minutes, 1 hour, 1 day). Results are sorted by symbol first, then by timestamp.

Input Parameters

string
Inclusive end time in RFC-3339 format or YYYY-MM-DD format
string ("asc" | "desc")
Sort order for bar data.
integer
Number of data points to return. Default: 1000, max: 10000. The limit applies to total data points across all symbols, not per symbol.
string
Inclusive start time in RFC-3339 format or YYYY-MM-DD format
string
required
Comma-separated list of option contract symbols (max 100 symbols)
string
required
The timeframe for the bars. Format: number + unit (e.g., ‘1Min’, ‘5Min’, ‘1Hour’, ‘1Day’, ‘1Week’, ‘1Month’). Units: Min, Hour, Day, Week, Month
string
Pagination token for retrieving the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_OPTION_CHAINRetrieves option-chain snapshots for an underlying symbol, with optional type, strike and expiration filters. Snapshots may include quotes and Greeks; the response can include a next-page token.

Input Parameters

string
The data feed source to use. If not specified, the API uses whatever is configured for the account
string ("call" | "put")
Option contract type filter.
string
Filter by exact expiration date (YYYY-MM-DD format)
number
Filter contracts with strike price greater than or equal to this value
number
Filter contracts with strike price less than or equal to this value
string
required
The underlying asset symbol (e.g., AAPL, SPY)
string
Filter contracts expiring on or after this date (YYYY-MM-DD format)
string
Filter contracts expiring on or before this date (YYYY-MM-DD format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_OPTION_CONTRACT_SYMBOL_OR_IDRetrieves an option contract by its OCC symbol or Alpaca ID, including contract specifications and available open interest and closing price information.

Input Parameters

string
required
The option contract symbol (e.g., ‘AAPL250620C00100000’) or ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_OPTION_LATEST_QUOTESRetrieves the latest bid and ask prices for specified option symbols. Use when you need real-time quote data for options trading, such as checking current market prices before placing orders or monitoring price movements.

Input Parameters

string
required
Comma-separated list of option symbols to query (e.g., ‘AAPL241220C00300000,MSFT241220C00300000’). Option symbols follow the format: underlying symbol + expiration date + type + strike price

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_OPTION_META_CONDITIONSRetrieves the mapping of condition codes to their names from Alpaca Markets API for the specified tick type (trade or quote conditions). Use this action when you need to: - Decode condition codes from options market data - Get the list of all valid condition codes and their meanings for a specific tick type - Translate raw condition code integers to human-readable names This is a read-only action that queries the options meta conditions endpoint.

Input Parameters

string ("trade" | "quote")
required
The tick type for the conditions. Must be one of: ‘trade’ or ‘quote’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_OPTIONS_CONTRACTSRetrieve option contracts from Alpaca Markets API (BETA). Use this action when you need to: - Search for option contracts by underlying symbol - Filter contracts by expiration date, strike price, type (call/put), or style - Get a paginated list of all available option contracts - Find contracts eligible for penny price increments By default, only active contracts expiring before the upcoming weekend are returned.

Input Parameters

string ("call" | "put")
Option contract type.
integer
Number of contracts to return per page. Default: 100, max: 10000
boolean
Penny Program Indicator - filter for contracts eligible for penny price increments
string ("american" | "european")
Option contract style.
string
Filter by contract status (active or inactive). Default: active
string
Pagination token for retrieving the next page of results
string
Filter contracts by root symbol
string
Filter by exact expiration date (YYYY-MM-DD format)
number
Filter contracts with strike price greater than or equal to this value
number
Filter contracts with strike price less than or equal to this value
boolean
Include deliverables array in the response
string
Filter contracts by one or more underlying symbols. Multiple symbols can be comma-separated
string
Filter contracts expiring on or after this date (YYYY-MM-DD format)
string
Filter contracts expiring on or before this date (YYYY-MM-DD format). Default: next weekend

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_OPTIONS_LATEST_TRADESRetrieves the latest trade for each requested option contract symbol. Use this action when you need to: - Get the most recent trade price and size for specific option contracts - Check the last traded time for option symbols before trading - Monitor real-time trading activity for option positions This endpoint requires market data subscription and uses the data.alpaca.markets base URL.

Input Parameters

string
required
Comma-separated list of option contract symbols to get latest trades for (e.g., ‘AAPL241220C00300000’). Max 250 symbols per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_OPTIONS_META_CONDITIONS_TRADERetrieves the mapping of trade condition codes to their names from Alpaca Markets API. Use this action when you need to: - Decode trade condition codes from options market data - Get the list of all valid trade condition codes and their meanings - Translate raw condition code integers to human-readable names This is a read-only action that queries the options meta conditions endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_OPTION_SNAPSHOTSRetrieves snapshots (latest trade, latest quote, minute bar, daily bar, and previous daily bar) for multiple option contract symbols. Use this action when you need comprehensive real-time market data for option contracts, such as building an option price dashboard, checking current bid/ask prices across multiple option strikes, or analyzing intraday price movements before trading. Note: This endpoint requires market data subscription and uses the data.alpaca.markets base URL.

Input Parameters

string
required
Comma-separated list of option contract symbols to query (e.g., ‘AAPL240621C00150000’). Max 250 symbols per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_OPTIONS_SNAPSHOTS_UNDERLYING_SYMBOLRetrieves a page of option chain snapshots for an underlying symbol, with optional contract filters. Snapshots may include latest trades, quotes, Greeks, and implied volatility; use the pagination token to retrieve further results.

Input Parameters

string ("opra" | "indicative")
Data feed source for option market data.
string ("call" | "put")
Option contract type.
integer
Number of maximum snapshots to return in a response. The limit applies to the total number of data points, not the number per symbol. Default: 100
string
The pagination token from which to continue
string
Filter contracts by the root symbol
string
Filter to snapshots that were updated since this timestamp. Format: RFC-3339 or YYYY-MM-DD
string
Filter contracts by the exact expiration date (format: YYYY-MM-DD)
number
Filter contracts with strike price greater than or equal to the specified value
number
Filter contracts with strike price less than or equal to the specified value
string
required
The ticker symbol of the underlying asset (e.g., ‘AAPL’, ‘SPY’)
string
Filter contracts with expiration date greater than or equal to the specified date (format: YYYY-MM-DD)
string
Filter contracts with expiration date less than or equal to the specified date (format: YYYY-MM-DD)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_OPTION_TRADESRetrieves historical trade data for option contracts. Use this action when you need to: - Analyze historical trade activity for option contracts - Review past trades for specific option symbols - Calculate volume patterns and trading activity - Track price movements over specific time periods Note: This endpoint uses the data.alpaca.markets base URL and requires market data subscription.

Input Parameters

string
Inclusive end time in RFC-3339 format or YYYY-MM-DD format
integer
Number of trades to return per symbol. Default: 25, max: 10000
string
Inclusive start time in RFC-3339 format or YYYY-MM-DD format
string
required
Comma-separated list of option symbols to query (e.g., ‘AAPL240617C00200000’ or ‘AAPL240617C00200000,AAPL240617P00200000’). Option symbols follow the format: underlying symbol + expiration date + type (C/P) + strike price
string
Pagination token for retrieving the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_PDT_STATUSRetrieves Pattern Day Trader (PDT) status for the authenticated Alpaca trading account, including available PDT flags and call counts.

Input Parameters

string
Account ID (deprecated - the authenticated account is used automatically).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_POSITIONS_FOR_ACCOUNTLists open positions for the authenticated trading account, including portfolio holdings and unrealized P&L. The required account ID does not select a different account.

Input Parameters

string
required
The unique identifier of the trading account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_QUOTES_FOR_MULTIPLE_STOCK_SYMBOLSRetrieves historical quote (bid/ask) data for multiple stock symbols. Use this action when you need historical quote data including bid and ask prices for multiple stock trading symbols. This is useful for trading analysis, backtesting strategies, and monitoring price spreads. Note: Results are sorted by symbol first, then by timestamp. If you hit the limit for one symbol, subsequent symbols won’t appear in the response - use next_page_token to get more results.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000 if not specified.
string
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
string
required
A comma-separated list of stock ticker symbols to query for (e.g., AAPL,TSLA,MSFT). Required.
string
Pagination token to continue from a previous request. Use this to get the next page of results when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_QUOTES_FOR_STOCK_SYMBOLRetrieves historical NBBO (National Best Bid and Offer) quotes for a specific stock symbol. Use this action when you need historical quote data for a single stock symbol, such as for analysis, backtesting trading strategies, or research purposes. You can filter results by time range using start and end parameters. The response includes an array of quotes with bid/ask prices, sizes, and exchange information. Pagination is supported via the page_token parameter when results exceed the limit.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000.
string
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
string
required
The stock ticker symbol to query for (e.g., AAPL, TSLA, MSFT)
string
Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_SNAPSHOT_FOR_STOCK_SYMBOLRetrieves a snapshot (latest trade, latest quote, minute bar, daily bar, and previous daily bar) for a single stock symbol. Use this action when you need comprehensive real-time market data for a single stock symbol, such as checking current market conditions, displaying price information, or analyzing price movements before trading. This endpoint requires the data.alpaca.markets API.

Input Parameters

string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
string
required
The stock ticker symbol to query for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_SNAPSHOTS_FOR_MULTIPLE_CRYPTO_SYMBOLSRetrieves snapshots (latest trade, latest quote, minute bar, daily bar, and previous daily bar) for multiple cryptocurrency symbols. Use this action when you need comprehensive real-time market data for multiple crypto symbols, such as building a crypto dashboard, checking current market conditions across multiple assets, or analyzing price movements before trading.

Input Parameters

string
required
Comma-separated list of crypto symbols to query for. All crypto symbols must be appended with USD (e.g., BTCUSD,ETHUSD)
string ("ERSX" | "CBSE" | "FTXU")
Supported crypto exchanges for snapshot data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_SNAPSHOTS_FOR_MULTIPLE_STOCK_SYMBOLSRetrieves snapshots (latest trade, latest quote, minute bar, daily bar, and previous daily bar) for multiple stock symbols. Use this action when you need comprehensive real-time market data for multiple stock symbols, such as building a stock dashboard, checking current market conditions across multiple stocks, or analyzing price movements before trading. This endpoint requires the data.alpaca.markets API.

Input Parameters

string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
string
required
A comma-separated list of stock ticker symbols to query for (e.g., AAPL,TSLA,MSFT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_SPECIFIC_ANNOUNCEMENTRetrieves a specific corporate action announcement by its unique identifier. Use this action when you need to fetch detailed information about a corporate action such as dividends, stock splits, mergers, spinoffs, or other corporate events. This is a read-only operation that returns the complete announcement details including the corporate action type, relevant dates (ex-date, record date, payable date), and any associated values (cash amounts, split ratios, etc.). The response includes the announcement ID which can be used for reference or correlation with other systems.

Input Parameters

string
required
The unique identifier of the corporate action announcement to retrieve (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_STOCK_AUCTIONSRetrieves historical auction data for specified stock symbols. Use this action when you need to: - Analyze opening and closing auction prices for stocks - Study pre-market and post-market auction behavior - Understand auction volume and price discovery - Monitor auction-based market data for trading decisions Results are sorted by timestamp in descending order (most recent first). Pagination is supported via the page_token field. Note: This endpoint uses the data.alpaca.markets base URL and requires appropriate data subscriptions for SIP and OTC feeds.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
string ("iex" | "sip" | "otc")
Market data feed sources for stock auction data.
integer
Number of data points to return. Must be in range 1-10000, defaults to 25.
string
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
string
required
The comma-separated list of stock ticker symbols to query for (e.g., AAPL,TSLA,MSFT)
string
Pagination token to continue from. The value to pass here is returned in responses when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_STOCK_AUCTION_SINGLERetrieves historical auction (opening/closing print) data for a single stock symbol. Use this action when you need to analyze auction-related price and volume data for a specific stock ticker. This is useful for: - Understanding opening and closing auction prices - Analyzing auction volume and liquidity - Studying price discovery at market open and close - Trading strategies based on auction data Note: This endpoint uses the data.alpaca.markets base URL and requires appropriate data subscriptions for SIP and OTC feeds.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000.
string
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
string
required
The stock ticker symbol to query for
string
Pagination token to continue from. The value to pass here is returned in requests when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_STOCKS_META_CONDITIONS_TRADERetrieves stock trade condition code names for a specified tape. Use it to decode trade condition codes from stock market data.

Input Parameters

string ("A" | "B" | "C")
required
The tape/exchange group for conditions. ‘A’ and ‘B’ return CTS (Consolidated Tape System) conditions, ‘C’ returns UTP (Unified Tape Plan) conditions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_SUBSCRIPTIONRetrieves a rebalancing subscription by its unique ID. Returns complete subscription details including the associated account ID, portfolio ID, creation timestamp, and last rebalancing timestamp. Use when you need to fetch subscription information for an existing rebalancing setup. Note: If the subscription_id is invalid or malformed, a 400 error is returned. If the subscription does not exist, a 404 error is returned.

Input Parameters

string
required
The unique identifier of the rebalancing subscription to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_TOP_MOVERS_BY_MARKET_TYPERetrieves the top market movers (gainers and losers) for a specified market type. Use this action when you need to: - Fetch top gainers and losers for stock market analysis - Get cryptocurrency movers for crypto trading strategies - Identify assets with significant price movements - Build market sentiment indicators Note: The screener endpoint uses data.alpaca.markets, not api.alpaca.markets.

Input Parameters

integer
Number of top market movers to fetch (gainers and losers). By default returns 10 gainers and 10 losers.
string ("stocks" | "crypto")
required
The market type to screen. Use ‘stocks’ for equities or ‘crypto’ for cryptocurrency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_TRADES_FOR_MULTIPLE_CRYPTO_SYMBOLSRetrieves historical trade data for specified crypto symbols. Use when you need to: - Get historical trade data for multiple crypto symbols at once - Analyze trading volume and price movements over time - Build datasets for backtesting or research - Monitor trades across different exchanges Results are sorted by symbol first, then by trade timestamp. If the response contains more data than the limit allows, use the next_page_token to continue fetching.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000.
string
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
string
required
Comma-separated list of crypto symbols to query for. Use ’/’ format, e.g., ‘BTC/USD,ETH/USD’
string
Comma-separated list of crypto exchanges to pull data from. Alpaca supports ‘ERSX’, ‘CBSE’, and ‘FTXU’
string
Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_TRADES_FOR_MULTIPLE_STOCK_SYMBOLSRetrieves historical trade data for multiple stock symbols. Use this action when you need: - Historical trade data for multiple stock symbols at once - Analyze trading volume and price movements over time - Build datasets for backtesting or research - Monitor trades across different exchanges Results are sorted by symbol first, then by trade timestamp. If the response contains more data than the limit allows, use the next_page_token to continue fetching. Note: This endpoint uses the data.alpaca.markets base URL and requires appropriate data subscriptions for SIP and OTC feeds.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
string ("iex" | "sip" | "otc")
Market data feed sources for stock trade data. Use ‘iex’ for Investors Exchange (free tier available). Use ‘sip’ for Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000.
string
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
string
required
The comma-separated list of stock ticker symbols to query for.
string
Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_TRADES_FOR_STOCK_SYMBOLRetrieves historical trade data for a single stock symbol from Alpaca’s market data API. Trade records include price, size, exchange and timestamp, and may include trade conditions.

Input Parameters

string
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
string ("iex" | "sip" | "otc")
Supported stock data feeds for Alpaca. Use ‘iex’ for the Investors Exchange (free tier available). Use ‘sip’ for the Securities Information Processor (requires subscription). Use ‘otc’ for over-the-counter data (requires subscription).
integer
Number of data points to return. Must be in range 1-10000, defaults to 1000.
string
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
string
required
The stock ticker symbol to query for
string
Pagination token to continue from. The value to pass here is returned in specific requests when more data is available than the request limit allows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_WATCHLIST_BY_IDRetrieves a single watchlist by its unique identifier. Use when you need to view the details of a specific watchlist, including its name, associated assets, and timestamps. This endpoint provides direct access to a watchlist using its ID rather than requiring account-level traversal. This is a read-only operation that does not modify any data.

Input Parameters

string
required
Unique identifier of the watchlist (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_WATCHLIST_BY_NAMERetrieves a specific watchlist by its name. Use when you need to find a particular watchlist without knowing its ID, such as when managing watchlists for display or modification. Returns the watchlist details including all contained symbols. If multiple watchlists share the same name, the API may return the first match.

Input Parameters

string
required
The name of the watchlist to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_GET_WATCHLISTSRetrieves all watchlists associated with the authenticated account. Use this action when you need to: - View all watchlists for an account - Find a specific watchlist by name - Check what symbols are being tracked before adding or removing symbols - Get watchlist IDs for subsequent operations This is a read-only operation that returns the current state of all watchlists including their metadata (ID, name, timestamps) and the assets contained within each.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_PATCH_ACCOUNT_CONFIGURATIONSUpdate the trading account configuration settings for the authenticated account. Use when you need to modify account-level trading settings such as day-trading buying power checks, fractional trading permissions, margin multiplier limits, shorting restrictions, or trade confirmation email preferences. Supports partial updates - only specify the settings you want to change. Settings not included in the request remain unchanged. This action operates on the currently authenticated account and does not require an account_id parameter.

Input Parameters

string
Pattern Day Trader check setting. Controls whether PDT restrictions are enforced.
string ("both" | "entry" | "exit")
Controls Day Trading Margin Call (DTMC) checks.
boolean
If true, the account becomes long-only mode and cannot short positions.
boolean
If true, all new orders are blocked. Existing orders are not affected. Use this to halt trading quickly.
boolean
If true, the account is able to participate in fractional trading. If false or omitted, fractional trading is disabled.
string ("all" | "none")
Controls trade confirmation email settings.
string
Maximum margin multiplier. Can be ‘1’ for cash account or ‘2’ for margin account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_REMOVE_ASSET_FROM_WATCHLISTRemoves a symbol from an existing watchlist in Alpaca. Use this action when you need to delete a ticker symbol from a watchlist that is no longer being tracked. The action returns the updated watchlist after the symbol has been removed. This action is irreversible - once a symbol is removed from a watchlist, it cannot be recovered through this API. You would need to re-add it using a separate add-to-watchlist action if available.

Input Parameters

string
required
The ticker symbol to remove from the watchlist (e.g., AAPL, TSLA, MSFT).
string
required
The unique identifier of the watchlist (UUID format). Obtain this from ALPACA_GET_WATCHLISTS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_REMOVE_SYMBOL_FROM_WATCHLISTTool to remove a symbol from an existing watchlist in Alpaca. Use when you need to delete a ticker symbol from a watchlist that is no longer being tracked. This action is irreversible - once a symbol is removed from a watchlist, it cannot be recovered through this API. You would need to re-add it using ALPACA_ADD_ASSET_TO_WATCHLIST.

Input Parameters

string
required
The ticker symbol to remove from the watchlist (e.g., AAPL, TSLA, MSFT).
string
required
The unique identifier of the watchlist to remove the symbol from. Obtain this from the ALPACA_GET_WATCHLISTS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_UPDATE_TRADING_CONFIGURATIONSUpdates trading account configurations for an Alpaca trading account. Use when you need to modify account-level trading settings such as day-trading buying power checks, trade confirmation email preferences, or trading restrictions. Supports partial updates - only specify the settings you want to change. Settings not included in the request remain unchanged. This action requires the ‘account:write’ scope.

Input Parameters

boolean
When set to true, the account is frozen and cannot trade
string
The ID of the trading account whose configurations to update (optional - not used in v2 endpoint)
string ("entry" | "exit" | "both")
Enum for day-trading buying power check options.
boolean
When set to true, the account is restricted from shorting
string
Plaid setting for the account
boolean
When set to true, all trading activity is suspended for the account
boolean
When set to true, enables crypto sending capability for the account
boolean
When set to true, crypto assets are automatically converted to USD
string ("all" | "none" | "implied" | "implied_daily")
Enum for trade confirmation email settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_UPDATE_WATCHLIST_BY_IDUpdates an existing watchlist by ID, supplying its name and optionally a replacement list of symbols. When provided, the symbols replace the existing symbols in the watchlist.

Input Parameters

string
required
The new name for the watchlist (up to 64 characters).
array
The new list of symbol names to watch. If provided, this will replace all existing symbols in the watchlist.
string
required
The unique identifier of the watchlist to update (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_UPDATE_WATCHLIST_BY_NAMEUpdates an existing watchlist by its name. Use when you need to modify the symbols in a watchlist or rename it. The action allows partial updates - you can provide only symbols to update the watchlist contents, only a new_name to rename it, or both to update both. At least one of new_name or symbols must be provided. Note: The name parameter identifies which watchlist to update (case-insensitive).

Input Parameters

string
required
The current name of the watchlist to update. Used as the query parameter to identify which watchlist to update.
array
The new list of symbol names to watch. If provided, this will replace all existing symbols in the watchlist.
string
The new name for the watchlist. If provided, the watchlist will be renamed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_UPDATE_WATCHLIST_BY_NAME2Updates an existing watchlist by its name. Use when you need to modify the symbols in a watchlist or rename it. The action allows partial updates - you can provide only symbols to update the watchlist contents, only a new_name to rename it, or both to update both. At least one of new_name or symbols must be provided. Note: The name parameter identifies which watchlist to update (case-insensitive).

Input Parameters

string
required
The current name of the watchlist to update. Used as the query parameter to identify which watchlist to update.
array
The new list of symbol names to watch. If provided, this will replace all existing symbols in the watchlist.
string
The new name for the watchlist. If provided, the watchlist will be renamed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPACA_UPLOAD_ACCOUNT_CIPUpload CIP (Customer Identification Program) information for an account to complete identity verification. Use when you need to submit identity information for a new Alpaca trading account as part of the account onboarding process. This action is typically called after account creation to provide the required identity verification data including citizenship, tax ID, and name.

Input Parameters

string
required
The unique identifier of the trading account
object
required
CIP result object containing identity information for verification

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not