Alpaca

alpaca

Stock and crypto trading platform with commission-free trading, real-time market data, and algorithmic trading capabilities

Commerce Developer Tools Web del proveedor

Acciones

100

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (100)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Asset to WatchlistALPACA_ADD_ASSET_TO_WATCHLISTAcción

Adds a symbol to an existing watchlist in the authenticated account. Use when you need to track a new security in an existing watchlist. This action appends the specified symbol to the end of the watchlist's asset list. The watchlist_id can be obtained from the ALPACA_GET_WATCHLISTS action.

Parámetros de entrada

symbolstringObligatorio
The ticker symbol to add to the watchlist (e.g., 'AAPL', 'TSLA', 'MSFT').
watchlist_idstringObligatorio
The unique identifier of the watchlist to add the symbol to (UUID format).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Asset to Watchlist by NameALPACA_ADD_ASSET_TO_WATCHLIST_BY_NAMEAcción

Add 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WatchlistALPACA_CREATE_WATCHLISTAcción

Creates 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).

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WatchlistALPACA_CREATE_WATCHLIST_FOR_ACCOUNTAcción

Create a new watchlist for the authenticated account. Use when you need to create a watchlist to track specific securities. The name must contain only alphanumeric characters (no spaces or special characters).

Parámetros de entrada

namestringObligatorio
The watchlist name
symbolsstring[]Obligatorio
The new list of symbol names to watch
account_idstringObligatorio
Unique identifier of an account.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete All Open PositionsALPACA_DELETE_ALL_OPEN_POSITIONSAcción

Liquidates all open positions by closing them at market price. This action is irreversible and will permanently close all positions in the account. Use when you need to quickly exit all positions, such as before closing an account or in emergency situations. Optionally cancels all open orders before liquidating positions.

Parámetros de entrada

cancel_ordersboolean
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete All Orders for AccountALPACA_DELETE_ALL_ORDERS_FOR_ACCOUNTAcción

Attempts to cancel all open orders for a specified trading account. A response will be provided for each order that is attempted to be cancelled. This action is irreversible for individual orders that are successfully cancelled.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Unsubscribe AccountALPACA_DELETE_UNSUBSCRIBE_ACCOUNTAcción

Delete 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.

Parámetros de entrada

subscription_idstringObligatorio
The unique identifier of the rebalancing subscription to delete.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Watchlist By IDALPACA_DELETE_WATCHLIST_BY_IDAcción

Delete 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get AccountALPACA_GET_ACCOUNTAcción

Retrieves 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Account ActivitiesALPACA_GET_ACCOUNT_ACTIVITIESAcción

Retrieves 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.

Parámetros de entrada

datestring
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.
afterstring
Start date filter in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format. Cannot be used with 'date' parameter.
untilstring
End date filter in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format. Returns activities up to this date.
directionstringenum
Sort direction for activity results.
ascdesc
page_sizeinteger
Maximum number of activities to return in the response (1-1000, default 25).
account_idstring
ID of a single account to filter by. If not provided, returns activities for all accounts.
page_tokenstring
Activity ID of the end of your current page of results. Use for pagination to retrieve subsequent pages.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Account Activities V2ALPACA_GET_ACCOUNT_ACTIVITIES2Acción

Retrieves account activities of one type for the authenticated Alpaca account using the v2 API. Use this action when you need to retrieve transaction history, dividend payments, interest payments, fees, transfers, or order fill activities. Supports filtering by date range, activity types, and sorting direction. Results are paginated using page_token for efficient retrieval of large datasets. This action is read-only and does not modify any data.

Parámetros de entrada

datestring
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.
afterstring
The response will contain only activities submitted after this date. Cannot be used with 'date' parameter.
untilstring
The response will contain only activities submitted before this date. Cannot be used with 'date' parameter.
directionstringenum
Sort direction for activity results.
ascdesc
page_sizeinteger
The maximum number of entries to return in the response (1-10000, default 25).
page_tokenstring
The ID of the end of your current page of results. Use for pagination.
activity_typesstring
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Account Activities By Activity TypeALPACA_GET_ACCOUNT_ACTIVITIES_BY_ACTIVITY_TYPEAcción

Retrieves 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.

Parámetros de entrada

datestring
The date for which you want to see activities in YYYY-MM-DD format. Cannot be used with 'after' parameter.
afterstring
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.
untilstring
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.
directionstringenum
Sort direction for activity results.
ascdesc
page_sizeinteger
The maximum number of entries to return in the response (default 25).
page_tokenstring
The ID of the end of your current page of results for pagination.
activity_typestringObligatorioenum
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.
FILLTRANSFERDIVINTFEECOMMINTERESTOTHERJNLCJNLSACATSCASH_IN+3

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Account ConfigurationsALPACA_GET_ACCOUNT_CONFIGAcción

Retrieves 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Account Portfolio HistoryALPACA_GET_ACCOUNT_PORTFOLIO_HISTORYAcción

Retrieves 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.

Parámetros de entrada

periodstringenum
Duration of portfolio history data.
1D1W1M3M6M1A
date_endstringdate
End date for the data in YYYY-MM-DD format. Defaults to current market date.
timeframestringenum
Time resolution for portfolio history data points.
1Min5Min15Min1H1D
extended_hoursboolean
If true, include extended hours in results. Only effective for timeframe less than 1D.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Account Portfolio HistoryALPACA_GET_ACCOUNT_PORTFOLIO_HISTORY1Acción

Retrieves 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.

Parámetros de entrada

endstringdate-time
End timestamp in RFC3339 format (e.g., 2024-01-15T16:00:00Z).
startstringdate-time
Start timestamp in RFC3339 format (e.g., 2024-01-15T09:30:00Z).
periodstringenum
Duration of portfolio history data.
1D1W1M3M6M1A
date_endstringdate
End date for the data in YYYY-MM-DD format. Defaults to current market date.
pnl_resetstringenum
Defines how baseline values for Profit and Loss are calculated.
ALLDAY
timeframestringenum
Time resolution for portfolio history data points.
1Min5Min15Min1H1D
account_idstring
The unique identifier of the trading account. Not required - the authenticated account is used automatically.
extended_hoursboolean
If true, include extended hours in results. Only effective for timeframe less than 1D.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All Account PositionsALPACA_GET_ACCOUNTS_POSITIONSAcción

Bulk 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All Open PositionsALPACA_GET_ALL_OPEN_POSITIONSAcción

Retrieves all open positions for the authenticated Alpaca trading account. Use this action when you need to retrieve all current positions, monitor 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. The response is updated live as price information changes.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All OrdersALPACA_GET_ALL_ORDERSAcción

Retrieves 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.

Parámetros de entrada

afterstring
Only include orders submitted after this timestamp (exclusive). Format: ISO8601.
limitinteger
Maximum number of orders to return. Defaults to 50, maximum is 500.
untilstring
Only include orders submitted until this timestamp (exclusive). Format: ISO8601.
nestedboolean
If true, nested multi-leg orders are included under the legs field.
statusstringenum
Possible status filter values for querying orders.
openclosedall
symbolsstring
Comma-separated list of symbols to filter by (e.g., 'AAPL,TSLA,MSFT').
directionstringenum
Possible direction values for ordering results.
ascdesc

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Historical Crypto US BarsALPACA_GET_ALPACA_DATA_CRYPTO_US_BARSAcción

Retrieves historical OHLCV (Open, High, Low, Close, Volume) bars for crypto symbols in a specific US location. Use this action when you need to analyze historical price movements and trading activity for cryptocurrency pairs 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. Note: This endpoint uses the data.alpaca.markets base URL and requires the 'us' location path parameter.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Bars for Multiple SymbolsALPACA_GET_BARS_FOR_MULTIPLE_CRYPTO_SYMBOLSAcción

Retrieves OHLCV (Open, High, Low, Close, Volume) bars for multiple crypto symbols. Use this action when you need to: - Get historical price data for multiple crypto symbols - Analyze price trends over a specific timeframe - Fetch aggregated bar data for multiple cryptocurrencies 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.

Parámetros de entrada

endstring
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000
startstring
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
symbolsstringObligatorio
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
exchangesstring
A comma separated list of which crypto exchanges to pull the data from. Alpaca currently supports 'ERSX', 'CBSE', and 'FTXU'
timeframestringObligatorio
Timeframe for the aggregation. Values are customizable, frequently used examples: 1Min, 15Min, 1Hour, 1Day. Limits: 1Min-59Min, 1Hour-23Hour
page_tokenstring
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Stock Bars for Multiple SymbolsALPACA_GET_BARS_FOR_MULTIPLE_STOCK_SYMBOLSAcción

Retrieves 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.

Parámetros de entrada

endstring
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
feedstringenum
Market data feed sources for stock data.
iexsipotc
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000.
startstring
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
symbolsstringObligatorio
The comma-separated list of stock ticker symbols to query for.
timeframestringObligatorio
Timeframe for the aggregation. Values are customizable, frequently used examples: 1Min, 15Min, 1Hour, 1Day. Limits: 1Min-59Min, 1Hour-23Hour
adjustmentstringenum
Corporate action adjustment options for stock bars data.
rawsplitdividendall
page_tokenstring
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Historical Bars for Stock SymbolALPACA_GET_BARS_FOR_STOCK_SYMBOLAcción

Parámetros de entrada

endstring
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
feedstringenum
Supported stock data feeds for Alpaca.
iexsipotc
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000.
startstring
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
symbolstringObligatorio
The stock ticker symbol to query for
timeframestringObligatorio
Timeframe for the aggregation. Format: number + unit (e.g., '1Min', '15Min', '1Hour', '1Day'). Valid units: Min (1-59), Hour (1-23), Day
adjustmentstringenum
Corporate action adjustment types for bars data.
rawsplitdividendall
page_tokenstring
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Historical Stock BarsALPACA_GET_BARS_STOCKSAcción

Retrieves 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.

Parámetros de entrada

endstring
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
feedstringenum
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).
iexsipotc
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000.
startstring
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
symbolstringObligatorio
The stock ticker symbol to query for
timeframestringObligatorio
Timeframe for the aggregation. Values are customizable, frequently used examples: 1Min, 15Min, 1Hour, 1Day. Limits: 1Min-59Min, 1Hour-23Hour
adjustmentstringenum
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.
rawsplitdividendall
page_tokenstring
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CalendarALPACA_GET_CALENDARAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ClockALPACA_GET_CLOCKAcción

Retrieves 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Stock ConditionsALPACA_GET_CONDITIONSAcción

Retrieves 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.

Parámetros de entrada

tapestringObligatorioenum
The tape/exchange group for conditions. 'A' and 'B' return CTS conditions, 'C' returns UTP conditions.
ABC
typestringObligatorioenum
The type of conditions to retrieve. Must be either 'trade' or 'quote'.
tradequote

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Latest QuotesALPACA_GET_CRYPTO_LATEST_QUOTESAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Perp Latest BarsALPACA_GET_CRYPTO_PERP_LATEST_BARSAcción

Retrieves 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.

Parámetros de entrada

locstringObligatorio
Location for the crypto perps data. Common values include 'global' for global market data.
symbolsstringObligatorio
A comma-separated list of crypto perpetual symbols to get latest bars for

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Perp Latest OrderbooksALPACA_GET_CRYPTO_PERP_LATEST_ORDER_BOOKSAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Perp Latest PricingALPACA_GET_CRYPTO_PERP_LATEST_PRICINGAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Perp Latest QuotesALPACA_GET_CRYPTO_PERP_LATEST_QUOTESAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Perp Latest TradesALPACA_GET_CRYPTO_PERP_LATEST_TRADESAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Perps Global Latest BarsALPACA_GET_CRYPTO_PERPS_GLOBAL_LATEST_BARSAcción

Retrieves 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. Returns the most recent bar for each requested symbol, including open, high, low, close prices, volume, trade count, and volume-weighted average price.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Perps Global Latest PricingALPACA_GET_CRYPTO_PERPS_GLOBAL_LATEST_PRICINGAcción

Returns the latest pricing data for crypto perpetual futures symbols. Use this action when you need to retrieve current market data for crypto perpetual futures contracts including mark price, index price, open interest, and funding rate.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Perps Global Latest QuotesALPACA_GET_CRYPTO_PERPS_GLOBAL_LATEST_QUOTESAcción

Retrieves the latest bid and ask prices for specified crypto perpetual futures symbols. 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Perps Global Latest TradesALPACA_GET_CRYPTO_PERPS_GLOBAL_LATEST_TRADESAcción

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto SnapshotsALPACA_GET_CRYPTO_SNAPSHOTSAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto US Latest BarsALPACA_GET_CRYPTO_US_LATEST_BARSAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto US Latest OrderbooksALPACA_GET_CRYPTO_US_LATEST_ORDER_BOOKSAcción

Retrieves 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.

Parámetros de entrada

symbolsstringObligatorio
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'.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto US Latest QuotesALPACA_GET_CRYPTO_US_LATEST_QUOTESAcción

Retrieves 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.

Parámetros de entrada

symbolsstringObligatorio
Comma-separated list of crypto symbols to query. Note, all crypto symbols must be appended with 'USD', e.g., 'BTC/USD,ETH/USD'

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto US Latest TradesALPACA_GET_CRYPTO_US_LATEST_TRADESAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto US Historical QuotesALPACA_GET_CRYPTO_US_QUOTESAcción

Retrieves historical quote data (bid/ask prices) for specified crypto symbols on US exchanges. Returns quotes sorted by symbol first, then by timestamp. Use when you need: - Historical bid/ask price data for cryptocurrency pairs - Analyzing spread patterns over time - Backtesting trading strategies with quote data - Studying market microstructure with bid/ask sizes Note: Historical quotes for US-1 location only go back to October 14, 2025.

Parámetros de entrada

endstring
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.
sortstringenum
Sort order for historical data.
ascdesc
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000.
startstring
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.
symbolsstringObligatorio
Comma-separated list of crypto symbols to query. Note: all crypto symbols must use format 'BTC/USD', e.g., 'BTC/USD,ETH/USD'
page_tokenstring
Pagination token to continue from. The value to pass here is returned in responses when more data is available than the request limit allows.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto US SnapshotsALPACA_GET_CRYPTO_US_SNAPSHOTSAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto US TradesALPACA_GET_CRYPTO_US_TRADESAcción

Retrieves 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.

Parámetros de entrada

endstring
Filter data equal to or before this time in RFC-3339 format or YYYY-MM-DD. Defaults to current time.
sortstring
Sort order for the results. Must be 'asc' or 'desc', defaults to 'asc'.
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000.
startstring
Filter data equal to or after this time in RFC-3339 format or YYYY-MM-DD. Defaults to the beginning of current day.
symbolsstringObligatorio
Comma-separated list of crypto symbols to query for (e.g., BTC/USD,LTC/USD)
page_tokenstring
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ExchangesALPACA_GET_EXCHANGESAcción

Retrieves 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Latest Bar for Stock SymbolALPACA_GET_LATEST_BAR_FOR_STOCK_SYMBOLAcción

Retrieves 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.

Parámetros de entrada

feedstringenum
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).
iexsipotc
symbolstringObligatorio
The stock ticker symbol to query for

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Latest Bars For Crypto SymbolALPACA_GET_LATEST_BARS_FOR_CRYPTO_SYMBOLAcción

Retrieves the latest OHLCV (Open, High, Low, Close, Volume) bar data for a crypto symbol. Use this action when you need real-time or near real-time price data for a specific cryptocurrency pair. Returns the most recent bar including open, high, low, close prices, volume, trade count, and volume-weighted average price.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Latest Bars for Crypto SymbolsALPACA_GET_LATEST_BARS_FOR_CRYPTO_SYMBOLSAcción

Retrieves 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.

Parámetros de entrada

locstringObligatorioenum
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.
usus-1us-2eu-1bs-1
symbolsstringObligatorio
Comma-separated list of crypto symbols to get latest bars for. Use slash notation with USD suffix, e.g., 'BTC/USD,ETH/USD'

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Latest Bars for Multiple Stock SymbolsALPACA_GET_LATEST_BARS_FOR_MULTIPLE_STOCK_SYMBOLSAcción

Retrieves 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.

Parámetros de entrada

feedstringenum
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).
iexsipotc
symbolsstringObligatorio
A comma-separated list of stock ticker symbols to query for (e.g., AAPL,TSLA,MSFT)

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Latest OrderbooksALPACA_GET_LATEST_ORDER_BOOKS_FOR_CRYPTOAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Latest QuoteALPACA_GET_LATEST_QUOTE_FOR_CRYPTO_SYMBOLAcción

Retrieves 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.

Parámetros de entrada

symbolstringObligatorio
The crypto symbol to query for. Format: 'BTC/USD', 'ETH/USD', 'SOL/USD'

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Latest Quote for Stock SymbolALPACA_GET_LATEST_QUOTE_FOR_STOCK_SYMBOLAcción

Retrieves 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.

Parámetros de entrada

feedstringenum
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).
iexsipotc
symbolstringObligatorio
The stock ticker symbol to query for

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto Latest QuotesALPACA_GET_LATEST_QUOTES_FOR_MULTIPLE_CRYPTO_SYMBOLSAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Latest Quotes for Multiple Stock SymbolsALPACA_GET_LATEST_QUOTES_FOR_MULTIPLE_STOCK_SYMBOLSAcción

Retrieves 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.

Parámetros de entrada

feedstringenum
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).
iexsipotc
symbolsstringObligatorio
A comma-separated list of stock ticker symbols to query for (e.g., AAPL,TSLA,MSFT)

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Latest Trade for Stock SymbolALPACA_GET_LATEST_TRADE_FOR_STOCK_SYMBOLAcción

Retrieves 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.

Parámetros de entrada

feedstringenum
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).
iexsipotc
symbolstringObligatorio
The stock ticker symbol to query for

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Latest Crypto TradesALPACA_GET_LATEST_TRADES_FOR_MULTIPLE_CRYPTO_SYMBOLSAcción

Retrieves 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.

Parámetros de entrada

symbolsstringObligatorio
Comma-separated list of crypto symbols to query. Note, all crypto symbols must be appended with 'USD', e.g., 'BTCUSD,ETHUSD'
exchangestringObligatorioenum
Which crypto exchange to pull data from. Supported: ERSX, CBSE, FTXU
ERSXCBSEFTXU

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Latest Trades for Multiple Stock SymbolsALPACA_GET_LATEST_TRADES_FOR_MULTIPLE_STOCK_SYMBOLSAcción

Retrieves 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.

Parámetros de entrada

feedstringenum
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).
iexsipotc
symbolsstringObligatorio
A comma-separated list of stock ticker symbols to query for (e.g., AAPL,TSLA,MSFT)

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Market CalendarALPACA_GET_MARKET_CALENDARAcción

Retrieves 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.

Parámetros de entrada

endstring
The last date to retrieve data for (inclusive), in YYYY-MM-DD format
startstring
The first date to retrieve data for (inclusive), in YYYY-MM-DD format
marketstringObligatorio
The market exchange to query (e.g., 'NYSE', 'NASDAQ', 'CRYPTO', 'FX')

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Meta ExchangesALPACA_GET_META_EXCHANGESAcción

Retrieves a list of all US stock exchanges and their identifying information from the Alpaca Market Data API. Use this action when you need to: - Get details about available stock exchanges for order routing - Understand the market structure and exchange types - Map exchange IDs to their names and types - Get participant IDs for market data filtering This is a read-only action that queries the stocks meta exchanges endpoint.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Most Active StocksALPACA_GET_MOST_ACTIVESAcción

Retrieves 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.

Parámetros de entrada

bystringenum
Metric used for ranking most active stocks.
volumetrades
topinteger
Number of top most active stocks to return. Range: 1-100, default: 10

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get NewsALPACA_GET_NEWSAcción

Retrieves 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.

Parámetros de entrada

endstring
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
sortstringenum
Sort order for news articles.
DESCASC
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000.
startstring
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
symbolsstringObligatorio
The comma-separated list of crypto symbols to query for. Note, currently all crypto symbols must be appended with 'USD', e.g., 'BTCUSD,ETHUSD'
page_tokenstring
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.
include_contentboolean
Boolean indicator to include content for news articles (if available)
exclude_contentlessboolean
Boolean indicator to exclude news articles that do not contain content

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Open PositionALPACA_GET_OPEN_POSITIONAcción

Fetches 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Options Historical BarsALPACA_GET_OPTION_BARSAcción

Retrieves 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.

Parámetros de entrada

endstring
Inclusive end time in RFC-3339 format or YYYY-MM-DD format
sortstringenum
Sort order for bar data.
ascdesc
limitinteger
Number of data points to return. Default: 1000, max: 10000. The limit applies to total data points across all symbols, not per symbol.
startstring
Inclusive start time in RFC-3339 format or YYYY-MM-DD format
symbolsstringObligatorio
Comma-separated list of option contract symbols (max 100 symbols)
timeframestringObligatorio
The timeframe for the bars. Format: number + unit (e.g., '1Min', '5Min', '1Hour', '1Day', '1Week', '1Month'). Units: Min, Hour, Day, Week, Month
page_tokenstring
Pagination token for retrieving the next page of results

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Option ChainALPACA_GET_OPTION_CHAINAcción

Retrieves the option chain for a specific underlying symbol including quotes and greeks for all available strikes and expirations. Use this action when you need comprehensive option market data for a specific underlying asset, such as analyzing option strategies, comparing strikes/expirations, or viewing real-time quotes and Greeks.

Parámetros de entrada

feedstring
The data feed source to use. If not specified, the API uses whatever is configured for the account
typestringenum
Option contract type filter.
callput
expiration_datestring
Filter by exact expiration date (YYYY-MM-DD format)
strike_price_gtenumber
Filter contracts with strike price greater than or equal to this value
strike_price_ltenumber
Filter contracts with strike price less than or equal to this value
underlying_symbolstringObligatorio
The underlying asset symbol (e.g., AAPL, SPY)
expiration_date_gtestring
Filter contracts expiring on or after this date (YYYY-MM-DD format)
expiration_date_ltestring
Filter contracts expiring on or before this date (YYYY-MM-DD format)

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Option ContractALPACA_GET_OPTION_CONTRACT_SYMBOL_OR_IDAcción

Get an option contract by its symbol or unique identifier. Use this action when you need to retrieve detailed information about a specific option contract. You can query by either the contract's OCC symbol (e.g., 'AAPL250620C00100000') or its unique Alpaca ID. This endpoint is useful for getting contract specifications before placing orders or for retrieving current market data for a specific option. Note: This is a BETA endpoint and may be subject to changes.

Parámetros de entrada

symbol_or_idstringObligatorio
The option contract symbol (e.g., 'AAPL250620C00100000') or ID

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Option Latest QuotesALPACA_GET_OPTION_LATEST_QUOTESAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Options Meta ConditionsALPACA_GET_OPTION_META_CONDITIONSAcción

Retrieves 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.

Parámetros de entrada

ticktypestringObligatorioenum
The tick type for the conditions. Must be one of: 'trade' or 'quote'
tradequote

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Option ContractsALPACA_GET_OPTIONS_CONTRACTSAcción

Retrieve 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.

Parámetros de entrada

typestringenum
Option contract type.
callput
limitinteger
Number of contracts to return per page. Default: 100, max: 10000
ppindboolean
Penny Program Indicator - filter for contracts eligible for penny price increments
stylestringenum
Option contract style.
americaneuropean
statusstring
Filter by contract status (active or inactive). Default: active
page_tokenstring
Pagination token for retrieving the next page of results
root_symbolstring
Filter contracts by root symbol
expiration_datestring
Filter by exact expiration date (YYYY-MM-DD format)
strike_price_gtenumber
Filter contracts with strike price greater than or equal to this value
strike_price_ltenumber
Filter contracts with strike price less than or equal to this value
show_deliverablesboolean
Include deliverables array in the response
underlying_symbolsstring
Filter contracts by one or more underlying symbols. Multiple symbols can be comma-separated
expiration_date_gtestring
Filter contracts expiring on or after this date (YYYY-MM-DD format)
expiration_date_ltestring
Filter contracts expiring on or before this date (YYYY-MM-DD format). Default: next weekend

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Options Latest TradesALPACA_GET_OPTIONS_LATEST_TRADESAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Options Meta Conditions TradeALPACA_GET_OPTIONS_META_CONDITIONS_TRADEAcción

Retrieves 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Options SnapshotsALPACA_GET_OPTION_SNAPSHOTSAcción

Retrieves 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.

Parámetros de entrada

symbolsstringObligatorio
Comma-separated list of option contract symbols to query (e.g., 'AAPL240621C00150000'). Max 250 symbols per request.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Options Snapshots by Underlying SymbolALPACA_GET_OPTIONS_SNAPSHOTS_UNDERLYING_SYMBOLAcción

Retrieves the option chain snapshot data for a specific underlying symbol. This endpoint provides the latest trade, quote, and greeks data for all option contracts associated with an underlying symbol. It returns snapshots including delta, gamma, theta, vega, implied volatility, and real-time bid/ask prices. Use when you need to analyze an entire option chain - checking all available strike prices and expiration dates for a given underlying asset, including their Greeks and current market pricing. This is useful for: - Building option chains for analysis - Finding specific strike/expiration combinations - Analyzing Greeks across an entire chain - Detecting unusual option activity

Parámetros de entrada

feedstringenum
Data feed source for option market data.
opraindicative
typestringenum
Option contract type.
callput
limitinteger
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
page_tokenstring
The pagination token from which to continue
root_symbolstring
Filter contracts by the root symbol
updated_sincestring
Filter to snapshots that were updated since this timestamp. Format: RFC-3339 or YYYY-MM-DD
expiration_datestring
Filter contracts by the exact expiration date (format: YYYY-MM-DD)
strike_price_gtenumber
Filter contracts with strike price greater than or equal to the specified value
strike_price_ltenumber
Filter contracts with strike price less than or equal to the specified value
underlying_symbolstringObligatorio
The ticker symbol of the underlying asset (e.g., 'AAPL', 'SPY')
expiration_date_gtestring
Filter contracts with expiration date greater than or equal to the specified date (format: YYYY-MM-DD)
expiration_date_ltestring
Filter contracts with expiration date less than or equal to the specified date (format: YYYY-MM-DD)

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Options Historical TradesALPACA_GET_OPTION_TRADESAcción

Retrieves 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.

Parámetros de entrada

endstring
Inclusive end time in RFC-3339 format or YYYY-MM-DD format
limitinteger
Number of trades to return per symbol. Default: 25, max: 10000
startstring
Inclusive start time in RFC-3339 format or YYYY-MM-DD format
symbolsstringObligatorio
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
page_tokenstring
Pagination token for retrieving the next page of results

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get PDT StatusALPACA_GET_PDT_STATUSAcción

Retrieves the Pattern Day Trader (PDT) status for a specified Alpaca trading account. Use when you need to check if an account is flagged as a PDT, monitor PDT call counts, or verify day trading buying power status for regulatory compliance. PDT rules apply to accounts that execute more than 3 day trades within 5 business days when holding a cash account or using margin. This endpoint helps monitor and track PDT-related information for accounts.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List account positionsALPACA_GET_POSITIONS_FOR_ACCOUNTAcción

Lists all open positions for a specified trading account. Use when you need to retrieve current positions, monitor portfolio holdings, or check unrealized P&L for an account.

Parámetros de entrada

account_idstringObligatorio
The unique identifier of the trading account.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Quotes for Multiple Stock SymbolsALPACA_GET_QUOTES_FOR_MULTIPLE_STOCK_SYMBOLSAcción

Retrieves 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.

Parámetros de entrada

endstring
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
feedstringenum
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).
iexsipotc
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000 if not specified.
startstring
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
symbolsstringObligatorio
A comma-separated list of stock ticker symbols to query for (e.g., AAPL,TSLA,MSFT). Required.
page_tokenstring
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Quotes for Stock SymbolALPACA_GET_QUOTES_FOR_STOCK_SYMBOLAcción

Retrieves 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.

Parámetros de entrada

endstring
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
feedstringenum
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).
iexsipotc
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000.
startstring
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
symbolstringObligatorio
The stock ticker symbol to query for (e.g., AAPL, TSLA, MSFT)
page_tokenstring
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Stock Snapshot for SymbolALPACA_GET_SNAPSHOT_FOR_STOCK_SYMBOLAcción

Retrieves 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.

Parámetros de entrada

feedstringenum
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).
iexsipotc
symbolstringObligatorio
The stock ticker symbol to query for

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crypto SnapshotsALPACA_GET_SNAPSHOTS_FOR_MULTIPLE_CRYPTO_SYMBOLSAcción

Retrieves 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.

Parámetros de entrada

symbolsstringObligatorio
Comma-separated list of crypto symbols to query for. All crypto symbols must be appended with USD (e.g., BTCUSD,ETHUSD)
exchangestringenum
Supported crypto exchanges for snapshot data.
ERSXCBSEFTXU

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Stock Snapshots for Multiple SymbolsALPACA_GET_SNAPSHOTS_FOR_MULTIPLE_STOCK_SYMBOLSAcción

Retrieves 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.

Parámetros de entrada

feedstringenum
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).
iexsipotc
symbolsstringObligatorio
A comma-separated list of stock ticker symbols to query for (e.g., AAPL,TSLA,MSFT)

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Specific AnnouncementALPACA_GET_SPECIFIC_ANNOUNCEMENTAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Stock AuctionsALPACA_GET_STOCK_AUCTIONSAcción

Retrieves 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Stock Auctions for SymbolALPACA_GET_STOCK_AUCTION_SINGLEAcción

Retrieves 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.

Parámetros de entrada

endstring
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
feedstringenum
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).
iexsipotc
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000.
startstring
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
symbolstringObligatorio
The stock ticker symbol to query for
page_tokenstring
Pagination token to continue from. The value to pass here is returned in requests when more data is available than the request limit allows.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Stocks Meta Conditions TradeALPACA_GET_STOCKS_META_CONDITIONS_TRADEAcción

Retrieves 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 stock market data - Get the list of all valid trade condition codes and their meanings - Translate raw condition code integers to human-readable names - Understand the meaning of condition codes from trade data This is a read-only action that queries the stocks meta conditions trade endpoint.

Parámetros de entrada

tapestringObligatorioenum
The tape/exchange group for conditions. 'A' and 'B' return CTS (Consolidated Tape System) conditions, 'C' returns UTP (Unified Tape Plan) conditions.
ABC

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get SubscriptionALPACA_GET_SUBSCRIPTIONAcción

Retrieves 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.

Parámetros de entrada

subscription_idstringObligatorio
The unique identifier of the rebalancing subscription to retrieve.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Top Movers By Market TypeALPACA_GET_TOP_MOVERS_BY_MARKET_TYPEAcción

Retrieves 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.

Parámetros de entrada

topinteger
Number of top market movers to fetch (gainers and losers). By default returns 10 gainers and 10 losers.
market_typestringObligatorioenum
The market type to screen. Use 'stocks' for equities or 'crypto' for cryptocurrency.
stockscrypto

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Trades for Multiple Crypto SymbolsALPACA_GET_TRADES_FOR_MULTIPLE_CRYPTO_SYMBOLSAcción

Retrieves 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.

Parámetros de entrada

endstring
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000.
startstring
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
symbolsstringObligatorio
Comma-separated list of crypto symbols to query for. Use '/' format, e.g., 'BTC/USD,ETH/USD'
exchangesstring
Comma-separated list of crypto exchanges to pull data from. Alpaca supports 'ERSX', 'CBSE', and 'FTXU'
page_tokenstring
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Trades for Multiple Stock SymbolsALPACA_GET_TRADES_FOR_MULTIPLE_STOCK_SYMBOLSAcción

Retrieves 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.

Parámetros de entrada

endstring
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
feedstringenum
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).
iexsipotc
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000.
startstring
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
symbolsstringObligatorio
The comma-separated list of stock ticker symbols to query for.
page_tokenstring
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Historical Trades for Stock SymbolALPACA_GET_TRADES_FOR_STOCK_SYMBOLAcción

Retrieves historical trade data for a single stock symbol. Use this action when you need to analyze historical trade data for a specific stock ticker, such as reviewing price movements, trading volume patterns, or tick data analysis. Each trade record includes price, size, exchange, timestamp, and trade conditions. Note: This endpoint uses the data.alpaca.markets base URL.

Parámetros de entrada

endstring
Filter data equal to or before this time in RFC-3339 format. Fractions of a second are not accepted.
feedstringenum
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).
iexsipotc
limitinteger
Number of data points to return. Must be in range 1-10000, defaults to 1000.
startstring
Filter data equal to or after this time in RFC-3339 format. Fractions of a second are not accepted.
symbolstringObligatorio
The stock ticker symbol to query for
page_tokenstring
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.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Watchlist By IDALPACA_GET_WATCHLIST_BY_IDAcción

Retrieves 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.

Parámetros de entrada

watchlist_idstringObligatorio
Unique identifier of the watchlist (UUID format).

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Watchlist By NameALPACA_GET_WATCHLIST_BY_NAMEAcción

Retrieves 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.

Parámetros de entrada

namestringObligatorio
The name of the watchlist to retrieve.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get WatchlistsALPACA_GET_WATCHLISTSAcción

Retrieves 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Account ConfigurationsALPACA_PATCH_ACCOUNT_CONFIGURATIONSAcción

Update 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.

Parámetros de entrada

pdt_checkstring
Pattern Day Trader check setting. Controls whether PDT restrictions are enforced.
dtbp_checkstringenum
Controls Day Trading Margin Call (DTMC) checks.
bothentryexit
no_shortingboolean
If true, the account becomes long-only mode and cannot short positions.
suspend_tradeboolean
If true, all new orders are blocked. Existing orders are not affected. Use this to halt trading quickly.
fractional_tradingboolean
If true, the account is able to participate in fractional trading. If false or omitted, fractional trading is disabled.
trade_confirm_emailstringenum
Controls trade confirmation email settings.
allnone
max_margin_multiplierstring
Maximum margin multiplier. Can be '1' for cash account or '2' for margin account.

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Asset From WatchlistALPACA_REMOVE_ASSET_FROM_WATCHLISTAcción

Removes 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Symbol From WatchlistALPACA_REMOVE_SYMBOL_FROM_WATCHLISTAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Trading ConfigurationsALPACA_UPDATE_TRADING_CONFIGURATIONSAcción

Updates 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.

Parámetros de entrada

frozenboolean
When set to true, the account is frozen and cannot trade
account_idstring
The ID of the trading account whose configurations to update (optional - not used in v2 endpoint)
dtbp_checkstringenum
Enum for day-trading buying power check options.
entryexitboth
no_shortingboolean
When set to true, the account is restricted from shorting
plaid_settingstring
Plaid setting for the account
suspend_tradeboolean
When set to true, all trading activity is suspended for the account
enable_crypto_sendboolean
When set to true, enables crypto sending capability for the account
crypto_auto_convertboolean
When set to true, crypto assets are automatically converted to USD
trade_confirm_emailstringenum
Enum for trade confirmation email settings.
allnoneimpliedimplied_daily

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Watchlist By IDALPACA_UPDATE_WATCHLIST_BY_IDAcción

Updates an existing watchlist by its unique identifier. Use when you need to modify the name or symbols in a watchlist using its ID rather than name. This action allows partial updates - you can update just the name, just the symbols, or both at once. The watchlist_id identifies which watchlist to update and is provided in the request. Note: The symbols field, if provided, will replace all existing symbols in the watchlist.

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Watchlist By NameALPACA_UPDATE_WATCHLIST_BY_NAMEAcción

Updates 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).

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Watchlist By Name (v2)ALPACA_UPDATE_WATCHLIST_BY_NAME2Acción

Parámetros de entrada

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

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload Account CIP InformationALPACA_UPLOAD_ACCOUNT_CIPAcción

Upload 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.

Parámetros de entrada

account_idstringObligatorio
The unique identifier of the trading account
cip_resultobjectObligatorio
CIP result object containing identity information for verification

Parámetros de salida

dataanyObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not