Skip to docs navigation

Alpaca integration guide

Verified

How to connect Alpaca to WEXTL and use its 3 triggers and 93 actions in your workflows. About Alpaca: Trading and market data API for stocks, options and crypto.

  • 3 triggers
  • 72 searches
  • 21 actions
  • Polling
  • Auth: API key

AI-assisted documentation34 min read

This documentation is compiled from our integration source code, internal specs for Alpaca, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Alpaca on WEXTL →
  • Alpaca
  • WEXTL
  • Bybit
  • CoinGecko
  • Daftra
  • Clientary
  • Coinbase
  • 1C:Enterprise (OData)
  • Billingo
  • Billtrust
  • Altoviz
  • Capium
  • BlueSnap
  • Checkout
  • Comanage
  • ApproveIt
  • Billogram
  • Distru
  • Billdu
  • Debitura
  • Credit Repair Cloud
  • Adyen
  • BTCPay Server
  • Chargebee
  • Commas
  • bexio
  • Brex
  • Corpay
  • Candis
  • Bill
  • Bling
  • Key IDtextRequired

    In the dashboard open API Keys for the paper or the live account and generate a key. A paper key does not work on live and the reverse.[1]

  • Secret KeypasswordRequired

    Alpaca shows the secret key only once, when you generate it. Copy it right away.[1]

  • EnvironmentselectRequired

    Pick the account the key belongs to. Live orders spend real money. Market data comes from the same host for both.[1]

  1. Log in to your WEXTL account, add the Alpaca node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Alpaca account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Account Activity

TriggerScheduled check of account events.
Output fields[3]
FieldType
Activity Timedate
Activity Typetext
Cum Quantitytext
IDtext
Leaves Quantitytext
Order IDtext
Order Statustext
Pricetext
Quantitytext
Sidetext
Symboltext
Transaction Timedate
Typetext

9other output fields

Watch New Fills

TriggerScheduled check for filled orders.
Output fields[3]
FieldType
Activity Typetext
Cum Quantitytext
IDtext
Leaves Quantitytext
Order IDtext
Order Statustext
Pricetext
Quantitytext
Sidetext
Symboltext
Transaction Timedate
Typetext
Activity Sub Typetext

8other output fields

Watch New Orders

TriggerFresh orders found on a schedule.
Output fields[3]
FieldType
Asset Classtext
Asset IDtext
Canceled Atdate
Client Order IDtext
Created Atdate
Expired Atdate
Expires Atdate
Extended Hoursboolean
Failed Atdate
Filled Atdate
Filled Avg Pricetext
Filled Quantitytext
Group IDtext

24other output fields

Get a Corporate Action Announcement

SearchDetails of a dividend or split notice.
Input fields[3]
FieldType
IDRequired
text
Output fields[3]
FieldType
Ca Sub Typetext
Ca Typetext
Cashnumber
Corporate Action IDtext
Declaration Datetext
Effective Datetext
Ex Datetext
IDtext
Initiating Original CUSIPtext
Initiating Symboltext
New Ratenumber
Old Ratenumber
Payable Datetext

3other output fields

Get a Crypto Transfer

SearchProgress of one wallet movement.
Input fields[3]
FieldType
Transfer IDRequired
text
Output fields[3]
FieldType
Amountnumber
Assettext
Chaintext
Created Atdate
Directiontext
Feesnumber
From Addresstext
IDtext
Network Feenumber
Statustext
To Addresstext
Tx Hashtext
Usd Valuenumber

Get a Crypto Transfer Estimate

SearchFee quote before a transfer.
Input fields[3]
FieldType
AssetRequired
text
From AddressRequired
text
To AddressRequired
text
AmountRequired
number
Output fields[3]
FieldType
Feenumber
Network Feenumber

Get a Locate

SearchOutcome of a short locate.
Input fields[3]
FieldType
Locate IDRequired
text
Output fields[3]
FieldType
All Or Noneboolean
Created Atdate
Expires Atdate
IDtext
Limit Pricenumber
Located Pricenumber
Located Quantitynumber
Rejection Reasontext
Requested Quantitynumber
Statustext
Symboltext
Total Feenumber

Get a Logo

SearchCompany logo as an image file.
Input fields[3]
FieldType
SymbolRequired
text
Placeholder If Missingboolean
Output fields[3]
FieldType
Filefile
File Nametext
Size (Bytes)number
Content Typetext

Get a Position

SearchCost basis of one holding.
Input fields[3]
FieldType
PositionRequired
choice
Output fields[3]
FieldType
Asset Classtext
Asset IDtext
Asset Marginableboolean
Avg Entry Pricenumber
Avg Entry Swap Ratenumber
Change Todaynumber
Cost Basisnumber
Current Pricenumber
Exchangetext
Lastday Pricenumber
Market Valuenumber
Prev Swap Ratenumber
Quantitynumber

9other output fields

Get a Stock Snapshot

SearchEverything current about a ticker.
Input fields[3]
FieldType
SymbolRequired
text
Feedchoice
Currencytext
Output fields[3]
FieldType
Daily Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber
Latest Quoteobject
Ask Pricenumber
Ask Sizenumber
Ask Exchangetext
Bid Pricenumber
Bid Sizenumber
Bid Exchangetext
Conditionsarray
Timestampdate
Tapetext
Latest Tradeobject
Conditionsarray
Trade IDnumber
Pricenumber
Sizenumber
Timestampdate
Utext
Exchangetext
Tapetext
Minute Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber
Prev Daily Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber
Currencytext
Symboltext

Get a Tokenization Request

SearchProgress and fees of one request.
Input fields[3]
FieldType
Tokenization Request IDRequired
text
Output fields[3]
FieldType
Client Account IDtext
Client External Account IDtext
Client Request IDtext
Created Atdate
Feesnumber
Issuertext
Issuer Request IDtext
Networktext
Quantitynumber
Statustext
Token Symboltext
Tokenization Request IDtext
Transfer Statustext

5other output fields

Get a Tokenization Request by Client Request ID

SearchRequest lookup by your own label.
Input fields[3]
FieldType
Client Request IDRequired
text
Output fields[3]
FieldType
Client Account IDtext
Client External Account IDtext
Client Request IDtext
Created Atdate
Feesnumber
Issuertext
Issuer Request IDtext
Networktext
Quantitynumber
Statustext
Token Symboltext
Tokenization Request IDtext
Transfer Statustext

5other output fields

Get a Watchlist

SearchTickers saved in one list.
Input fields[3]
FieldType
WatchlistRequired
choice
Output fields[3]
FieldType
Account IDtext
Assetsarray
Created Atdate
IDtext
Nametext
Updated Atdate

Get Account Configurations

SearchTrading switches on the account.
Output fields[3]
FieldType
Disable Overnight Tradingboolean
Fractional Tradingboolean
Max Margin Multipliernumber
Max Options Trading Levelnumber
No Shortingboolean
Ptp No Exception Entryboolean
Suspend Tradeboolean
Trade Confirm Emailtext

Get an Asset

SearchTradability data for one asset.
Input fields[3]
FieldType
Symbol or Asset IDRequired
text
Output fields[3]
FieldType
Attributesarray
Borrow Statustext
Classtext
CUSIPtext
Exchangetext
Fractionableboolean
IDtext
Maintenance Margin Requirementnumber
Margin Requirement Longnumber
Margin Requirement Shortnumber
Marginableboolean
Min Order Sizenumber
Min Trade Incrementnumber

6other output fields

Get an Option Chain

SearchAll option contracts on a stock.
Input fields[3]
FieldType
Underlying SymbolRequired
text
LimitRequired
number
Feedchoice
Typechoice
Strike Price Fromnumber
Strike Price Tonumber
Expiration Datedate
Expiration Date Gtedate
Expiration Date Ltedate
Root Symboltext
Updated Sincedate
Output fields[3]
FieldType
Contract Symboltext
Daily Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber
Greeksobject
Deltanumber
Gammanumber
Rhonumber
Thetanumber
Veganumber
Implied Volatilitynumber
Latest Quoteobject
Ask Pricenumber
Ask Sizenumber
Ask Exchangetext
Bid Pricenumber
Bid Sizenumber
Bid Exchangetext
Ctext
Timestampdate
Latest Tradeobject
Ctext
Pricenumber
Sizenumber
Timestampdate
Exchangetext
Minute Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber
Prev Daily Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber

Get an Option Contract

SearchStrike, expiry and terms of a single option.
Input fields[3]
FieldType
Symbol or Contract IDRequired
text
Output fields[3]
FieldType
Close Pricenumber
Close Price Datetext
Deliverablesarray
Expiration Datetext
IDtext
Multipliernumber
Nametext
Open Interestnumber
Open Interest Datetext
PPINDboolean
Root Symboltext
Sizenumber
Statustext

7other output fields

Get an Order

SearchStatus and fills of one order.
Input fields[3]
FieldType
Order IDRequired
text
Nest Multi-Leg Ordersboolean
Output fields[3]
FieldType
Asset Classtext
Asset IDtext
Canceled Atdate
Client Order IDtext
Created Atdate
Expired Atdate
Expires Atdate
Extended Hoursboolean
Failed Atdate
Filled Atdate
Filled Avg Pricenumber
Filled Quantitynumber
Group IDtext

24other output fields

Get an Order by Client Order ID

SearchOrder lookup by your own reference.
Input fields[3]
FieldType
Client Order IDRequired
text
Output fields[3]
FieldType
Asset Classtext
Asset IDtext
Canceled Atdate
Client Order IDtext
Created Atdate
Expired Atdate
Expires Atdate
Extended Hoursboolean
Failed Atdate
Filled Atdate
Filled Avg Pricenumber
Filled Quantitynumber
Group IDtext

24other output fields

Get Latest Crypto Orderbooks

SearchOrder book depth for crypto pairs.
Input fields[3]
FieldType
LocationRequired
choice
SymbolsRequired
text
LimitRequired
number
Output fields[3]
FieldType
Symboltext
Asksarray
Bidsarray
Timestampdate

Get Locate Quotes

SearchShort locate price quotes.
Input fields[3]
FieldType
SymbolsRequired
text
LimitRequired
number
Output fields[3]
FieldType
Available Quantitynumber
Pricenumber
Quoted Atdate
Symboltext

Get Option Condition Codes

SearchMeaning of option trade flags.
Input fields[3]
FieldType
Tick TypeRequired
choice
Output fields[3]
FieldType
Codesobject

Get Option Exchange Codes

SearchVenue code lookup for options data.
Output fields[3]
FieldType
Codesobject

Get Portfolio History

SearchEquity curve of the account.
Input fields[3]
FieldType
LimitRequired
number
Periodtext
Timeframechoice
Startdate
Enddate
Intraday Reportingchoice
P&L Resetchoice
Cashflow Typestext
Output fields[3]
FieldType
Timestampdate
Equitynumber
Profit Lossnumber
Profit Loss Pctnumber

Get Stock Auctions

SearchAuction prints for a ticker.
Input fields[3]
FieldType
SymbolRequired
text
LimitRequired
number
Startdate
Enddate
As-of Datedate
Currencytext
Sortchoice
Output fields[3]
FieldType
Symboltext
Conditionsarray
Dtext
Openarray

Get Stock Bars

SearchPrice history for a ticker.
Input fields[3]
FieldType
SymbolRequired
text
TimeframeRequired
text
LimitRequired
number
Startdate
Enddate
Adjustmentchoice
As-of Datedate
Feedchoice
Currencytext
Sortchoice
Output fields[3]
FieldType
Symboltext
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber

Get Stock Condition Codes

SearchGlossary of stock trade flags.
Input fields[3]
FieldType
Tick TypeRequired
choice
TapeRequired
choice
Output fields[3]
FieldType
Codesobject

Get Stock Exchange Codes

SearchVenue code glossary for stocks.
Output fields[3]
FieldType
Codesobject

Get Stock Quotes

SearchQuote history for a ticker.
Input fields[3]
FieldType
SymbolRequired
text
LimitRequired
number
Startdate
Enddate
As-of Datedate
Feedchoice
Currencytext
Sortchoice
Output fields[3]
FieldType
Symboltext
Ask Pricenumber
Ask Sizenumber
Ask Exchangetext
Bid Pricenumber
Bid Sizenumber
Bid Exchangetext
Conditionsarray
Timestampdate
Tapetext

Get Stock Trades

SearchTrade tape for a ticker.
Input fields[3]
FieldType
SymbolRequired
text
LimitRequired
number
Startdate
Enddate
As-of Datedate
Feedchoice
Currencytext
Sortchoice
Output fields[3]
FieldType
Symboltext
Conditionsarray
Trade IDnumber
Pricenumber
Sizenumber
Timestampdate
Utext
Exchangetext
Tapetext

Get the Account

SearchBalances and status of the account.
Output fields[3]
FieldType
Account Blockedboolean
Account Numbertext
Accrued Feesnumber
Balance Asoftext
Buying Powernumber
Cashnumber
Created Atdate
Crypto Statustext
Currencytext
Equitynumber
IDtext
Initial Marginnumber
Intraday Adjustmentsnumber

21other output fields

Get the Latest Stock Bar

SearchNewest price bar for a ticker.
Input fields[3]
FieldType
SymbolRequired
text
Feedchoice
Currencytext
Output fields[3]
FieldType
Symboltext
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber

Get the Latest Stock Quote

SearchCurrent bid and ask of a ticker.
Input fields[3]
FieldType
SymbolRequired
text
Feedchoice
Currencytext
Output fields[3]
FieldType
Symboltext
Ask Pricenumber
Ask Sizenumber
Ask Exchangetext
Bid Pricenumber
Bid Sizenumber
Bid Exchangetext
Conditionsarray
Timestampdate
Tapetext

Get the Latest Stock Trade

SearchLast print for a ticker.
Input fields[3]
FieldType
SymbolRequired
text
Feedchoice
Currencytext
Output fields[3]
FieldType
Symboltext
Conditionsarray
Trade IDnumber
Pricenumber
Sizenumber
Timestampdate
Utext
Exchangetext
Tapetext

Get the Market Calendar

SearchTrading days and session hours.
Input fields[3]
FieldType
MarketRequired
choice
LimitRequired
number
Startdate
Enddate
Time Zonechoice
Output fields[3]
FieldType
Core Enddate
Core Startdate
Datetext
Lunch Enddate
Lunch Startdate
Post Enddate
Post Startdate
Pre Enddate
Pre Startdate
Settlement Datetext

Get the Market Clock

SearchOpen or closed state of markets.
Input fields[3]
FieldType
LimitRequired
number
Marketstext
Timedate
Output fields[3]
FieldType
Is Market Dayboolean
Marketobject
Acronymtext
Bictext
Mictext
Nametext
Timezonetext
Next Market Closedate
Next Market Opendate
Phasetext
Phase Untildate
Timestampdate

List Account Activities

SearchFills and cash events on the account.
Input fields[3]
FieldType
LimitRequired
number
Activity Typeschoice
Categorychoice
Order Idtext
Datedate
Afterdate
Untildate
Directionchoice
Output fields[3]
FieldType
Activity Typetext
Cum Quantitynumber
IDtext
Leaves Quantitynumber
Order IDtext
Order Statustext
Pricenumber
Quantitynumber
Sidetext
Symboltext
Transaction Timedate
Typetext
Activity Sub Typetext

8other output fields

List Assets

SearchAssets Alpaca knows about.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
Asset Classchoice
Exchangetext
Attributestext
Output fields[3]
FieldType
Attributesarray
Borrow Statustext
Classtext
CUSIPtext
Exchangetext
Fractionableboolean
IDtext
Maintenance Margin Requirementnumber
Margin Requirement Longnumber
Margin Requirement Shortnumber
Marginableboolean
Min Order Sizenumber
Min Trade Incrementnumber

6other output fields

List Corporate Action Announcements

SearchDividend, split and merger notices.
Input fields[3]
FieldType
TypesRequired
choice
SinceRequired
date
UntilRequired
date
LimitRequired
number
Symboltext
CUSIPtext
Date Typechoice
Output fields[3]
FieldType
Ca Sub Typetext
Ca Typetext
Cashnumber
Corporate Action IDtext
Declaration Datetext
Effective Datetext
Ex Datetext
IDtext
Initiating Original CUSIPtext
Initiating Symboltext
New Ratenumber
Old Ratenumber
Payable Datetext

3other output fields

List Crypto Bars

SearchCandles for crypto pairs over time.
Input fields[3]
FieldType
LocationRequired
choice
SymbolsRequired
text
TimeframeRequired
text
LimitRequired
number
Startdate
Enddate
Sortchoice
Output fields[3]
FieldType
Symboltext
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber

List Crypto Quotes

SearchCrypto bid and ask history.
Input fields[3]
FieldType
LocationRequired
choice
SymbolsRequired
text
LimitRequired
number
Startdate
Enddate
Sortchoice
Output fields[3]
FieldType
Symboltext
Ask Pricenumber
Ask Sizenumber
Bid Pricenumber
Bid Sizenumber
Timestampdate

List Crypto Snapshots

SearchEverything current about crypto pairs.
Input fields[3]
FieldType
LocationRequired
choice
SymbolsRequired
text
LimitRequired
number
Output fields[3]
FieldType
Symboltext
Daily Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber
Latest Quoteobject
Ask Pricenumber
Ask Sizenumber
Bid Pricenumber
Bid Sizenumber
Timestampdate
Latest Tradeobject
Trade IDnumber
Pricenumber
Sizenumber
Timestampdate
Tkstext
Minute Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber
Prev Daily Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber

List Crypto Trades

SearchExecuted crypto prints from the past.
Input fields[3]
FieldType
LocationRequired
choice
SymbolsRequired
text
LimitRequired
number
Startdate
Enddate
Sortchoice
Output fields[3]
FieldType
Symboltext
Trade IDnumber
Pricenumber
Sizenumber
Timestampdate
Tkstext

List Crypto Transfers

SearchHistory of wallet movements.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Amountnumber
Assettext
Chaintext
Created Atdate
Directiontext
Feesnumber
From Addresstext
IDtext
Network Feenumber
Statustext
To Addresstext
Tx Hashtext
Usd Valuenumber

List Crypto Wallets

SearchWallet addresses and chains on your account.
Input fields[3]
FieldType
LimitRequired
number
Assettext
Chainchoice
Output fields[3]
FieldType
Addresstext
Chaintext
Created Atdate

List Latest Bond Prices

SearchNewest bond prices and yields.
Input fields[3]
FieldType
ISINsRequired
text
LimitRequired
number
Output fields[3]
FieldType
ISINtext
Pricenumber
Timestampdate
Ytmnumber
Ytwnumber

List Latest Bond Quotes

SearchNewest bond bid and ask.
Input fields[3]
FieldType
ISINsRequired
text
LimitRequired
number
Trade Sizenumber
Output fields[3]
FieldType
ISINtext
Amsnumber
Ask Pricenumber
Ask Sizenumber
Aytmnumber
Aytwnumber
Bmsnumber
Bid Pricenumber
Bid Sizenumber
Bytmnumber
Bytwnumber
Timestampdate

List Latest Crypto Bars

SearchLatest candles for crypto pairs.
Input fields[3]
FieldType
LocationRequired
choice
SymbolsRequired
text
LimitRequired
number
Output fields[3]
FieldType
Symboltext
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber

List Latest Crypto Quotes

SearchTop of book for crypto pairs.
Input fields[3]
FieldType
LocationRequired
choice
SymbolsRequired
text
LimitRequired
number
Output fields[3]
FieldType
Symboltext
Ask Pricenumber
Ask Sizenumber
Bid Pricenumber
Bid Sizenumber
Timestampdate

List Latest Crypto Trades

SearchLast prints for crypto pairs.
Input fields[3]
FieldType
LocationRequired
choice
SymbolsRequired
text
LimitRequired
number
Output fields[3]
FieldType
Symboltext
Trade IDnumber
Pricenumber
Sizenumber
Timestampdate
Tkstext

List Latest Option Quotes

SearchCurrent option market quotes.
Input fields[3]
FieldType
SymbolsRequired
text
LimitRequired
number
Feedchoice
Output fields[3]
FieldType
Contract Symboltext
Ask Pricenumber
Ask Sizenumber
Ask Exchangetext
Bid Pricenumber
Bid Sizenumber
Bid Exchangetext
Ctext
Timestampdate

List Latest Option Trades

SearchMost recent option fills.
Input fields[3]
FieldType
SymbolsRequired
text
LimitRequired
number
Feedchoice
Output fields[3]
FieldType
Contract Symboltext
Ctext
Pricenumber
Sizenumber
Timestampdate
Exchangetext

List Latest Stock Bars

SearchLatest candles for many tickers.
Input fields[3]
FieldType
SymbolsRequired
text
LimitRequired
number
Feedchoice
Currencytext
Output fields[3]
FieldType
Symboltext
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber

List Latest Stock Quotes

SearchTop of book for many tickers.
Input fields[3]
FieldType
SymbolsRequired
text
LimitRequired
number
Feedchoice
Currencytext
Output fields[3]
FieldType
Symboltext
Ask Pricenumber
Ask Sizenumber
Ask Exchangetext
Bid Pricenumber
Bid Sizenumber
Bid Exchangetext
Conditionsarray
Timestampdate
Tapetext

List Latest Stock Trades

SearchLast prints for many tickers.
Input fields[3]
FieldType
SymbolsRequired
text
LimitRequired
number
Feedchoice
Currencytext
Output fields[3]
FieldType
Symboltext
Conditionsarray
Trade IDnumber
Pricenumber
Sizenumber
Timestampdate
Utext
Exchangetext
Tapetext

List Locates

SearchHistory of locate requests.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
Symboltext
Startdate
Enddate
Output fields[3]
FieldType
All Or Noneboolean
Created Atdate
Expires Atdate
IDtext
Limit Pricenumber
Located Pricenumber
Located Quantitynumber
Rejection Reasontext
Requested Quantitynumber
Statustext
Symboltext
Total Feenumber

List Market Corporate Actions

SearchSplits, dividends and mergers across the market.
Input fields[3]
FieldType
LimitRequired
number
Symbolstext
CUSIPstext
Typestext
Regionchoice
Startdate
Enddate
IDstext
Data Qualitychoice
Sortchoice
Output fields[3]
FieldType
Corporate Action Typetext
Currencytext
CUSIPtext
Ex Datetext
IDtext
ISINtext
Long Term Ratenumber
Payable Datetext
Process Datetext
Record Datetext
Short Term Ratenumber
Symboltext
Due Bill Off Datetext

39other output fields

List Market Movers

SearchBiggest risers and fallers.
Input fields[3]
FieldType
MarketRequired
choice
Topnumber
Output fields[3]
FieldType
Gainersarray
Last Updatedtext
Losersarray
Market Typetext

List Most Active Stocks

SearchBusiest stocks by volume or trades.
Input fields[3]
FieldType
LimitRequired
number
Rank Bychoice
Topnumber
Output fields[3]
FieldType
Symboltext
Trade Countnumber
Volumenumber

List News

SearchMarket news with optional full text.
Input fields[3]
FieldType
LimitRequired
number
Symbolstext
Startdate
Enddate
Sortchoice
Include Contentboolean
Skip Articles Without Contentboolean
Output fields[3]
FieldType
Authortext
Contenttext
Created Atdate
Headlinetext
IDnumber
Imagesarray
Sourcetext
Summarytext
Symbolsarray
Updated Atdate
URLtext

List Option Bars

SearchPast option candles by contract.
Input fields[3]
FieldType
SymbolsRequired
text
TimeframeRequired
text
LimitRequired
number
Startdate
Enddate
Sortchoice
Output fields[3]
FieldType
Contract Symboltext
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber

List Option Contracts

SearchOption contracts matching your filters.
Input fields[3]
FieldType
LimitRequired
number
Underlying Symbolstext
Statuschoice
Typechoice
Stylechoice
Expiration Datedate
Expiration Date Gtedate
Expiration Date Ltedate
Root Symboltext
Strike Price Fromnumber
Strike Price Tonumber
Show Deliverablesboolean
Penny Programchoice
Output fields[3]
FieldType
Close Pricenumber
Close Price Datetext
Deliverablesarray
Expiration Datetext
IDtext
Multipliernumber
Nametext
Open Interestnumber
Open Interest Datetext
PPINDboolean
Root Symboltext
Sizenumber
Statustext

7other output fields

List Option Snapshots

SearchGreeks and prices for chosen options.
Input fields[3]
FieldType
SymbolsRequired
text
LimitRequired
number
Feedchoice
Updated Sincedate
Output fields[3]
FieldType
Contract Symboltext
Daily Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber
Greeksobject
Deltanumber
Gammanumber
Rhonumber
Thetanumber
Veganumber
Implied Volatilitynumber
Latest Quoteobject
Ask Pricenumber
Ask Sizenumber
Ask Exchangetext
Bid Pricenumber
Bid Sizenumber
Bid Exchangetext
Ctext
Timestampdate
Latest Tradeobject
Ctext
Pricenumber
Sizenumber
Timestampdate
Exchangetext
Minute Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber
Prev Daily Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber

List Option Trades

SearchOption fills from the past.
Input fields[3]
FieldType
SymbolsRequired
text
LimitRequired
number
Startdate
Enddate
Sortchoice
Output fields[3]
FieldType
Contract Symboltext
Ctext
Pricenumber
Sizenumber
Timestampdate
Exchangetext

List Orders

SearchPast and open orders.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
Symbolstext
Sidechoice
Asset Classeschoice
Nest Multi-Leg Ordersboolean
Afterdate
Untildate
Directionchoice
Output fields[3]
FieldType
Asset Classtext
Asset IDtext
Canceled Atdate
Client Order IDtext
Created Atdate
Expired Atdate
Expires Atdate
Extended Hoursboolean
Failed Atdate
Filled Atdate
Filled Avg Pricenumber
Filled Quantitynumber
Group IDtext

24other output fields

List Positions

SearchAll open holdings at once.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Asset Classtext
Asset IDtext
Asset Marginableboolean
Avg Entry Pricenumber
Avg Entry Swap Ratenumber
Change Todaynumber
Cost Basisnumber
Current Pricenumber
Exchangetext
Lastday Pricenumber
Market Valuenumber
Prev Swap Ratenumber
Quantitynumber

9other output fields

List Stock Auctions for Symbols

SearchAuction prints across tickers.
Input fields[3]
FieldType
SymbolsRequired
text
LimitRequired
number
Startdate
Enddate
As-of Datedate
Currencytext
Sortchoice
Output fields[3]
FieldType
Symboltext
Conditionsarray
Dtext
Openarray

List Stock Bars for Symbols

SearchCandle history across tickers.
Input fields[3]
FieldType
SymbolsRequired
text
TimeframeRequired
text
LimitRequired
number
Startdate
Enddate
Adjustmentchoice
As-of Datedate
Feedchoice
Currencytext
Sortchoice
Output fields[3]
FieldType
Symboltext
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber

List Stock Quotes for Symbols

SearchQuote history across tickers.
Input fields[3]
FieldType
SymbolsRequired
text
LimitRequired
number
Startdate
Enddate
As-of Datedate
Feedchoice
Currencytext
Sortchoice
Output fields[3]
FieldType
Symboltext
Ask Pricenumber
Ask Sizenumber
Ask Exchangetext
Bid Pricenumber
Bid Sizenumber
Bid Exchangetext
Conditionsarray
Timestampdate
Tapetext

List Stock Snapshots

SearchFresh picture of many tickers.
Input fields[3]
FieldType
SymbolsRequired
text
LimitRequired
number
Feedchoice
Currencytext
Output fields[3]
FieldType
Symboltext
Daily Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber
Latest Quoteobject
Ask Pricenumber
Ask Sizenumber
Ask Exchangetext
Bid Pricenumber
Bid Sizenumber
Bid Exchangetext
Conditionsarray
Timestampdate
Tapetext
Latest Tradeobject
Conditionsarray
Trade IDnumber
Pricenumber
Sizenumber
Timestampdate
Utext
Exchangetext
Tapetext
Minute Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber
Prev Daily Barobject
Closenumber
Highnumber
Lownumber
Trade Countnumber
Opennumber
Timestampdate
Volumenumber
VWAPnumber

List Stock Trades for Symbols

SearchPast prints across tickers.
Input fields[3]
FieldType
SymbolsRequired
text
LimitRequired
number
Startdate
Enddate
As-of Datedate
Feedchoice
Currencytext
Sortchoice
Output fields[3]
FieldType
Symboltext
Conditionsarray
Trade IDnumber
Pricenumber
Sizenumber
Timestampdate
Utext
Exchangetext
Tapetext

List Tokenization Requests

SearchTokenization history of the account.
Input fields[3]
FieldType
LimitRequired
number
Typechoice
Statuschoice
Underlying Symboltext
Issuerchoice
Networkchoice
Afterdate
Beforedate
Output fields[3]
FieldType
Client Account IDtext
Client External Account IDtext
Client Request IDtext
Created Atdate
Feesnumber
Issuertext
Issuer Request IDtext
Networktext
Quantitynumber
Statustext
Token Symboltext
Tokenization Request IDtext
Transfer Statustext

5other output fields

List Watchlists

SearchEvery saved ticker list.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Account IDtext
Created Atdate
IDtext
Nametext
Updated Atdate

List Whitelisted Addresses

SearchApproved crypto destinations on file.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Addresstext
Assettext
Chaintext
Created Atdate
IDtext
Statustext
Travel Rule Infoobject
Beneficiary Country Of Residencetext
Beneficiary Entity Nametext
Beneficiary Family Nametext
Beneficiary Geographic Address Building Numbertext
Beneficiary Geographic Address Countrytext
Beneficiary Geographic Address Post Codetext
Beneficiary Geographic Address Street Nametext
Beneficiary Geographic Address Town Nametext
Beneficiary Given Nametext
Beneficiary Is Self Hostedboolean

Search VASPs

SearchProviders for travel rule details.
Input fields[3]
FieldType
LimitRequired
number
Searchtext
Email Domaintext
Chainalysis Nametext
Sorttext
Include Subsidiariesboolean
Output fields[3]
FieldType
Addresstext
Citytext
Countrytext
Didtext
Email Domaintext
IDtext
Nametext
Postal Codetext
Statetext
Websitetext

Add an Asset to a Watchlist

ActionAppends a ticker to a saved list.
Input fields[3]
FieldType
WatchlistRequired
choice
SymbolRequired
text
Output fields[3]
FieldType
Account IDtext
Assetsarray
Created Atdate
IDtext
Nametext
Updated Atdate

Cancel All Orders

ActionStops all open orders at once.
Input fields[3]
FieldType
ConfirmRequired
boolean
Output fields[3]
FieldType
IDtext
Statusnumber
Bodyobject

Cancel an Order

ActionStops a single open order.
Input fields[3]
FieldType
OrderRequired
choice
Output fields[3]
FieldType
Successboolean
IDtext

Close a Position

ActionExits all or part of a holding.
Input fields[3]
FieldType
PositionRequired
choice
CloseRequired
choice
Client Order IDtext
Output fields[3]
FieldType
Asset Classtext
Asset IDtext
Canceled Atdate
Client Order IDtext
Created Atdate
Expired Atdate
Expires Atdate
Extended Hoursboolean
Failed Atdate
Filled Atdate
Filled Avg Pricenumber
Filled Quantitynumber
Group IDtext

24other output fields

Close All Positions

ActionCloses out all open holdings in one call.
Input fields[3]
FieldType
ConfirmRequired
boolean
Cancel Open Orders Firstboolean
Output fields[3]
FieldType
Symboltext
Statusnumber
Bodyobject

Create a Locate

ActionShort-sale share locate request.
Input fields[3]
FieldType
SymbolRequired
text
QuantityRequired
number
All or Noneboolean
Limit Pricenumber
Output fields[3]
FieldType
All Or Noneboolean
Created Atdate
Expires Atdate
IDtext
Limit Pricenumber
Located Pricenumber
Located Quantitynumber
Rejection Reasontext
Requested Quantitynumber
Statustext
Symboltext
Total Feenumber

Create a Multi-Leg Options Order

ActionOne order spanning several option legs.
Input fields[3]
FieldType
QuantityRequired
number
Order TypeRequired
choice
Time in ForceRequired
choice
LegsRequired
array
Legobject
Limit Pricenumber
Client Order IDtext
Output fields[3]
FieldType
Asset Classtext
Asset IDtext
Canceled Atdate
Client Order IDtext
Created Atdate
Expired Atdate
Expires Atdate
Extended Hoursboolean
Failed Atdate
Filled Atdate
Filled Avg Pricenumber
Filled Quantitynumber
Group IDtext

24other output fields

Create a Watchlist

ActionNew named list of tickers.
Input fields[3]
FieldType
NameRequired
text
Symbolsarray
Symboltext
Output fields[3]
FieldType
Account IDtext
Assetsarray
Created Atdate
IDtext
Nametext
Updated Atdate

Create a Whitelisted Address

ActionApproved withdrawal destination for crypto.
Input fields[3]
FieldType
AddressRequired
text
AssetRequired
text
Chainchoice
Beneficiary Given Nametext
Beneficiary Family Nametext
Beneficiary Entity Nametext
Beneficiary Country of Residencetext
Street Nametext
Building Numbertext
Post Codetext
Towntext
Address Countrytext
Beneficiary VASP IDtext

3other input fields

Output fields[3]
FieldType
Addresstext
Assettext
Chaintext
Created Atdate
IDtext
Statustext
Travel Rule Infoobject
Beneficiary Country Of Residencetext
Beneficiary Entity Nametext
Beneficiary Family Nametext
Beneficiary Geographic Address Building Numbertext
Beneficiary Geographic Address Countrytext
Beneficiary Geographic Address Post Codetext
Beneficiary Geographic Address Street Nametext
Beneficiary Geographic Address Town Nametext
Beneficiary Given Nametext
Beneficiary Is Self Hostedboolean

Create an Order

ActionTrade ticket for one asset.
Input fields[3]
FieldType
SymbolRequired
text
SideRequired
choice
Order TypeRequired
choice
Time in ForceRequired
choice
Quantitynumber
Notionalnumber
Limit Pricenumber
Stop Pricenumber
Trail Pricenumber
Trail Percentnumber
Order Classchoice
Extended Hoursboolean
Position Intentchoice

1other input field

Output fields[3]
FieldType
Asset Classtext
Asset IDtext
Canceled Atdate
Client Order IDtext
Created Atdate
Expired Atdate
Expires Atdate
Extended Hoursboolean
Failed Atdate
Filled Atdate
Filled Avg Pricenumber
Filled Quantitynumber
Group IDtext

24other output fields

Delete a Watchlist

ActionRemoves a saved list of tickers.
Input fields[3]
FieldType
WatchlistRequired
choice
Output fields[3]
FieldType
Successboolean
IDtext

Delete a Whitelisted Address

ActionRevokes a wallet address.
Input fields[3]
FieldType
Whitelisted Address IDRequired
text
Output fields[3]
FieldType
Successboolean
IDtext

Do Not Exercise an Option Position

ActionInstructs no exercise at expiry.
Input fields[3]
FieldType
Option PositionRequired
choice
Output fields[3]
FieldType
Successboolean
Symboltext

Exercise an Option Position

ActionExercise instruction for a held option.
Input fields[3]
FieldType
Option PositionRequired
choice
Output fields[3]
FieldType
Successboolean
Symboltext

Make an API Call

universalDirect Alpaca REST API access for uncovered endpoints.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Mint a Tokenized Asset

ActionToken minted for an underlying asset.
Input fields[3]
FieldType
Underlying SymbolRequired
text
IssuerRequired
choice
NetworkRequired
choice
QuantityRequired
number
Wallet AddressRequired
text
Client Request IDtext
Output fields[3]
FieldType
Client Request IDtext
Created Atdate
Issuertext
Networktext
Quantitynumber
Statustext
Token Symboltext
Tokenization Request IDtext
Underlying Symboltext

Remove an Asset from a Watchlist

ActionUnlists a ticker from a saved list.
Input fields[3]
FieldType
WatchlistRequired
choice
SymbolRequired
text
Output fields[3]
FieldType
Account IDtext
Assetsarray
Created Atdate
IDtext
Nametext
Updated Atdate

Update a Watchlist

ActionEdits a saved ticker list.
Input fields[3]
FieldType
WatchlistRequired
choice
Nametext
Symbolsarray
Symboltext
Output fields[3]
FieldType
Account IDtext
Assetsarray
Created Atdate
IDtext
Nametext
Updated Atdate

Update Account Configurations

ActionEdits the trading switches of the account.
Input fields[3]
FieldType
Disable Overnight Tradingchoice
Fractional Tradingchoice
Max Margin Multiplierchoice
Max Options Trading Levelchoice
Long Onlychoice
Accept PTP Orders With No Exceptionchoice
Suspend Tradingchoice
Trade Confirmation Emailschoice
Output fields[3]
FieldType
Disable Overnight Tradingboolean
Fractional Tradingboolean
Max Margin Multipliernumber
Max Options Trading Levelnumber
No Shortingboolean
Ptp No Exception Entryboolean
Suspend Tradeboolean
Trade Confirm Emailtext

Update an Order

ActionAmends a working order.
Input fields[3]
FieldType
OrderRequired
choice
Quantitynumber
Limit Pricenumber
Stop Pricenumber
Trailnumber
Time in Forcechoice
Client Order IDtext
Output fields[3]
FieldType
Asset Classtext
Asset IDtext
Canceled Atdate
Client Order IDtext
Created Atdate
Expired Atdate
Expires Atdate
Extended Hoursboolean
Failed Atdate
Filled Atdate
Filled Avg Pricenumber
Filled Quantitynumber
Group IDtext

24other output fields

Update the Travel Rule Info of a Whitelisted Address

ActionBeneficiary details for compliance.
Input fields[3]
FieldType
Whitelisted Address IDRequired
text
Beneficiary Given Nametext
Beneficiary Family Nametext
Beneficiary Entity Nametext
Beneficiary Country of Residencetext
Street Nametext
Building Numbertext
Post Codetext
Towntext
Address Countrytext
Beneficiary VASP IDtext
Manual VASP Nametext
Manual VASP Websitetext

1other input field

Output fields[3]
FieldType
Successboolean
IDtext

Look for Alpaca templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Alpaca Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Alpaca.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 14, 2026 14:55

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.