Alpaca integration guide
VerifiedHow 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].
Requirements
Get your Alpaca credentials
- 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]
Connect Alpaca in WEXTL
- Log in to your WEXTL account, add the Alpaca node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Alpaca account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Alpaca triggers and actions on WEXTL
The list below is a reference of every Alpaca node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any Alpaca node module below to see exactly what it takes in, what it returns, and what connection it needs.
Watch Account Activity
TriggerScheduled check of account events.
| Field | Type |
|---|---|
| Activity Time | date |
| Activity Type | text |
| Cum Quantity | text |
| ID | text |
| Leaves Quantity | text |
| Order ID | text |
| Order Status | text |
| Price | text |
| Quantity | text |
| Side | text |
| Symbol | text |
| Transaction Time | date |
| Type | text |
9other output fields
Watch New Fills
TriggerScheduled check for filled orders.
| Field | Type |
|---|---|
| Activity Type | text |
| Cum Quantity | text |
| ID | text |
| Leaves Quantity | text |
| Order ID | text |
| Order Status | text |
| Price | text |
| Quantity | text |
| Side | text |
| Symbol | text |
| Transaction Time | date |
| Type | text |
| Activity Sub Type | text |
8other output fields
Watch New Orders
TriggerFresh orders found on a schedule.
| Field | Type |
|---|---|
| Asset Class | text |
| Asset ID | text |
| Canceled At | date |
| Client Order ID | text |
| Created At | date |
| Expired At | date |
| Expires At | date |
| Extended Hours | boolean |
| Failed At | date |
| Filled At | date |
| Filled Avg Price | text |
| Filled Quantity | text |
| Group ID | text |
24other output fields
Get a Corporate Action Announcement
SearchDetails of a dividend or split notice.
| Field | Type |
|---|---|
IDRequired | text |
| Field | Type |
|---|---|
| Ca Sub Type | text |
| Ca Type | text |
| Cash | number |
| Corporate Action ID | text |
| Declaration Date | text |
| Effective Date | text |
| Ex Date | text |
| ID | text |
| Initiating Original CUSIP | text |
| Initiating Symbol | text |
| New Rate | number |
| Old Rate | number |
| Payable Date | text |
3other output fields
Get a Crypto Transfer
SearchProgress of one wallet movement.
| Field | Type |
|---|---|
Transfer IDRequired | text |
| Field | Type |
|---|---|
| Amount | number |
| Asset | text |
| Chain | text |
| Created At | date |
| Direction | text |
| Fees | number |
| From Address | text |
| ID | text |
| Network Fee | number |
| Status | text |
| To Address | text |
| Tx Hash | text |
| Usd Value | number |
Get a Crypto Transfer Estimate
SearchFee quote before a transfer.
| Field | Type |
|---|---|
AssetRequired | text |
From AddressRequired | text |
To AddressRequired | text |
AmountRequired | number |
| Field | Type |
|---|---|
| Fee | number |
| Network Fee | number |
Get a Locate
SearchOutcome of a short locate.
| Field | Type |
|---|---|
Locate IDRequired | text |
| Field | Type |
|---|---|
| All Or None | boolean |
| Created At | date |
| Expires At | date |
| ID | text |
| Limit Price | number |
| Located Price | number |
| Located Quantity | number |
| Rejection Reason | text |
| Requested Quantity | number |
| Status | text |
| Symbol | text |
| Total Fee | number |
Get a Logo
SearchCompany logo as an image file.
| Field | Type |
|---|---|
SymbolRequired | text |
| Placeholder If Missing | boolean |
| Field | Type |
|---|---|
| File | file |
| File Name | text |
| Size (Bytes) | number |
| Content Type | text |
Get a Position
SearchCost basis of one holding.
| Field | Type |
|---|---|
PositionRequired | choice |
| Field | Type |
|---|---|
| Asset Class | text |
| Asset ID | text |
| Asset Marginable | boolean |
| Avg Entry Price | number |
| Avg Entry Swap Rate | number |
| Change Today | number |
| Cost Basis | number |
| Current Price | number |
| Exchange | text |
| Lastday Price | number |
| Market Value | number |
| Prev Swap Rate | number |
| Quantity | number |
9other output fields
Get a Stock Snapshot
SearchEverything current about a ticker.
| Field | Type |
|---|---|
SymbolRequired | text |
| Feed | choice |
| Currency | text |
| Field | Type |
|---|---|
| Daily Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
| Latest Quote | object |
| Ask Price | number |
| Ask Size | number |
| Ask Exchange | text |
| Bid Price | number |
| Bid Size | number |
| Bid Exchange | text |
| Conditions | array |
| Timestamp | date |
| Tape | text |
| Latest Trade | object |
| Conditions | array |
| Trade ID | number |
| Price | number |
| Size | number |
| Timestamp | date |
| U | text |
| Exchange | text |
| Tape | text |
| Minute Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
| Prev Daily Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
| Currency | text |
| Symbol | text |
Get a Tokenization Request
SearchProgress and fees of one request.
| Field | Type |
|---|---|
Tokenization Request IDRequired | text |
| Field | Type |
|---|---|
| Client Account ID | text |
| Client External Account ID | text |
| Client Request ID | text |
| Created At | date |
| Fees | number |
| Issuer | text |
| Issuer Request ID | text |
| Network | text |
| Quantity | number |
| Status | text |
| Token Symbol | text |
| Tokenization Request ID | text |
| Transfer Status | text |
5other output fields
Get a Tokenization Request by Client Request ID
SearchRequest lookup by your own label.
| Field | Type |
|---|---|
Client Request IDRequired | text |
| Field | Type |
|---|---|
| Client Account ID | text |
| Client External Account ID | text |
| Client Request ID | text |
| Created At | date |
| Fees | number |
| Issuer | text |
| Issuer Request ID | text |
| Network | text |
| Quantity | number |
| Status | text |
| Token Symbol | text |
| Tokenization Request ID | text |
| Transfer Status | text |
5other output fields
Get a Watchlist
SearchTickers saved in one list.
| Field | Type |
|---|---|
WatchlistRequired | choice |
| Field | Type |
|---|---|
| Account ID | text |
| Assets | array |
| Created At | date |
| ID | text |
| Name | text |
| Updated At | date |
Get Account Configurations
SearchTrading switches on the account.
| Field | Type |
|---|---|
| Disable Overnight Trading | boolean |
| Fractional Trading | boolean |
| Max Margin Multiplier | number |
| Max Options Trading Level | number |
| No Shorting | boolean |
| Ptp No Exception Entry | boolean |
| Suspend Trade | boolean |
| Trade Confirm Email | text |
Get an Asset
SearchTradability data for one asset.
| Field | Type |
|---|---|
Symbol or Asset IDRequired | text |
| Field | Type |
|---|---|
| Attributes | array |
| Borrow Status | text |
| Class | text |
| CUSIP | text |
| Exchange | text |
| Fractionable | boolean |
| ID | text |
| Maintenance Margin Requirement | number |
| Margin Requirement Long | number |
| Margin Requirement Short | number |
| Marginable | boolean |
| Min Order Size | number |
| Min Trade Increment | number |
6other output fields
Get an Option Chain
SearchAll option contracts on a stock.
| Field | Type |
|---|---|
Underlying SymbolRequired | text |
LimitRequired | number |
| Feed | choice |
| Type | choice |
| Strike Price From | number |
| Strike Price To | number |
| Expiration Date | date |
| Expiration Date Gte | date |
| Expiration Date Lte | date |
| Root Symbol | text |
| Updated Since | date |
| Field | Type |
|---|---|
| Contract Symbol | text |
| Daily Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
| Greeks | object |
| Delta | number |
| Gamma | number |
| Rho | number |
| Theta | number |
| Vega | number |
| Implied Volatility | number |
| Latest Quote | object |
| Ask Price | number |
| Ask Size | number |
| Ask Exchange | text |
| Bid Price | number |
| Bid Size | number |
| Bid Exchange | text |
| C | text |
| Timestamp | date |
| Latest Trade | object |
| C | text |
| Price | number |
| Size | number |
| Timestamp | date |
| Exchange | text |
| Minute Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
| Prev Daily Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
Get an Option Contract
SearchStrike, expiry and terms of a single option.
| Field | Type |
|---|---|
Symbol or Contract IDRequired | text |
| Field | Type |
|---|---|
| Close Price | number |
| Close Price Date | text |
| Deliverables | array |
| Expiration Date | text |
| ID | text |
| Multiplier | number |
| Name | text |
| Open Interest | number |
| Open Interest Date | text |
| PPIND | boolean |
| Root Symbol | text |
| Size | number |
| Status | text |
7other output fields
Get an Order
SearchStatus and fills of one order.
| Field | Type |
|---|---|
Order IDRequired | text |
| Nest Multi-Leg Orders | boolean |
| Field | Type |
|---|---|
| Asset Class | text |
| Asset ID | text |
| Canceled At | date |
| Client Order ID | text |
| Created At | date |
| Expired At | date |
| Expires At | date |
| Extended Hours | boolean |
| Failed At | date |
| Filled At | date |
| Filled Avg Price | number |
| Filled Quantity | number |
| Group ID | text |
24other output fields
Get an Order by Client Order ID
SearchOrder lookup by your own reference.
| Field | Type |
|---|---|
Client Order IDRequired | text |
| Field | Type |
|---|---|
| Asset Class | text |
| Asset ID | text |
| Canceled At | date |
| Client Order ID | text |
| Created At | date |
| Expired At | date |
| Expires At | date |
| Extended Hours | boolean |
| Failed At | date |
| Filled At | date |
| Filled Avg Price | number |
| Filled Quantity | number |
| Group ID | text |
24other output fields
Get Latest Crypto Orderbooks
SearchOrder book depth for crypto pairs.
| Field | Type |
|---|---|
LocationRequired | choice |
SymbolsRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Symbol | text |
| Asks | array |
| Bids | array |
| Timestamp | date |
Get Locate Quotes
SearchShort locate price quotes.
| Field | Type |
|---|---|
SymbolsRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Available Quantity | number |
| Price | number |
| Quoted At | date |
| Symbol | text |
Get Option Condition Codes
SearchMeaning of option trade flags.
| Field | Type |
|---|---|
Tick TypeRequired | choice |
| Field | Type |
|---|---|
| Codes | object |
Get Option Exchange Codes
SearchVenue code lookup for options data.
| Field | Type |
|---|---|
| Codes | object |
Get Portfolio History
SearchEquity curve of the account.
| Field | Type |
|---|---|
LimitRequired | number |
| Period | text |
| Timeframe | choice |
| Start | date |
| End | date |
| Intraday Reporting | choice |
| P&L Reset | choice |
| Cashflow Types | text |
| Field | Type |
|---|---|
| Timestamp | date |
| Equity | number |
| Profit Loss | number |
| Profit Loss Pct | number |
Get Stock Auctions
SearchAuction prints for a ticker.
| Field | Type |
|---|---|
SymbolRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| As-of Date | date |
| Currency | text |
| Sort | choice |
| Field | Type |
|---|---|
| Symbol | text |
| Conditions | array |
| D | text |
| Open | array |
Get Stock Bars
SearchPrice history for a ticker.
| Field | Type |
|---|---|
SymbolRequired | text |
TimeframeRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| Adjustment | choice |
| As-of Date | date |
| Feed | choice |
| Currency | text |
| Sort | choice |
| Field | Type |
|---|---|
| Symbol | text |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
Get Stock Condition Codes
SearchGlossary of stock trade flags.
| Field | Type |
|---|---|
Tick TypeRequired | choice |
TapeRequired | choice |
| Field | Type |
|---|---|
| Codes | object |
Get Stock Exchange Codes
SearchVenue code glossary for stocks.
| Field | Type |
|---|---|
| Codes | object |
Get Stock Quotes
SearchQuote history for a ticker.
| Field | Type |
|---|---|
SymbolRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| As-of Date | date |
| Feed | choice |
| Currency | text |
| Sort | choice |
| Field | Type |
|---|---|
| Symbol | text |
| Ask Price | number |
| Ask Size | number |
| Ask Exchange | text |
| Bid Price | number |
| Bid Size | number |
| Bid Exchange | text |
| Conditions | array |
| Timestamp | date |
| Tape | text |
Get Stock Trades
SearchTrade tape for a ticker.
| Field | Type |
|---|---|
SymbolRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| As-of Date | date |
| Feed | choice |
| Currency | text |
| Sort | choice |
| Field | Type |
|---|---|
| Symbol | text |
| Conditions | array |
| Trade ID | number |
| Price | number |
| Size | number |
| Timestamp | date |
| U | text |
| Exchange | text |
| Tape | text |
Get the Account
SearchBalances and status of the account.
| Field | Type |
|---|---|
| Account Blocked | boolean |
| Account Number | text |
| Accrued Fees | number |
| Balance Asof | text |
| Buying Power | number |
| Cash | number |
| Created At | date |
| Crypto Status | text |
| Currency | text |
| Equity | number |
| ID | text |
| Initial Margin | number |
| Intraday Adjustments | number |
21other output fields
Get the Latest Stock Bar
SearchNewest price bar for a ticker.
| Field | Type |
|---|---|
SymbolRequired | text |
| Feed | choice |
| Currency | text |
| Field | Type |
|---|---|
| Symbol | text |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
Get the Latest Stock Quote
SearchCurrent bid and ask of a ticker.
| Field | Type |
|---|---|
SymbolRequired | text |
| Feed | choice |
| Currency | text |
| Field | Type |
|---|---|
| Symbol | text |
| Ask Price | number |
| Ask Size | number |
| Ask Exchange | text |
| Bid Price | number |
| Bid Size | number |
| Bid Exchange | text |
| Conditions | array |
| Timestamp | date |
| Tape | text |
Get the Latest Stock Trade
SearchLast print for a ticker.
| Field | Type |
|---|---|
SymbolRequired | text |
| Feed | choice |
| Currency | text |
| Field | Type |
|---|---|
| Symbol | text |
| Conditions | array |
| Trade ID | number |
| Price | number |
| Size | number |
| Timestamp | date |
| U | text |
| Exchange | text |
| Tape | text |
Get the Market Calendar
SearchTrading days and session hours.
| Field | Type |
|---|---|
MarketRequired | choice |
LimitRequired | number |
| Start | date |
| End | date |
| Time Zone | choice |
| Field | Type |
|---|---|
| Core End | date |
| Core Start | date |
| Date | text |
| Lunch End | date |
| Lunch Start | date |
| Post End | date |
| Post Start | date |
| Pre End | date |
| Pre Start | date |
| Settlement Date | text |
Get the Market Clock
SearchOpen or closed state of markets.
| Field | Type |
|---|---|
LimitRequired | number |
| Markets | text |
| Time | date |
| Field | Type |
|---|---|
| Is Market Day | boolean |
| Market | object |
| Acronym | text |
| Bic | text |
| Mic | text |
| Name | text |
| Timezone | text |
| Next Market Close | date |
| Next Market Open | date |
| Phase | text |
| Phase Until | date |
| Timestamp | date |
List Account Activities
SearchFills and cash events on the account.
| Field | Type |
|---|---|
LimitRequired | number |
| Activity Types | choice |
| Category | choice |
| Order Id | text |
| Date | date |
| After | date |
| Until | date |
| Direction | choice |
| Field | Type |
|---|---|
| Activity Type | text |
| Cum Quantity | number |
| ID | text |
| Leaves Quantity | number |
| Order ID | text |
| Order Status | text |
| Price | number |
| Quantity | number |
| Side | text |
| Symbol | text |
| Transaction Time | date |
| Type | text |
| Activity Sub Type | text |
8other output fields
List Assets
SearchAssets Alpaca knows about.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| Asset Class | choice |
| Exchange | text |
| Attributes | text |
| Field | Type |
|---|---|
| Attributes | array |
| Borrow Status | text |
| Class | text |
| CUSIP | text |
| Exchange | text |
| Fractionable | boolean |
| ID | text |
| Maintenance Margin Requirement | number |
| Margin Requirement Long | number |
| Margin Requirement Short | number |
| Marginable | boolean |
| Min Order Size | number |
| Min Trade Increment | number |
6other output fields
List Corporate Action Announcements
SearchDividend, split and merger notices.
| Field | Type |
|---|---|
TypesRequired | choice |
SinceRequired | date |
UntilRequired | date |
LimitRequired | number |
| Symbol | text |
| CUSIP | text |
| Date Type | choice |
| Field | Type |
|---|---|
| Ca Sub Type | text |
| Ca Type | text |
| Cash | number |
| Corporate Action ID | text |
| Declaration Date | text |
| Effective Date | text |
| Ex Date | text |
| ID | text |
| Initiating Original CUSIP | text |
| Initiating Symbol | text |
| New Rate | number |
| Old Rate | number |
| Payable Date | text |
3other output fields
List Crypto Bars
SearchCandles for crypto pairs over time.
| Field | Type |
|---|---|
LocationRequired | choice |
SymbolsRequired | text |
TimeframeRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| Sort | choice |
| Field | Type |
|---|---|
| Symbol | text |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
List Crypto Quotes
SearchCrypto bid and ask history.
| Field | Type |
|---|---|
LocationRequired | choice |
SymbolsRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| Sort | choice |
| Field | Type |
|---|---|
| Symbol | text |
| Ask Price | number |
| Ask Size | number |
| Bid Price | number |
| Bid Size | number |
| Timestamp | date |
List Crypto Snapshots
SearchEverything current about crypto pairs.
| Field | Type |
|---|---|
LocationRequired | choice |
SymbolsRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Symbol | text |
| Daily Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
| Latest Quote | object |
| Ask Price | number |
| Ask Size | number |
| Bid Price | number |
| Bid Size | number |
| Timestamp | date |
| Latest Trade | object |
| Trade ID | number |
| Price | number |
| Size | number |
| Timestamp | date |
| Tks | text |
| Minute Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
| Prev Daily Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
List Crypto Trades
SearchExecuted crypto prints from the past.
| Field | Type |
|---|---|
LocationRequired | choice |
SymbolsRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| Sort | choice |
| Field | Type |
|---|---|
| Symbol | text |
| Trade ID | number |
| Price | number |
| Size | number |
| Timestamp | date |
| Tks | text |
List Crypto Transfers
SearchHistory of wallet movements.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Amount | number |
| Asset | text |
| Chain | text |
| Created At | date |
| Direction | text |
| Fees | number |
| From Address | text |
| ID | text |
| Network Fee | number |
| Status | text |
| To Address | text |
| Tx Hash | text |
| Usd Value | number |
List Crypto Wallets
SearchWallet addresses and chains on your account.
| Field | Type |
|---|---|
LimitRequired | number |
| Asset | text |
| Chain | choice |
| Field | Type |
|---|---|
| Address | text |
| Chain | text |
| Created At | date |
List Latest Bond Prices
SearchNewest bond prices and yields.
| Field | Type |
|---|---|
ISINsRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| ISIN | text |
| Price | number |
| Timestamp | date |
| Ytm | number |
| Ytw | number |
List Latest Bond Quotes
SearchNewest bond bid and ask.
| Field | Type |
|---|---|
ISINsRequired | text |
LimitRequired | number |
| Trade Size | number |
| Field | Type |
|---|---|
| ISIN | text |
| Ams | number |
| Ask Price | number |
| Ask Size | number |
| Aytm | number |
| Aytw | number |
| Bms | number |
| Bid Price | number |
| Bid Size | number |
| Bytm | number |
| Bytw | number |
| Timestamp | date |
List Latest Crypto Bars
SearchLatest candles for crypto pairs.
| Field | Type |
|---|---|
LocationRequired | choice |
SymbolsRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Symbol | text |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
List Latest Crypto Quotes
SearchTop of book for crypto pairs.
| Field | Type |
|---|---|
LocationRequired | choice |
SymbolsRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Symbol | text |
| Ask Price | number |
| Ask Size | number |
| Bid Price | number |
| Bid Size | number |
| Timestamp | date |
List Latest Crypto Trades
SearchLast prints for crypto pairs.
| Field | Type |
|---|---|
LocationRequired | choice |
SymbolsRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Symbol | text |
| Trade ID | number |
| Price | number |
| Size | number |
| Timestamp | date |
| Tks | text |
List Latest Option Quotes
SearchCurrent option market quotes.
| Field | Type |
|---|---|
SymbolsRequired | text |
LimitRequired | number |
| Feed | choice |
| Field | Type |
|---|---|
| Contract Symbol | text |
| Ask Price | number |
| Ask Size | number |
| Ask Exchange | text |
| Bid Price | number |
| Bid Size | number |
| Bid Exchange | text |
| C | text |
| Timestamp | date |
List Latest Option Trades
SearchMost recent option fills.
| Field | Type |
|---|---|
SymbolsRequired | text |
LimitRequired | number |
| Feed | choice |
| Field | Type |
|---|---|
| Contract Symbol | text |
| C | text |
| Price | number |
| Size | number |
| Timestamp | date |
| Exchange | text |
List Latest Stock Bars
SearchLatest candles for many tickers.
| Field | Type |
|---|---|
SymbolsRequired | text |
LimitRequired | number |
| Feed | choice |
| Currency | text |
| Field | Type |
|---|---|
| Symbol | text |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
List Latest Stock Quotes
SearchTop of book for many tickers.
| Field | Type |
|---|---|
SymbolsRequired | text |
LimitRequired | number |
| Feed | choice |
| Currency | text |
| Field | Type |
|---|---|
| Symbol | text |
| Ask Price | number |
| Ask Size | number |
| Ask Exchange | text |
| Bid Price | number |
| Bid Size | number |
| Bid Exchange | text |
| Conditions | array |
| Timestamp | date |
| Tape | text |
List Latest Stock Trades
SearchLast prints for many tickers.
| Field | Type |
|---|---|
SymbolsRequired | text |
LimitRequired | number |
| Feed | choice |
| Currency | text |
| Field | Type |
|---|---|
| Symbol | text |
| Conditions | array |
| Trade ID | number |
| Price | number |
| Size | number |
| Timestamp | date |
| U | text |
| Exchange | text |
| Tape | text |
List Locates
SearchHistory of locate requests.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| Symbol | text |
| Start | date |
| End | date |
| Field | Type |
|---|---|
| All Or None | boolean |
| Created At | date |
| Expires At | date |
| ID | text |
| Limit Price | number |
| Located Price | number |
| Located Quantity | number |
| Rejection Reason | text |
| Requested Quantity | number |
| Status | text |
| Symbol | text |
| Total Fee | number |
List Market Corporate Actions
SearchSplits, dividends and mergers across the market.
| Field | Type |
|---|---|
LimitRequired | number |
| Symbols | text |
| CUSIPs | text |
| Types | text |
| Region | choice |
| Start | date |
| End | date |
| IDs | text |
| Data Quality | choice |
| Sort | choice |
| Field | Type |
|---|---|
| Corporate Action Type | text |
| Currency | text |
| CUSIP | text |
| Ex Date | text |
| ID | text |
| ISIN | text |
| Long Term Rate | number |
| Payable Date | text |
| Process Date | text |
| Record Date | text |
| Short Term Rate | number |
| Symbol | text |
| Due Bill Off Date | text |
39other output fields
List Market Movers
SearchBiggest risers and fallers.
| Field | Type |
|---|---|
MarketRequired | choice |
| Top | number |
| Field | Type |
|---|---|
| Gainers | array |
| Last Updated | text |
| Losers | array |
| Market Type | text |
List Most Active Stocks
SearchBusiest stocks by volume or trades.
| Field | Type |
|---|---|
LimitRequired | number |
| Rank By | choice |
| Top | number |
| Field | Type |
|---|---|
| Symbol | text |
| Trade Count | number |
| Volume | number |
List News
SearchMarket news with optional full text.
| Field | Type |
|---|---|
LimitRequired | number |
| Symbols | text |
| Start | date |
| End | date |
| Sort | choice |
| Include Content | boolean |
| Skip Articles Without Content | boolean |
| Field | Type |
|---|---|
| Author | text |
| Content | text |
| Created At | date |
| Headline | text |
| ID | number |
| Images | array |
| Source | text |
| Summary | text |
| Symbols | array |
| Updated At | date |
| URL | text |
List Option Bars
SearchPast option candles by contract.
| Field | Type |
|---|---|
SymbolsRequired | text |
TimeframeRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| Sort | choice |
| Field | Type |
|---|---|
| Contract Symbol | text |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
List Option Contracts
SearchOption contracts matching your filters.
| Field | Type |
|---|---|
LimitRequired | number |
| Underlying Symbols | text |
| Status | choice |
| Type | choice |
| Style | choice |
| Expiration Date | date |
| Expiration Date Gte | date |
| Expiration Date Lte | date |
| Root Symbol | text |
| Strike Price From | number |
| Strike Price To | number |
| Show Deliverables | boolean |
| Penny Program | choice |
| Field | Type |
|---|---|
| Close Price | number |
| Close Price Date | text |
| Deliverables | array |
| Expiration Date | text |
| ID | text |
| Multiplier | number |
| Name | text |
| Open Interest | number |
| Open Interest Date | text |
| PPIND | boolean |
| Root Symbol | text |
| Size | number |
| Status | text |
7other output fields
List Option Snapshots
SearchGreeks and prices for chosen options.
| Field | Type |
|---|---|
SymbolsRequired | text |
LimitRequired | number |
| Feed | choice |
| Updated Since | date |
| Field | Type |
|---|---|
| Contract Symbol | text |
| Daily Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
| Greeks | object |
| Delta | number |
| Gamma | number |
| Rho | number |
| Theta | number |
| Vega | number |
| Implied Volatility | number |
| Latest Quote | object |
| Ask Price | number |
| Ask Size | number |
| Ask Exchange | text |
| Bid Price | number |
| Bid Size | number |
| Bid Exchange | text |
| C | text |
| Timestamp | date |
| Latest Trade | object |
| C | text |
| Price | number |
| Size | number |
| Timestamp | date |
| Exchange | text |
| Minute Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
| Prev Daily Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
List Option Trades
SearchOption fills from the past.
| Field | Type |
|---|---|
SymbolsRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| Sort | choice |
| Field | Type |
|---|---|
| Contract Symbol | text |
| C | text |
| Price | number |
| Size | number |
| Timestamp | date |
| Exchange | text |
List Orders
SearchPast and open orders.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| Symbols | text |
| Side | choice |
| Asset Classes | choice |
| Nest Multi-Leg Orders | boolean |
| After | date |
| Until | date |
| Direction | choice |
| Field | Type |
|---|---|
| Asset Class | text |
| Asset ID | text |
| Canceled At | date |
| Client Order ID | text |
| Created At | date |
| Expired At | date |
| Expires At | date |
| Extended Hours | boolean |
| Failed At | date |
| Filled At | date |
| Filled Avg Price | number |
| Filled Quantity | number |
| Group ID | text |
24other output fields
List Positions
SearchAll open holdings at once.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Asset Class | text |
| Asset ID | text |
| Asset Marginable | boolean |
| Avg Entry Price | number |
| Avg Entry Swap Rate | number |
| Change Today | number |
| Cost Basis | number |
| Current Price | number |
| Exchange | text |
| Lastday Price | number |
| Market Value | number |
| Prev Swap Rate | number |
| Quantity | number |
9other output fields
List Stock Auctions for Symbols
SearchAuction prints across tickers.
| Field | Type |
|---|---|
SymbolsRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| As-of Date | date |
| Currency | text |
| Sort | choice |
| Field | Type |
|---|---|
| Symbol | text |
| Conditions | array |
| D | text |
| Open | array |
List Stock Bars for Symbols
SearchCandle history across tickers.
| Field | Type |
|---|---|
SymbolsRequired | text |
TimeframeRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| Adjustment | choice |
| As-of Date | date |
| Feed | choice |
| Currency | text |
| Sort | choice |
| Field | Type |
|---|---|
| Symbol | text |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
List Stock Quotes for Symbols
SearchQuote history across tickers.
| Field | Type |
|---|---|
SymbolsRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| As-of Date | date |
| Feed | choice |
| Currency | text |
| Sort | choice |
| Field | Type |
|---|---|
| Symbol | text |
| Ask Price | number |
| Ask Size | number |
| Ask Exchange | text |
| Bid Price | number |
| Bid Size | number |
| Bid Exchange | text |
| Conditions | array |
| Timestamp | date |
| Tape | text |
List Stock Snapshots
SearchFresh picture of many tickers.
| Field | Type |
|---|---|
SymbolsRequired | text |
LimitRequired | number |
| Feed | choice |
| Currency | text |
| Field | Type |
|---|---|
| Symbol | text |
| Daily Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
| Latest Quote | object |
| Ask Price | number |
| Ask Size | number |
| Ask Exchange | text |
| Bid Price | number |
| Bid Size | number |
| Bid Exchange | text |
| Conditions | array |
| Timestamp | date |
| Tape | text |
| Latest Trade | object |
| Conditions | array |
| Trade ID | number |
| Price | number |
| Size | number |
| Timestamp | date |
| U | text |
| Exchange | text |
| Tape | text |
| Minute Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
| Prev Daily Bar | object |
| Close | number |
| High | number |
| Low | number |
| Trade Count | number |
| Open | number |
| Timestamp | date |
| Volume | number |
| VWAP | number |
List Stock Trades for Symbols
SearchPast prints across tickers.
| Field | Type |
|---|---|
SymbolsRequired | text |
LimitRequired | number |
| Start | date |
| End | date |
| As-of Date | date |
| Feed | choice |
| Currency | text |
| Sort | choice |
| Field | Type |
|---|---|
| Symbol | text |
| Conditions | array |
| Trade ID | number |
| Price | number |
| Size | number |
| Timestamp | date |
| U | text |
| Exchange | text |
| Tape | text |
List Tokenization Requests
SearchTokenization history of the account.
| Field | Type |
|---|---|
LimitRequired | number |
| Type | choice |
| Status | choice |
| Underlying Symbol | text |
| Issuer | choice |
| Network | choice |
| After | date |
| Before | date |
| Field | Type |
|---|---|
| Client Account ID | text |
| Client External Account ID | text |
| Client Request ID | text |
| Created At | date |
| Fees | number |
| Issuer | text |
| Issuer Request ID | text |
| Network | text |
| Quantity | number |
| Status | text |
| Token Symbol | text |
| Tokenization Request ID | text |
| Transfer Status | text |
5other output fields
List Watchlists
SearchEvery saved ticker list.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Account ID | text |
| Created At | date |
| ID | text |
| Name | text |
| Updated At | date |
List Whitelisted Addresses
SearchApproved crypto destinations on file.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Address | text |
| Asset | text |
| Chain | text |
| Created At | date |
| ID | text |
| Status | text |
| Travel Rule Info | object |
| Beneficiary Country Of Residence | text |
| Beneficiary Entity Name | text |
| Beneficiary Family Name | text |
| Beneficiary Geographic Address Building Number | text |
| Beneficiary Geographic Address Country | text |
| Beneficiary Geographic Address Post Code | text |
| Beneficiary Geographic Address Street Name | text |
| Beneficiary Geographic Address Town Name | text |
| Beneficiary Given Name | text |
| Beneficiary Is Self Hosted | boolean |
Search VASPs
SearchProviders for travel rule details.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Email Domain | text |
| Chainalysis Name | text |
| Sort | text |
| Include Subsidiaries | boolean |
| Field | Type |
|---|---|
| Address | text |
| City | text |
| Country | text |
| Did | text |
| Email Domain | text |
| ID | text |
| Name | text |
| Postal Code | text |
| State | text |
| Website | text |
Add an Asset to a Watchlist
ActionAppends a ticker to a saved list.
| Field | Type |
|---|---|
WatchlistRequired | choice |
SymbolRequired | text |
| Field | Type |
|---|---|
| Account ID | text |
| Assets | array |
| Created At | date |
| ID | text |
| Name | text |
| Updated At | date |
Cancel All Orders
ActionStops all open orders at once.
| Field | Type |
|---|---|
ConfirmRequired | boolean |
| Field | Type |
|---|---|
| ID | text |
| Status | number |
| Body | object |
Cancel an Order
ActionStops a single open order.
| Field | Type |
|---|---|
OrderRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| ID | text |
Close a Position
ActionExits all or part of a holding.
| Field | Type |
|---|---|
PositionRequired | choice |
CloseRequired | choice |
| Client Order ID | text |
| Field | Type |
|---|---|
| Asset Class | text |
| Asset ID | text |
| Canceled At | date |
| Client Order ID | text |
| Created At | date |
| Expired At | date |
| Expires At | date |
| Extended Hours | boolean |
| Failed At | date |
| Filled At | date |
| Filled Avg Price | number |
| Filled Quantity | number |
| Group ID | text |
24other output fields
Close All Positions
ActionCloses out all open holdings in one call.
| Field | Type |
|---|---|
ConfirmRequired | boolean |
| Cancel Open Orders First | boolean |
| Field | Type |
|---|---|
| Symbol | text |
| Status | number |
| Body | object |
Create a Locate
ActionShort-sale share locate request.
| Field | Type |
|---|---|
SymbolRequired | text |
QuantityRequired | number |
| All or None | boolean |
| Limit Price | number |
| Field | Type |
|---|---|
| All Or None | boolean |
| Created At | date |
| Expires At | date |
| ID | text |
| Limit Price | number |
| Located Price | number |
| Located Quantity | number |
| Rejection Reason | text |
| Requested Quantity | number |
| Status | text |
| Symbol | text |
| Total Fee | number |
Create a Multi-Leg Options Order
ActionOne order spanning several option legs.
| Field | Type |
|---|---|
QuantityRequired | number |
Order TypeRequired | choice |
Time in ForceRequired | choice |
LegsRequired | array |
| Leg | object |
| Limit Price | number |
| Client Order ID | text |
| Field | Type |
|---|---|
| Asset Class | text |
| Asset ID | text |
| Canceled At | date |
| Client Order ID | text |
| Created At | date |
| Expired At | date |
| Expires At | date |
| Extended Hours | boolean |
| Failed At | date |
| Filled At | date |
| Filled Avg Price | number |
| Filled Quantity | number |
| Group ID | text |
24other output fields
Create a Watchlist
ActionNew named list of tickers.
| Field | Type |
|---|---|
NameRequired | text |
| Symbols | array |
| Symbol | text |
| Field | Type |
|---|---|
| Account ID | text |
| Assets | array |
| Created At | date |
| ID | text |
| Name | text |
| Updated At | date |
Create a Whitelisted Address
ActionApproved withdrawal destination for crypto.
| Field | Type |
|---|---|
AddressRequired | text |
AssetRequired | text |
| Chain | choice |
| Beneficiary Given Name | text |
| Beneficiary Family Name | text |
| Beneficiary Entity Name | text |
| Beneficiary Country of Residence | text |
| Street Name | text |
| Building Number | text |
| Post Code | text |
| Town | text |
| Address Country | text |
| Beneficiary VASP ID | text |
3other input fields
| Field | Type |
|---|---|
| Address | text |
| Asset | text |
| Chain | text |
| Created At | date |
| ID | text |
| Status | text |
| Travel Rule Info | object |
| Beneficiary Country Of Residence | text |
| Beneficiary Entity Name | text |
| Beneficiary Family Name | text |
| Beneficiary Geographic Address Building Number | text |
| Beneficiary Geographic Address Country | text |
| Beneficiary Geographic Address Post Code | text |
| Beneficiary Geographic Address Street Name | text |
| Beneficiary Geographic Address Town Name | text |
| Beneficiary Given Name | text |
| Beneficiary Is Self Hosted | boolean |
Create an Order
ActionTrade ticket for one asset.
| Field | Type |
|---|---|
SymbolRequired | text |
SideRequired | choice |
Order TypeRequired | choice |
Time in ForceRequired | choice |
| Quantity | number |
| Notional | number |
| Limit Price | number |
| Stop Price | number |
| Trail Price | number |
| Trail Percent | number |
| Order Class | choice |
| Extended Hours | boolean |
| Position Intent | choice |
1other input field
| Field | Type |
|---|---|
| Asset Class | text |
| Asset ID | text |
| Canceled At | date |
| Client Order ID | text |
| Created At | date |
| Expired At | date |
| Expires At | date |
| Extended Hours | boolean |
| Failed At | date |
| Filled At | date |
| Filled Avg Price | number |
| Filled Quantity | number |
| Group ID | text |
24other output fields
Delete a Watchlist
ActionRemoves a saved list of tickers.
| Field | Type |
|---|---|
WatchlistRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| ID | text |
Delete a Whitelisted Address
ActionRevokes a wallet address.
| Field | Type |
|---|---|
Whitelisted Address IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
| ID | text |
Do Not Exercise an Option Position
ActionInstructs no exercise at expiry.
| Field | Type |
|---|---|
Option PositionRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Symbol | text |
Exercise an Option Position
ActionExercise instruction for a held option.
| Field | Type |
|---|---|
Option PositionRequired | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Symbol | text |
Make an API Call
universalDirect Alpaca REST API access for uncovered endpoints.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query String | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Status code | number |
Mint a Tokenized Asset
ActionToken minted for an underlying asset.
| Field | Type |
|---|---|
Underlying SymbolRequired | text |
IssuerRequired | choice |
NetworkRequired | choice |
QuantityRequired | number |
Wallet AddressRequired | text |
| Client Request ID | text |
| Field | Type |
|---|---|
| Client Request ID | text |
| Created At | date |
| Issuer | text |
| Network | text |
| Quantity | number |
| Status | text |
| Token Symbol | text |
| Tokenization Request ID | text |
| Underlying Symbol | text |
Remove an Asset from a Watchlist
ActionUnlists a ticker from a saved list.
| Field | Type |
|---|---|
WatchlistRequired | choice |
SymbolRequired | text |
| Field | Type |
|---|---|
| Account ID | text |
| Assets | array |
| Created At | date |
| ID | text |
| Name | text |
| Updated At | date |
Update a Watchlist
ActionEdits a saved ticker list.
| Field | Type |
|---|---|
WatchlistRequired | choice |
| Name | text |
| Symbols | array |
| Symbol | text |
| Field | Type |
|---|---|
| Account ID | text |
| Assets | array |
| Created At | date |
| ID | text |
| Name | text |
| Updated At | date |
Update Account Configurations
ActionEdits the trading switches of the account.
| Field | Type |
|---|---|
| Disable Overnight Trading | choice |
| Fractional Trading | choice |
| Max Margin Multiplier | choice |
| Max Options Trading Level | choice |
| Long Only | choice |
| Accept PTP Orders With No Exception | choice |
| Suspend Trading | choice |
| Trade Confirmation Emails | choice |
| Field | Type |
|---|---|
| Disable Overnight Trading | boolean |
| Fractional Trading | boolean |
| Max Margin Multiplier | number |
| Max Options Trading Level | number |
| No Shorting | boolean |
| Ptp No Exception Entry | boolean |
| Suspend Trade | boolean |
| Trade Confirm Email | text |
Update an Order
ActionAmends a working order.
| Field | Type |
|---|---|
OrderRequired | choice |
| Quantity | number |
| Limit Price | number |
| Stop Price | number |
| Trail | number |
| Time in Force | choice |
| Client Order ID | text |
| Field | Type |
|---|---|
| Asset Class | text |
| Asset ID | text |
| Canceled At | date |
| Client Order ID | text |
| Created At | date |
| Expired At | date |
| Expires At | date |
| Extended Hours | boolean |
| Failed At | date |
| Filled At | date |
| Filled Avg Price | number |
| Filled Quantity | number |
| Group ID | text |
24other output fields
Update the Travel Rule Info of a Whitelisted Address
ActionBeneficiary details for compliance.
| Field | Type |
|---|---|
Whitelisted Address IDRequired | text |
| Beneficiary Given Name | text |
| Beneficiary Family Name | text |
| Beneficiary Entity Name | text |
| Beneficiary Country of Residence | text |
| Street Name | text |
| Building Number | text |
| Post Code | text |
| Town | text |
| Address Country | text |
| Beneficiary VASP ID | text |
| Manual VASP Name | text |
| Manual VASP Website | text |
1other input field
| Field | Type |
|---|---|
| Success | boolean |
| ID | text |
Templates
Look for Alpaca templates in the WEXTL template library.
Browse templates →Other finance integrations on WEXTL
Bybit[2]Cryptocurrency exchange API for orders, tickers, and market data.
CoinGeckoLook up crypto coin prices, market data, and exchange rankings with CoinGecko.
DaftraCloud accounting and ERP suite for invoices, clients, inventory, and business operations.
ClientaryManage clients, estimates, invoices, retainers, projects, time and payments in Clientary.
CoinbaseCryptocurrency exchange and payments platform for trading, transfers, and digital asset orders.
References
- WEXTL® Alpaca Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Alpaca.
- 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.





























