Jump to Content
Home
Documentation
API Reference
Log In
Trading Dashboard
Broker Dashboard
API Reference
Search
Ask AI
Log In
Trading Dashboard
Broker Dashboard
Home
Documentation
API Reference
About Alpaca-py
All
Pages
Start typing to search…
JUMP TO
Alpaca Py
About Alpaca-py
Authentication API
OAuth2
Issue tokens
post
Trading API
Accounts
Get Account
get
Assets
Assets
Get Assets
get
Get an Asset by ID or Symbol
get
Get Option Contracts
get
Get an option contract by ID or Symbol
get
Corporate Actions
Retrieve a Specific Announcement
get
Retrieve Announcements
get
Orders
Create an Order
post
Get All Orders
get
Delete All Orders
del
Get Order by Client Order ID
get
Get Order by ID
get
Replace Order by ID
patch
Delete Order by ID
del
Positions
All Open Positions
get
Close All Positions
del
Get an Open Position
get
Close a Position
del
Exercise an Options Position
post
Portfolio History
Get Account Portfolio History
get
Watchlists
Get All Watchlists
get
Create Watchlist
post
Get Watchlist by ID
get
Update Watchlist By Id
put
Add Asset to Watchlist
post
Delete Watchlist By Id
del
Get Watchlist by Name
get
Update Watchlist By Name
put
Add Asset to Watchlist By Name
post
Delete Watchlist By Name
del
Delete Symbol from Watchlist
del
Account Configurations
Get Account Configurations
get
Account Configurations
patch
Account Activities
Retrieve Account Activities
get
Retrieve Account Activities of Specific Type
get
Calendar
Get US Market Calendar
get
Get US Market Clock
get
Get Market Calendar
get
Get Market Clock
get
Crypto Funding
Retrieve Crypto Funding Wallets
get
Retrieve Crypto Funding Transfers
get
Request a New Withdrawal
post
Retrieve a Crypto Funding Transfer
get
An array of whitelisted addresses
get
Request a new whitelisted address
post
Delete a whitelisted address
del
Returns the estimated gas fee for a proposed transaction.
get
Positions
Do Not Exercise an Options Position
post
Market Data API
Stock
Historical auctions
get
Historical bars
get
Latest bars
get
Condition codes
get
Exchange codes
get
Historical quotes
get
Latest quotes
get
Snapshots
get
Historical trades
get
Latest trades
get
Historical auctions (single)
get
Historical bars (single symbol)
get
Latest bar (single symbol)
get
Historical quotes (single symbol)
get
Latest quote (single symbol)
get
Snapshot (single symbol)
get
Historical trades (single symbol)
get
Latest trade (single symbol)
get
Option
Historical bars
get
Condition codes
get
Exchange codes
get
Latest quotes
get
Snapshots
get
Option chain
get
Historical trades
get
Latest trades
get
Crypto
Historical bars
get
Latest bars
get
Latest orderbook
get
Latest quotes
get
Latest trades
get
Historical quotes
get
Snapshots
get
Historical trades
get
Fixed income
Latest prices
get
Forex
Latest rates for currency pairs
get
Historical rates for currency pairs
get
Logos
Logos
get
Screener
Most active stocks
get
Top market movers
get
News
News articles
get
Corporate actions
Corporate actions
get
Broker API
Accounts
Get All Accounts
get
Create an Account
post
Get An Account by ID
get
Update an Account
patch
Request options trading for an account (BETA)
post
Retrieve options level approval requests (BETA)
get
Retrieve Account Activities
get
Retrieve Account Activities of Specific Type
get
Retrieve Trading Details for an Account
get
Get Pattern Day Trader Status for account
get
Exercise PDT one time removal
post
Close an Account
post
Documents
Retrieve a List of Account Documents
get
Upload Owner Documents for an Existing Account
post
Download an Account Document
get
Download the W8BEN document for the primary owner of an account
get
Trading
List Open Positions for an Account
get
Close All Positions for an Account
del
Get an Open Position for account by Symbol or AssetId
get
Close a Position for an Account
del
Exercise an Options Position (BETA)
post
Do Not Exercise an Options Position (BETA)
post
Retrieve an Order by its ID
get
Replace an Order
patch
Cancel an Open Order
del
Retrieve a List of Orders
get
Retrieves a single order specified by the client order ID.
get
Create an Order for an Account
post
Cancel all Open Orders For an Account
del
Estimate an Order
post
Bulk Fetch All Accounts Positions
get
Update Trading Configurations for an Account
patch
Retrieve real-time Trading Limits for an Account
get
Instant Funding
Get Instant Funding List
get
Create an intant funding request
post
Get an instant funding request
get
Cancel an instant funding request
del
List settlements
get
Create a new settlement
post
Get a single settlement
get
Get instant funding limits
get
Get instant funding account limits
get
Get instant funding report
get
Assets
Retrieve All Assets
get
Retrieve an Asset by ID
get
Retrieve Entry Requirements for requested assets
get
Get Option Contracts (BETA)
get
Get an option contract by ID or Symbol (BETA)
get
Get US treasuries
get
Calendar
Get US Market Calendar
get
Get Market Calendar
get
Get US Market Clock
get
Get Market Clock
get
Events
Subscribe to Account Status Events (SSE)
get
Subscribe to Journal Events (SSE) (Legacy)
get
Subscribe to Journal Events (SSE)
get
Subscribe to Transfer Events (SSE) (Legacy)
get
Subscribe to Trade Events (SSE) (Legacy)
get
Subscribe to Trade Events (SSE)
get
Subscribe to Admin Action Events (SSE)
get
Subscribe to Non-Trading Activities Events (SSE)
get
Subscribe to Funding Status Events (SSE)
get
Subscribe to System Events (SSE)
get
Funding
Retrieve Bank Relationships for an Account
get
Create a Bank Relationship for an Account
post
Delete a Bank Relationship for an Account
del
Retrieve List of Transfers for an Account.
get
Request a New Transfer
post
Request to Close a Transfer
del
Retrieve ACH Relationships for an account
get
Create an ACH Relationship
post
Delete an existing ACH relationship
del
Retrieve JIT Reports
get
Retrieve Daily Trading Limits
get
Retrieve JIT Ledgers
get
Retrieve JIT Ledger Balances
get
List all JIT Settlements
get
Create a new JIT settlement
post
Get a single JIT settlement
get
Cash Interest
List APR Tiers
get
OAuth
Get an OAuth client
get
Issue an OAuth token
post
Authorize an OAuth Token
post
Journals
Retrieve a List Journals
get
Create a Journal
post
Cancel a Pending Journal
del
Retrieve a Single Journal Entry
get
Create a Batch Journal Transaction (One-to-Many)
post
Create a Reverse Batch Journal Transaction (Many-to-One)
post
FPSL Program
List FPSL Tiers
get
List FPSL Loans
get
Watchlist
Retrieve all Watchlists for an Account
get
Create a New Watchlist for an Account
post
Manage watchlists
get
Update a Watchlist
put
Remove a Watchlist
del
Add an Asset to a Watchlist
post
Remove a Symbol from a Watchlist
del
KYC
Upload CIP information
post
Retrieve CIP information
get
Retrieve an Onfido SDK Token
get
Update the Onfido SDK Outcome
patch
Funding Wallets
Create sandbox deposit transfer
post
Batch create funding wallets
post
Retrieve funding wallet
get
Creates a funding wallet
post
Retrieve funding details
get
Retrieve funding wallet transfers
get
Retrieve funding wallet transfer by ID
get
Retrieve recipient bank
get
Create a recipient bank
post
Delete a recipient bank
del
Create a withdrawal
post
Rebalancing
List Portfolios
get
Create Portfolio
post
Get Portfolio by ID
get
Update Portfolio by ID
patch
Inactivate Portfolio By ID
del
List All Subscriptions
get
Create Subscription
post
Get Subscription by ID
get
Unsubscribe Account (Delete Subscription)
del
List All Runs
get
Create Run (Manual rebalancing event)
post
Get Run by ID
get
Cancel Run by ID
del
Logos
Get Logo
get
Reporting
Retrieve Aggregate Positions
get
Retrieve EOD Positions
get
Retrieve EOD Cash Interest Details
get
Country Info
Retrieve countries information
get
Corporate Actions
Retrieve Announcements
get
Retrieve a Specific Announcement
get
IRA
Retrieve Excess Contributions
get
Portfolio History
Get Account Portfolio History
get
Crypto Funding
Retrieve Crypto Funding Wallets
get
Retrieve Crypto Funding Transfers
get
Request a New Withdrawal
post
Retrieve a Crypto Funding Transfer
get
An array of whitelisted addresses
get
Request a new whitelisted address
post
Delete a whitelisted address
del
Returns the estimated gas fee for a proposed transaction.
get
About Alpaca-py
Ask AI
