# Alpaca US Documentation > Alpaca offers simple, modern API-first solutions to get market data, trade stocks and crypto, build apps and more. ## Documentation: Introduction - [Welcome](https://docs.alpaca.markets/us/docs/getting-started.md): This page will help you get started with Alpaca Docs. You'll be up and running in a jiffy! - [About Alpaca](https://docs.alpaca.markets/us/docs/about-alpaca.md) - [Alpaca API Platform](https://docs.alpaca.markets/us/docs/alpaca-api-platform.md) - [Authentication](https://docs.alpaca.markets/us/docs/authentication.md) - [SDKs and Tools](https://docs.alpaca.markets/us/docs/sdks-and-tools.md) - [Additional Resources](https://docs.alpaca.markets/us/docs/additional-resources.md) - [Trading CLI](https://docs.alpaca.markets/us/docs/alpacas-cli.md) - [Trading API MCP](https://docs.alpaca.markets/us/docs/trading-api-mcp.md): Turn your words into action with Trading API's MCP Server - [Broker API MCP](https://docs.alpaca.markets/us/docs/broker-api-mcp.md): Operate, inspect, and reason over the Alpaca Broker API with AI agents; no local setup, no repo cloning, no partner-run infrastructure. ## Documentation: BROKER API - [About Broker API](https://docs.alpaca.markets/us/docs/about-broker-api.md): This is the documentation about Broker API that helps you build trading apps and brokerage services for your end users. If you are looking to build your own trading bots and algos, read the Trading… - [Getting Started with Broker API](https://docs.alpaca.markets/us/docs/getting-started-with-broker-api.md): This guide is going to help you set everything up in a sandbox environment to get you up and running with Broker API. - [Credentials Management](https://docs.alpaca.markets/us/docs/credential-management.md) - [Use Cases](https://docs.alpaca.markets/us/docs/use-cases.md) - [Integration Setup with Alpaca](https://docs.alpaca.markets/us/docs/integration-setup-with-alpaca.md): If you are coming to Alpaca for the first time to build something using Broker API, please sign up for the dashboard. In this dashboard, you can acquire your API key for the sandbox environment and… - [Broker API FAQs](https://docs.alpaca.markets/us/docs/broker-api-faq.md): Frequently Asked Questions - [Mandatory Corporate Actions](https://docs.alpaca.markets/us/docs/mandatory-corporate-actions.md): Frequently Asked Mandatory Corporate Action Questions - [Voluntary Corporate Actions](https://docs.alpaca.markets/us/docs/voluntary-corporate-actions.md): Frequently Asked Voluntary Corporate Action Questions - [FDIC Sweep Program](https://docs.alpaca.markets/us/docs/fdic-sweep-program.md) - [Instant Funding](https://docs.alpaca.markets/us/docs/instant-funding-1.md): Frequently Asked Instant Funding Questions - [Fully Paid Securities Lending (FPSL)](https://docs.alpaca.markets/us/docs/fully-paid-securities-lending.md): Frequently Asked Fully Paid Securities Lending Questions - [24/5 Trading](https://docs.alpaca.markets/us/docs/245-trading.md) - [OmniSub](https://docs.alpaca.markets/us/docs/omnisub.md) - [Fixed Income](https://docs.alpaca.markets/us/docs/fixed-income.md) - [ACATS API](https://docs.alpaca.markets/us/docs/acats-api.md) - [Intraday Margin Rule for Non-Leverage Margin Accounts](https://docs.alpaca.markets/us/docs/intraday-margin-rule-for-non-leverage-margin-accounts.md) - [The Intraday Margin Rule](https://docs.alpaca.markets/us/docs/the-intraday-margin-rule-1.md) - [Understanding FINRA’s New Intraday Margin Rule and the End of PDT](https://docs.alpaca.markets/us/docs/understanding-finras-new-intraday-margin-rule-and-the-end-of-pdt-1.md) - [US IPOs (Initial Public Offerings)](https://docs.alpaca.markets/us/docs/us-ipos-initial-public-offerings.md) - [Customer Account Opening](https://docs.alpaca.markets/us/docs/account-opening.md): If you are a fully-disclosed broker-dealer, an RIA, or a trading app setup, you can open your end customer’s account using Account API. The POST method allows you to submit all KYC information to… - [Accounts Statuses](https://docs.alpaca.markets/us/docs/accounts-statuses.md) - [International Accounts](https://docs.alpaca.markets/us/docs/international-accounts.md) - [Domestic (USA) Accounts](https://docs.alpaca.markets/us/docs/domestic-usa-accounts.md) - [Data Validations](https://docs.alpaca.markets/us/docs/data-validations.md) - [IRA Accounts Overview](https://docs.alpaca.markets/us/docs/ira-accounts-overview.md): Individual Retirement Arrangement (IRA) accounts are a retirement account type available to US tax residents. Alpaca supports both Roth IRA and Traditional IRA accounts for our Broker API customers.… - [Crypto Trading](https://docs.alpaca.markets/us/docs/crypto-trading-1.md): Alpaca supports crypto trading 24 hours a day, every day. Crypto is available for testing in sandbox, in case you want to allow your users to trade crypto please reach out to the Sales or Developer… - [Crypto Wallets API](https://docs.alpaca.markets/us/docs/crypto-wallets-api.md) - [Funding Accounts](https://docs.alpaca.markets/us/docs/funding-accounts.md): The funding process can vary depending on your setup and region and we support many cases, but everyone can do the same in the sandbox environment. - [Journals API](https://docs.alpaca.markets/us/docs/funding-via-journals.md) - [Funding Wallets](https://docs.alpaca.markets/us/docs/funding-wallets.md) - [ACH Funding](https://docs.alpaca.markets/us/docs/ach-funding.md) - [Instant Funding](https://docs.alpaca.markets/us/docs/instant-funding.md) - [Trading](https://docs.alpaca.markets/us/docs/brokerapi-trading.md): All the functionality from Alpaca Trading API for direct users is supported under Broker API. Please read the documentation for more details. There are additional capabilities for Trading API in the… - [Fully Paid Securities Lending (FPSL)](https://docs.alpaca.markets/us/docs/integrating-with-fully-paid-securitie-lending-fpsl-for-fully-disclosed.md) - [FPSL Integration Guide for Fully Disclosed](https://docs.alpaca.markets/us/docs/fpsl-integration-guide-for-fully-disclosed.md): The Fully-Paid Securities Lending (FPSL) program enables customers to lend securities they have fully paid for, generating additional returns while retaining beneficial ownership. With Alpaca’s API,… - [FPSL Integration Guide for OmniSub](https://docs.alpaca.markets/us/docs/fpsl-integration-guide-for-omnisub.md): The Fully-Paid Securities Lending (FPSL) program enables customers to lend securities they have fully paid for, generating additional returns while retaining beneficial ownership. With Alpaca’s API,… - [Portfolio Rebalancing](https://docs.alpaca.markets/us/docs/portfolio-rebalancing.md) - [SSE Events](https://docs.alpaca.markets/us/docs/sse-events.md) - [Account Status Events for KYCaaS](https://docs.alpaca.markets/us/docs/account-status-events-for-kycaas.md) - [Activities](https://docs.alpaca.markets/us/docs/activity-sse.md): Integration Guide & Migration Playbook - [Daily Processes and Reconcilations](https://docs.alpaca.markets/us/docs/daily-processes-and-reconcilations.md) - [Banking Holiday Funding Processes](https://docs.alpaca.markets/us/docs/holiday-funding-processes.md): This section addresses operational procedures for scenarios where the bank is closed for a holiday, but the stock market remains open for trading (e.g., Columbus Day, Veterans Day). - [Statements and Confirms](https://docs.alpaca.markets/us/docs/statements-and-confirms.md) - [Local Currency Trading (LCT)](https://docs.alpaca.markets/us/docs/local-currency-trading-lct.md): Local Currency Trading allows customers to trade US equities in over 15+ local currencies, with FX conversion done on-the-fly. Customers can place, monitor and sell their positions in their local… - [Options Trading Overview](https://docs.alpaca.markets/us/docs/options-trading-overview.md) - [Index Options](https://docs.alpaca.markets/us/docs/index-options.md) - [Fixed Income](https://docs.alpaca.markets/us/docs/fixed-income-1.md): This guide provides a comprehensive reference for integrating U.S. Treasuries and U.S. Corporate Bonds into your platform. - [Tokenization Guide for Issuer](https://docs.alpaca.markets/us/docs/tokenization-guide-for-issuer.md): Instant Tokenization Network (ITN) is a platform designed to streamline and accelerate the process of in-kind mint and redemption of tokenized assets. The goal of ITN is to enable efficient, secure,… - [Tokenization Guide for Authorized Participant](https://docs.alpaca.markets/us/docs/tokenization-guide-for-authorized-participant.md): The Instant Tokenization Network (ITN) is a platform designed to streamline and accelerate the process of in-kind creation and redemption of tokenized assets. The goal of the ITN is to enable… - [US IPOs (Initial Public Offerings)](https://docs.alpaca.markets/us/docs/us-ipos-initial-public-offerings-1.md): This guide provides a comprehensive reference for integrating U.S. IPOs into your platform. - [Rate Limits](https://docs.alpaca.markets/us/docs/broker-api-rate-limits.md) - [Custodial accounts](https://docs.alpaca.markets/us/docs/custodial-accounts.md) ## Documentation: TRADING API - [About Trading API](https://docs.alpaca.markets/us/docs/trading-api.md): Trade stocks & crypto with Alpaca’s easy to use Trading API. Up to 4X intraday & 2X overnight buying power. Short selling. Advanced order types. All packaged and delivered through our API. - [Getting Started with Trading API](https://docs.alpaca.markets/us/docs/getting-started-with-trading-api.md): This section outlines how to install Alpaca’s SDKs, create a free alpaca account, locate your API keys, and how to submit orders applicable for both stocks and crypto. - [Working with /account](https://docs.alpaca.markets/us/docs/working-with-account.md): Learn how to use the /account endpoint to learn about the state of your account - [Working with /assets](https://docs.alpaca.markets/us/docs/working-with-assets.md): Learn how to use the `/assets` endpoint to learn more about assets available on Alpaca. Both Securities and Crypto can be retrieved from the `/assets` endpoint. - [Working with /orders](https://docs.alpaca.markets/us/docs/working-with-orders.md): Learn how to submit orders to Alpaca. - [Working with /positions](https://docs.alpaca.markets/us/docs/working-with-positions.md) - [Paper Trading](https://docs.alpaca.markets/us/docs/paper-trading.md): Test your algos in our paper environment. Free and available to all Alpaca users. - [Trading Account](https://docs.alpaca.markets/us/docs/account-plans.md) - [Crypto Spot Trading](https://docs.alpaca.markets/us/docs/crypto-trading.md): Trade crypto through our API and the Alpaca web dashboard! Trade all day, seven days a week, as frequently as you’d like. - [Crypto Orders](https://docs.alpaca.markets/us/docs/crypto-orders.md) - [Crypto Pricing Data](https://docs.alpaca.markets/us/docs/crypto-pricing-data.md): Alpaca provides free limited crypto data and a more advanced unlimited paid plan. - [Crypto Spot Trading Fees](https://docs.alpaca.markets/us/docs/crypto-fees.md) - [Options Trading](https://docs.alpaca.markets/us/docs/options-trading.md): We're excited to support options trading! Use this section to read up on Alpaca's options trading capabilities. - [Options Orders](https://docs.alpaca.markets/us/docs/options-orders.md): This page provides examples of valid order payloads - [Options Level 3 Trading](https://docs.alpaca.markets/us/docs/options-level-3-trading.md): We're excited to support Multi-leg options trading! Use this section to read up on Alpaca's Multi-leg options trading capabilities. - [Non-Trade Activities for Option Events](https://docs.alpaca.markets/us/docs/non-trade-activities-for-option-events.md): This page provides an overview of new NTAs for options-specific events - [Account Activities](https://docs.alpaca.markets/us/docs/account-activities.md): The account activities API provides access to a historical record of transaction activities that have impacted your account. - [Fractional Trading](https://docs.alpaca.markets/us/docs/fractional-trading.md) - [Margin and Short Selling](https://docs.alpaca.markets/us/docs/margin-and-short-selling.md) - [Placing Orders](https://docs.alpaca.markets/us/docs/orders-at-alpaca.md) - [DMA Gateway / Advanced Order Types](https://docs.alpaca.markets/us/docs/alpaca-elite-smart-router.md): Take Control of Your Trades with Direct Market Access Gateway and Advanced Order Types - [User Protection](https://docs.alpaca.markets/us/docs/user-protection.md) - [Websocket Streaming](https://docs.alpaca.markets/us/docs/websocket-streaming.md): Learn how to stream market data using Websockets. - Trading API FAQs - [24/5 Trading](https://docs.alpaca.markets/us/docs/245-trading-for-trading-api.md) - [Position Average Entry Price Calculation](https://docs.alpaca.markets/us/docs/position-average-entry-price-calculation.md): How is the average entry price of a position is calculated? - [Intraday Margin Rule for Non-Leverage Margin Accounts](https://docs.alpaca.markets/us/docs/understanding-the-new-intraday-margin-rule.md) - [The Intraday Margin Rule](https://docs.alpaca.markets/us/docs/the-intraday-margin-rule.md) - [Understanding FINRA’s New Intraday Margin Rule and the End of PDT](https://docs.alpaca.markets/us/docs/understanding-finras-new-intraday-margin-rule-and-the-end-of-pdt.md) - [Regulatory Fees](https://docs.alpaca.markets/us/docs/regulatory-fees.md) ## Documentation: Market Data API - [About Market Data API](https://docs.alpaca.markets/us/docs/about-market-data-api.md): Gain seamless access to a wealth of data with Alpaca Market Data API, offering real-time and historical information for equities, options, crypto and more. - [Getting Started with Market Data API](https://docs.alpaca.markets/us/docs/getting-started-with-alpaca-market-data.md): This is a quick guide on how to start consuming market data via APIs. Starting from beginning to end, this section outlines how to install Alpaca’s software development kit (SDK), create a free… - [Historical API](https://docs.alpaca.markets/us/docs/historical-api.md) - [Historical Stock Data](https://docs.alpaca.markets/us/docs/historical-stock-data-1.md) - [Historical Crypto Data](https://docs.alpaca.markets/us/docs/historical-crypto-data-1.md) - [Historical Option Data](https://docs.alpaca.markets/us/docs/historical-option-data.md) - [Historical News Data](https://docs.alpaca.markets/us/docs/historical-news-data.md) - [WebSocket Stream](https://docs.alpaca.markets/us/docs/streaming-market-data.md) - [Real-time Stock Data](https://docs.alpaca.markets/us/docs/real-time-stock-pricing-data.md) - [Real-time Crypto Data](https://docs.alpaca.markets/us/docs/real-time-crypto-pricing-data.md) - [Real-time News](https://docs.alpaca.markets/us/docs/streaming-real-time-news.md) - [Real-time Option Data](https://docs.alpaca.markets/us/docs/real-time-option-data.md) - [Market Data FAQ](https://docs.alpaca.markets/us/docs/market-data-faq.md): Frequently Asked Questions ## Documentation: Connect API - [About Connect API](https://docs.alpaca.markets/us/docs/about-connect-api.md): Develop applications on Alpaca’s platform using OAuth2. Let 10M+ users with an Alpaca brokerage account connect to your app. - [Registering Your App](https://docs.alpaca.markets/us/docs/registering-your-app.md) - [Using OAuth2 and Trading API](https://docs.alpaca.markets/us/docs/using-oauth2-and-trading-api.md): Alpaca implements OAuth 2.0 to allow third party applications to access Alpaca Trading API on behalf of the end-users. This document describes how you can integrate with Alpaca through OAuth. ## Documentation: FIX API - [About FIX API](https://docs.alpaca.markets/us/docs/5f36ea05-b1b4-5fd1-91b5-ef51db361a4b.md): Alpaca FIX (Financial Information eXchange) API - [FIX Specification](https://docs.alpaca.markets/us/docs/fix-messages.md): This document describes the implementation of the FIX 4.2 protocol used by Alpaca to enable order entry via FIX. ## API Reference: Authentication API - OAuth2 - [Issue tokens](https://docs.alpaca.markets/us/reference/issuetokens.md): Issue access tokens using various grant types: - `client_credentials`: Exchange client credentials for an access token - `urn:ietf:params:oauth:grant-type:jwt-bearer`: Exchange JWT assertion… ## API Reference: Trading API - Accounts - [Get Account](https://docs.alpaca.markets/us/reference/getaccount-1.md): Returns your account details. - Assets - [Get Assets](https://docs.alpaca.markets/us/reference/get-v2-assets-1.md): The assets API serves as the master list of assets available for trade and data consumption from Alpaca. Assets are sorted by asset class, exchange and symbol. - [Get an Asset by ID or Symbol](https://docs.alpaca.markets/us/reference/get-v2-assets-symbol_or_asset_id.md): Get the asset model for a given symbol or asset_id. The symbol or asset_id should be passed in as a path parameter. **Note**: For crypto, the symbol has to follow old symbology, e.g. BTCUSD.… - [Get Option Contracts](https://docs.alpaca.markets/us/reference/get-options-contracts.md): This endpoint allows you to retrieve a list of option contracts based on various filtering criteria. By default only active contracts that expire before the upcoming weekend are returned. - [Get an option contract by ID or Symbol](https://docs.alpaca.markets/us/reference/get-option-contract-symbol_or_id.md): Get an option contract by symbol or contract ID. The symbol or id should be passed in as a path parameter. - Corporate Actions - [Retrieve a Specific Announcement](https://docs.alpaca.markets/us/reference/get-v2-corporate_actions-announcements-id-1.md): This endpoint is deprecated, please use [the new corporate actions endpoint](https://docs.alpaca.markets/reference/corporateactions-1) instead. - [Retrieve Announcements](https://docs.alpaca.markets/us/reference/get-v2-corporate_actions-announcements-1.md): This endpoint is deprecated, please use [the new corporate actions endpoint](https://docs.alpaca.markets/reference/corporateactions-1) instead. - Orders - [Create an Order](https://docs.alpaca.markets/us/reference/postorder.md): Places a new order for the given account. An order request may be rejected if the account is not authorized for trading, or if the tradable balance is insufficient to fill the order. - [Get All Orders](https://docs.alpaca.markets/us/reference/getallorders-1.md): Retrieves a list of orders for the account, filtered by the supplied query parameters. - [Delete All Orders](https://docs.alpaca.markets/us/reference/deleteallorders-1.md): Attempts to cancel all open orders. A response will be provided for each order that is attempted to be cancelled. If an order is no longer cancelable, the server will respond with status 500 and… - [Get Order by Client Order ID](https://docs.alpaca.markets/us/reference/getorderbyclientorderid.md): Retrieves a single order specified by the client order ID. - [Get Order by ID](https://docs.alpaca.markets/us/reference/getorderbyorderid-1.md): Retrieves a single order for the given order_id. - [Replace Order by ID](https://docs.alpaca.markets/us/reference/patchorderbyorderid-1.md): Replaces a single order with updated parameters. Each parameter overrides the corresponding attribute of the existing order. The other attributes remain the same as the existing order. A success… - [Delete Order by ID](https://docs.alpaca.markets/us/reference/deleteorderbyorderid-1.md): Attempts to cancel an Open Order. If the order is no longer cancelable, the request will be rejected with status 422; otherwise accepted with return status 204. - Positions - [All Open Positions](https://docs.alpaca.markets/us/reference/getallopenpositions.md): The positions API provides information about an account's current open positions. The response will include information such as cost basis, shares traded, and market value, which will be updated live… - [Close All Positions](https://docs.alpaca.markets/us/reference/deleteallopenpositions-1.md): Closes (liquidates) all of the account's open long and short positions. A response will be provided for each order that is attempted to be cancelled. If an order is no longer cancelable, the server… - [Get an Open Position](https://docs.alpaca.markets/us/reference/getopenposition-1.md): Retrieves the account's open position for the given symbol or assetId. - [Close a Position](https://docs.alpaca.markets/us/reference/deleteopenposition-1.md): Closes (liquidates) the account's open position for the given symbol. Works for both long and short positions. - [Exercise an Options Position](https://docs.alpaca.markets/us/reference/optionexercise.md): This endpoint enables users to exercise a held option contract, converting it into the underlying asset based on the specified terms. All available held shares of this option contract will be… - Portfolio History - [Get Account Portfolio History](https://docs.alpaca.markets/us/reference/getaccountportfoliohistory-1.md): Returns timeseries data about equity and profit/loss (P/L) of the account in requested timespan. - Watchlists - [Get All Watchlists](https://docs.alpaca.markets/us/reference/getwatchlists-1.md): Returns the list of watchlists registered under the account. - [Create Watchlist](https://docs.alpaca.markets/us/reference/postwatchlist-1.md): Create a new watchlist with initial set of assets. - [Get Watchlist by ID](https://docs.alpaca.markets/us/reference/getwatchlistbyid-1.md): Returns a watchlist identified by the ID. - [Update Watchlist By Id](https://docs.alpaca.markets/us/reference/updatewatchlistbyid-1.md): Update the name and/or content of watchlist - [Add Asset to Watchlist](https://docs.alpaca.markets/us/reference/addassettowatchlist-1.md): Append an asset for the symbol to the end of watchlist asset list - [Delete Watchlist By Id](https://docs.alpaca.markets/us/reference/deletewatchlistbyid-1.md): Delete a watchlist. This is a permanent deletion. - [Get Watchlist by Name](https://docs.alpaca.markets/us/reference/getwatchlistbyname-1.md): You can also call GET, PUT, POST and DELETE with watchlist name with another endpoint /v2/watchlists:by_name and query parameter name=, instead of /v2/watchlists/{watchlist_id}… - [Update Watchlist By Name](https://docs.alpaca.markets/us/reference/updatewatchlistbyname-1.md): Update the name and/or content of watchlist - [Add Asset to Watchlist By Name](https://docs.alpaca.markets/us/reference/addassettowatchlistbyname-1.md): Append an asset for the symbol to the end of watchlist asset list - [Delete Watchlist By Name](https://docs.alpaca.markets/us/reference/deletewatchlistbyname-1.md): Delete a watchlist. This is a permanent deletion. - [Delete Symbol from Watchlist](https://docs.alpaca.markets/us/reference/removeassetfromwatchlist-1.md): Delete one entry for an asset by symbol name - Account Configurations - [Get Account Configurations](https://docs.alpaca.markets/us/reference/getaccountconfig-1.md): gets the current account configuration values - [Account Configurations](https://docs.alpaca.markets/us/reference/patchaccountconfig-1.md): Updates and returns the current account configuration values - Account Activities - [Retrieve Account Activities](https://docs.alpaca.markets/us/reference/getaccountactivities-2.md): Returns a list of activities Notes: * Pagination is handled using the `page_token` and `page_size` parameters. * `page_token` represents the ID of the last item on your current page of results.… - [Retrieve Account Activities of Specific Type](https://docs.alpaca.markets/us/reference/getaccountactivitiesbyactivitytype-1.md): Returns account activity entries for a specific type of activity. - Calendar - [Get US Market Calendar](https://docs.alpaca.markets/us/reference/legacycalendar.md): The calendar API serves the full list of market days from 1970 to 2029. It can also be queried by specifying a start and/or end time to narrow down the results. In addition to the dates, the response… - [Get US Market Clock](https://docs.alpaca.markets/us/reference/legacyclock.md): The clock API serves the current market timestamp, whether or not the market is currently open, as well as the times of the next market open and close. - [Get Market Calendar](https://docs.alpaca.markets/us/reference/calendar-2.md): This endpoint returns the market calendar. - [Get Market Clock](https://docs.alpaca.markets/us/reference/clock-1.md): This API serves information about multiple markets: the current time, if it's a market day, the current phase of the market, etc. - Crypto Funding - [Retrieve Crypto Funding Wallets](https://docs.alpaca.markets/us/reference/listcryptofundingwallets.md): Lists wallets for the account given in the path parameter. If an asset is specified and no wallet for the account and asset pair exists one will be created. If no asset is specified only existing… - [Retrieve Crypto Funding Transfers](https://docs.alpaca.markets/us/reference/listcryptofundingtransfers.md): Returns an array of all transfers associated with the given account across all wallets. - [Retrieve a Crypto Funding Transfer](https://docs.alpaca.markets/us/reference/getcryptofundingtransfer.md): Returns a specific wallet transfer by passing into the query the transfer_id. - [An array of whitelisted addresses](https://docs.alpaca.markets/us/reference/listwhitelistedaddress.md): Returns the list of whitelisted withdrawal addresses for your account. - [Request a new whitelisted address](https://docs.alpaca.markets/us/reference/createwhitelistedaddress.md): Submits a new whitelisted withdrawal address for your account. The chain is derived from the supplied asset symbol and address, and the same address cannot be whitelisted twice on the same chain.… - [Delete a whitelisted address](https://docs.alpaca.markets/us/reference/deletewhitelistedaddress.md): Deletes a whitelisted withdrawal address by ID. Subsequent withdrawals targeting the deleted address will be rejected. - [Returns the estimated gas fee for a proposed transaction.](https://docs.alpaca.markets/us/reference/getcryptotransferestimate.md): Returns the estimated on-chain network (gas) fee for a proposed crypto withdrawal at current chain conditions. Pass the `asset`, `from_address`, `to_address`, and `amount` you intend to send; the… - [Search for VASPs](https://docs.alpaca.markets/us/reference/searchvasps-1.md): Search for Virtual Asset Service Providers, or crypto exchanges, on Notabene's network. This endpoint can be used to find the VASP DID for your beneficiary's exchange when submitting travel rule… - [Update travel rule information for a whitelisted wallet](https://docs.alpaca.markets/us/reference/updatewhitelistedaddresstravelruleinfo-1.md): You are required to supply travel rule information for the crypto wallets you're withdrawing to. It is preferred that you use the `Search VASPs` endpoint to find the VASP DID for the exchange you… - Positions - [Do Not Exercise an Options Position](https://docs.alpaca.markets/us/reference/optiondonotexercise.md): This endpoint enables users to submit a do-not-exercise (DNE) instruction for a held option contract, preventing automatic exercise at expiry. By default, Alpaca will automatically exercise… - Tokenization - [Mint a Tokenized Asset](https://docs.alpaca.markets/us/reference/posttokenizationmint.md): This endpoint is used by an Authorized Participant to request the minting of a tokenized asset. **Idempotency**: When the `Idempotency-Key` header is supplied, this endpoint is idempotent. Multiple… - [List Tokenization Requests](https://docs.alpaca.markets/us/reference/gettokenizationrequests.md): An Authorized Participant can use this endpoint to list the tokenization requests performed on the Instant Tokenization Network (ITN). - [Get Tokenization Request by ID](https://docs.alpaca.markets/us/reference/gettokenizationrequest.md): An Authorized Participant can use this endpoint to retrieve a single tokenization request, mint or redeem, by its `tokenization_request_id`. - [Get Tokenization Request by `client_request_id`](https://docs.alpaca.markets/us/reference/gettokenizationrequestbyclientrequestid.md): An Authorized Participant can use this endpoint to retrieve a single mint tokenization request by their own `client_request_id` -- the AP-supplied label originally passed on the mint request. If the… - Locates - [List Locates](https://docs.alpaca.markets/us/reference/listlocates.md): Returns locates filtered by status, symbol, or date range. Results are sorted by `created_at` descending, with `id` descending as the tie-breaker. This endpoint is not available in paper trading. - [Create Locate](https://docs.alpaca.markets/us/reference/createlocates.md): Creates a locate request for a short sale. This endpoint is not available in paper trading. **Idempotency**: Reusing the same key with the same request returns the original locate response. Reusing… - [Get Locate](https://docs.alpaca.markets/us/reference/getlocate.md): Returns a locate by ID. This endpoint is not available in paper trading. - [Get Locate Quotes](https://docs.alpaca.markets/us/reference/listlocatequotes.md): Returns locate availability and pricing for one or more symbols. This endpoint is not available in paper trading. - Events - [Subscribe to Activity Events (SSE)](https://docs.alpaca.markets/us/reference/subscribetoactivitiessse.md): The Events API sends the real-time events and provides historical queries with SSE (Server Sent Events). This endpoint streams events on account activities. Historical events are streamed… ## API Reference: Market Data API - Stock - [Historical auctions](https://docs.alpaca.markets/us/reference/stockauctions-1.md): The historical auctions endpoint provides auction prices for a list of stock symbols between the specified dates. - [Historical bars](https://docs.alpaca.markets/us/reference/stockbars.md): The historical stock bars API provides aggregates for a list of stock symbols between the specified dates. The returned results are sorted by symbol first, then by bar timestamp. This means that you… - [Latest bars](https://docs.alpaca.markets/us/reference/stocklatestbars-1.md): The latest bars endpoint provides the latest minute bar for the given ticker symbols. - [Condition codes](https://docs.alpaca.markets/us/reference/stockmetaconditions-1.md): Returns the mapping between the condition codes and names. - [Exchange codes](https://docs.alpaca.markets/us/reference/stockmetaexchanges-1.md): Returns the mapping between the stock exchange codes and the corresponding exchange names. - [Historical quotes](https://docs.alpaca.markets/us/reference/stockquotes-1.md): The historical stock quotes API provides quote data for a list of stock symbols between the specified dates. The returned results are sorted by symbol first, then by the quote timestamp. This means… - [Latest quotes](https://docs.alpaca.markets/us/reference/stocklatestquotes-1.md): The latest quotes endpoint provides the latest best bid and ask prices for the given ticker symbols. - [Snapshots](https://docs.alpaca.markets/us/reference/stocksnapshots-1.md): The snapshot endpoint for multiple tickers provides the latest trade, latest quote, minute bar, daily bar, and previous daily bar data for each given ticker symbol. - [Historical trades](https://docs.alpaca.markets/us/reference/stocktrades-1.md): The historical stock trades API provides trade data for a list of stock symbols between the specified dates. The returned results are sorted by symbol first then by trade timestamp. This means that… - [Latest trades](https://docs.alpaca.markets/us/reference/stocklatesttrades-1.md): The latest trades endpoint provides the latest trades for the given ticker symbols. Trades with any conditions that causes them to not update the bar price are excluded. For example a trade with… - [Historical auctions (single)](https://docs.alpaca.markets/us/reference/stockauctionsingle-1.md): The historical auctions endpoint provides auction prices for the given stock symbol between the specified dates. - [Historical bars (single symbol)](https://docs.alpaca.markets/us/reference/stockbarsingle-1.md): The historical stock bars API provides aggregates for the stock symbol between the specified dates. - [Latest bar (single symbol)](https://docs.alpaca.markets/us/reference/stocklatestbarsingle-1.md): The latest bar endpoint returns the latest minute bar for the given ticker symbol. - [Historical quotes (single symbol)](https://docs.alpaca.markets/us/reference/stockquotesingle-1.md): The historical stock quotes API provides quote data for a stock symbol between the specified dates. - [Latest quote (single symbol)](https://docs.alpaca.markets/us/reference/stocklatestquotesingle-1.md): The latest quote endpoint provides the latest best bid and ask prices for a given ticker symbol. - [Snapshot (single symbol)](https://docs.alpaca.markets/us/reference/stocksnapshotsingle.md): The snapshot endpoint provides the latest trade, latest quote, minute bar, daily bar, and previous daily bar data for a given ticker symbol. - [Historical trades (single symbol)](https://docs.alpaca.markets/us/reference/stocktradesingle-1.md): The historical stock trades API provides trade data for a stock symbol between the specified dates. - [Latest trade (single symbol)](https://docs.alpaca.markets/us/reference/stocklatesttradesingle-1.md): The latest trade endpoint provides the latest trade for the given ticker symbol. Trades with any conditions that causes them to not update the bar price are excluded. For example a trade with… - Option - [Historical bars](https://docs.alpaca.markets/us/reference/optionbars.md): The historical option bars API provides aggregates for a list of option symbols between the specified dates. The returned results are sorted by symbol first, then by bar timestamp. This means that… - [Condition codes](https://docs.alpaca.markets/us/reference/optionmetaconditions.md): Returns the mapping between the condition codes and names. - [Exchange codes](https://docs.alpaca.markets/us/reference/optionmetaexchanges.md): Returns the mapping between the option exchange codes and the corresponding exchange names. - [Latest quotes](https://docs.alpaca.markets/us/reference/optionlatestquotes.md): The latest multi-quotes endpoint provides the latest bid and ask prices for each given contract symbol. - [Snapshots](https://docs.alpaca.markets/us/reference/optionsnapshots.md): The snapshots endpoint provides the latest trade, latest quote and greeks for each given contract symbol. - [Option chain](https://docs.alpaca.markets/us/reference/optionchain.md): The option chain endpoint provides the latest trade, latest quote, and greeks for each contract symbol of the underlying symbol. - [Historical trades](https://docs.alpaca.markets/us/reference/optiontrades.md): The historical option trades API provides trade data for a list of contract symbols between the specified dates. The returned results are sorted by symbol first then by trade timestamp. This means… - [Latest trades](https://docs.alpaca.markets/us/reference/optionlatesttrades.md): The latest multi-trades endpoint provides the latest historical trade data for multiple given contract symbols. - Crypto - [Historical bars](https://docs.alpaca.markets/us/reference/cryptobars-1.md): The crypto bars API provides historical aggregates for a list of crypto symbols between the specified dates. - [Latest bars](https://docs.alpaca.markets/us/reference/cryptolatestbars-1.md): The latest multi-bars endpoint returns the latest minute-aggregated historical bar data for each of the crypto symbols provided. - [Latest orderbook](https://docs.alpaca.markets/us/reference/cryptolatestorderbooks-1.md): The latest orderbook endpoint returns the latest bid and ask orderbook for the crypto symbols provided. - [Latest quotes](https://docs.alpaca.markets/us/reference/cryptolatestquotes-1.md): The latest quotes endpoint returns the latest bid and ask prices for the crypto symbols provided. - [Latest trades](https://docs.alpaca.markets/us/reference/cryptolatesttrades-1.md): The latest trades endpoint returns the latest trade data for the crypto symbols provided. - [Historical quotes](https://docs.alpaca.markets/us/reference/cryptoquotes-1.md): The crypto quotes API provides historical quote data for a list of crypto symbols between the specified dates. The oldest date to retrieve historical quotes of us-1 location is 14th October, 2025… - [Snapshots](https://docs.alpaca.markets/us/reference/cryptosnapshots-1.md): The snapshots endpoint returns the latest trade, latest quote, latest minute bar, latest daily bar, and previous daily bar data for crypto symbols. - [Historical trades](https://docs.alpaca.markets/us/reference/cryptotrades-1.md): The crypto trades API provides historical trade data for a list of crypto symbols between the specified dates. - Fixed income - [Latest prices](https://docs.alpaca.markets/us/reference/fixedincomelatestprices.md): This endpoint returns the latest prices for the given fixed income securities. - [Latest quotes](https://docs.alpaca.markets/us/reference/fixedincomelatestquotes.md): This endpoint returns the latest quotes for the given fixed income securities. - Forex - [Latest rates for currency pairs](https://docs.alpaca.markets/us/reference/latestrates-1.md): Get the latest forex rates for the given currency pairs. - [Historical rates for currency pairs](https://docs.alpaca.markets/us/reference/rates-1.md): Get historical forex rates for the given currency pairs in the given time interval and at the given timeframe (snapshot frequency). - Logos - [Logos](https://docs.alpaca.markets/us/reference/logos-5.md): Get the image of the company logo for the given symbol. - Screener - [Most active stocks](https://docs.alpaca.markets/us/reference/mostactives-1.md): Returns the most active stocks by volume or trade count based on real time SIP data. By default, returns the top 10 symbols by volume. - [Top market movers](https://docs.alpaca.markets/us/reference/movers-1.md): Returns the top market movers (gainers and losers) based on real time SIP data. The change for each symbol is calculated from the previous closing price and the latest closing price. For stocks, the… - News - [News articles](https://docs.alpaca.markets/us/reference/news-3.md): Returns the latest news articles across stocks and crypto. By default, returns the latest 10 news articles. - Corporate actions - [Corporate actions](https://docs.alpaca.markets/us/reference/corporateactions-1.md): This endpoint provides data about the corporate actions for each given symbol over a specified time period. By default (`data_quality=complete`), corporate actions that are still incomplete (for… - [Subscribe to Corporate Actions Events (SSE)](https://docs.alpaca.markets/us/reference/subscribetocorporateactionseventssse.md): Server-Sent Events (SSE) stream that delivers every corporate-action mutation (`insert` / `update` / `delete`) across all supported CA types on a single long-lived `text/event-stream` connection.… ## API Reference: Broker API - Accounts - [Get All Accounts](https://docs.alpaca.markets/us/reference/getallaccounts.md): Retrieves the first 1000 accounts that match the query parameters. Sorting is based on creation time. The created_after/created_before query parameters can be used to paginate the results. To further… - [Create an Account](https://docs.alpaca.markets/us/reference/createaccount.md): Create an account for a new or existing account holder. Required fields, eligibility, and initial status depend on the account type, enabled assets, and your correspondent configuration. Account… - [Get An Account by ID](https://docs.alpaca.markets/us/reference/getaccount.md): You can query a specific account that you submitted to Alpaca by passing into the query the account_id associated with the account you're retrieving. - [Update an Account](https://docs.alpaca.markets/us/reference/patchaccount.md): This operation updates account information. If all parameters are valid and updates have been made, it returns with status code 200. The response is the account model. - [Request options trading for an account (BETA)](https://docs.alpaca.markets/us/reference/requestoptionsforaccount.md): This endpoint requests options trading for an account. Following submission, an assigned administrator will review the request. Upon approval, the account's options_approved_level parameter will be… - [Retrieve options level approval requests (BETA)](https://docs.alpaca.markets/us/reference/requestlistoptionsapprovals.md): This endpoint retrieves options trading level approval requests. Query parameters can be specified to filter the results. If multiple query parameters are specified, the results will be filtered to… - [Retrieve Account Activities](https://docs.alpaca.markets/us/reference/getaccountactivities.md): Returns a list of activities Notes: * Pagination is handled using the `page_token` and `page_size` parameters. * `page_token` represents the ID of the last item on your current page of results.… - [Retrieve Account Activities of Specific Type](https://docs.alpaca.markets/us/reference/getaccountactivitiesbytype.md): Retrieves an array of Activity by type. If {activity_type} is provided as part of the URL, category cannot be provided as query parameter. They are mutually exclusive. Notes: * Pagination is… - [Retrieve Trading Details for an Account](https://docs.alpaca.markets/us/reference/gettradingaccount.md): As a broker you can view more trading details about your users. The response is a Trading Account model. - [Close an Account](https://docs.alpaca.markets/us/reference/post-v1-accounts-account_id-actions-close.md): This operation closes an active account. The underlying records and information of the account are not deleted by this operation. **Before closing an account, you are responsible for closing all the… - [Get a single activity (V2) event by event_id ULID.](https://docs.alpaca.markets/us/reference/getaccountactivityevent.md): Returns a single account activity (V2) event for the specified account by ULID `event_id`, delivered as a server-sent event message. This is the single-event counterpart to the… - Agreements - [Create a Signed Agreement](https://docs.alpaca.markets/us/reference/createagreement.md): Create a signed agreement for a party. Use this endpoint to record party-level agreements after party creation (for example `certifications_and_resolutions_statement` when it was not included on… - Documents - [Retrieve a List of Account Documents](https://docs.alpaca.markets/us/reference/getdocsforaccount.md): This endpoint allows you to query all the account document based on an account ID. You can filter by date, or type of document. These account documents are tax statements, trade confirmations, etc,… - [Upload Owner Documents for an Existing Account](https://docs.alpaca.markets/us/reference/uploaddoctoaccount.md): Upload documents for the primary account owner of an account. Documents are binary objects whose contents are encoded in base64. Each encoded content size is limited to 10MB if you use Alpaca for… - [Download an Account Document](https://docs.alpaca.markets/us/reference/downloaddocfromaccount.md): This endpoint downloads an account document based on the document ID. The document will be in PDF format. The operation returns a pre-signed downloadable link as a redirect with HTTP status code 301… - [Download the W8BEN document for the primary owner of an account](https://docs.alpaca.markets/us/reference/get-v1-accounts-account_id-documents-w8ben-document_id-download.md): This endpoint allows you to download a W-8 BEN document for the primary owner of an account based on the document_id passed as a path parameter. The returned document is in PDF format. For certain… - Trading - [List Open Positions for an Account](https://docs.alpaca.markets/us/reference/getpositionsforaccount.md): List open positions for an account - [Close All Positions for an Account](https://docs.alpaca.markets/us/reference/closeallpositionsforaccount.md): Closes (liquidates) all of the account's open long and short positions. A response will be provided for each order that is attempted to be cancelled. If an order is no longer cancelable, the server… - [Get an Open Position for account by Symbol or AssetId](https://docs.alpaca.markets/us/reference/getpositionsforaccountbysymbol.md): Retrieves the account's open position for the given symbol or asset_id. - [Close a Position for an Account](https://docs.alpaca.markets/us/reference/closepositionforaccountbysymbol.md): Closes (liquidates) the account's open position for the given symbol. Works for both long and short positions. - [Exercise an Options Position](https://docs.alpaca.markets/us/reference/optionexercise-1.md): This endpoint enables users to exercise a held option contract, converting it into the underlying asset based on the specified terms. All available held shares of this option contract will be… - [Do Not Exercise an Options Position](https://docs.alpaca.markets/us/reference/optiondonotexercise-1.md): This endpoint enables users to submit a do-not-exercise (DNE) instruction for a held option contract, preventing automatic exercise at expiry. By default, Alpaca will automatically exercise… - [Retrieve an Order by its ID](https://docs.alpaca.markets/us/reference/getorderforaccount.md): Retrieves a single order for the given order_id. - [Replace an Order](https://docs.alpaca.markets/us/reference/replaceorderforaccount.md): Replaces a single order with updated parameters. Each parameter overrides the corresponding attribute of the existing order. The other attributes remain the same as the existing order. A success… - [Cancel an Open Order](https://docs.alpaca.markets/us/reference/deleteorderforaccount.md): Attempts to cancel an open order. If the order is no longer cancelable (for example if the status is "filled"), the server will respond with status 422, and reject the request. Upon acceptance of… - [Retrieve a List of Orders](https://docs.alpaca.markets/us/reference/getallordersforaccount.md): Retrieves a list of orders for the account, filtered by the supplied query parameters. Endpoint defaults to open orders if no parameters are provided. - [Retrieves a single order specified by the client order ID.](https://docs.alpaca.markets/us/reference/getorderbyclientorderidforaccount.md): Retrieves a single order specified by the client order ID. - [Create an Order for an Account](https://docs.alpaca.markets/us/reference/createorderforaccount.md): Creating an order for your end customer. Each trading request must pass in the account_id in the URL. - Note that when submitting crypto orders, `market`, `limit` and `stop_limit` orders are… - [Cancel all Open Orders For an Account](https://docs.alpaca.markets/us/reference/deleteallordersforaccount.md): Attempts to cancel all open orders. A response will be provided for each order that is attempted to be cancelled. - [Estimate an Order](https://docs.alpaca.markets/us/reference/get-v1-trading-accounts-account_id-orders-estimation.md): Order estimation endpoint will display, based on user's account balance, the estimated quantity and price they will receive for their notional order. For LCT - customer's order will include the… - [Bulk Fetch All Accounts Positions](https://docs.alpaca.markets/us/reference/get-v1-accounts-positions.md): Retrieves a list of the account's open positions. This endpoint is deprecated and will be removed in the future. Please use the [GET /v1/reporting/eod/positions… - [Update Trading Configurations for an Account](https://docs.alpaca.markets/us/reference/patch-patch-v1-trading-accounts-account_id-account-configurations.md): You can also set the margin settings for your users' account by passing a PATCH request. By default any account with funds under $2,000 is set a margin multiplier of 1.0, and accounts with over… - [Retrieve real-time Trading Limits for an Account](https://docs.alpaca.markets/us/reference/get-v1-account-trading-limits.md): This endpoint is only available to accounts with the trading limits feature enabled, and not on JIT. The daily trading limit is set at the correspondent level (or the account level) and is used as… - Portfolio History - [Get Account Portfolio History](https://docs.alpaca.markets/us/reference/get-v1-trading-accounts-account_id-account-portfolio-history.md): Returns timeseries data about equity and profit/loss (P/L) of the account in requested timespan. - Assets - [Retrieve All Assets](https://docs.alpaca.markets/us/reference/getassets.md): Returns all assets - [Retrieve an Asset by ID](https://docs.alpaca.markets/us/reference/getassetbysymbolorid.md): Returns the requested asset, if found - [Retrieve Entry Requirements for requested assets](https://docs.alpaca.markets/us/reference/get-asset-entry-requirements.md): Returns all entry-requirements - [Get Option Contracts (BETA)](https://docs.alpaca.markets/us/reference/get-options-contracts-1.md): This endpoint allows you to retrieve a list of option contracts based on various filtering criteria. By default only active contracts that expire before the upcoming weekend are returned. - [Get an option contract by ID or Symbol (BETA)](https://docs.alpaca.markets/us/reference/get-option-contract-symbol_or_id-1.md): Get an option contract by symbol or contract ID. The symbol or id should be passed in as a path parameter. - [Get US treasuries](https://docs.alpaca.markets/us/reference/ustreasuries-1.md): Serves the list of US treasuries available at Alpaca. The response is sorted by ISIN. - [Get US corporates](https://docs.alpaca.markets/us/reference/uscorporates-1.md): Serves the list of US corporates available at Alpaca. The response is sorted by ISIN. - Calendar - [Get US Market Calendar](https://docs.alpaca.markets/us/reference/legacycalendar-1.md): The calendar API serves the full list of market days from 1970 to 2029. It can also be queried by specifying a start and/or end time to narrow down the results. In addition to the dates, the response… - [Get Market Calendar](https://docs.alpaca.markets/us/reference/calendar-6.md): This endpoint returns the market calendar. - [Get US Market Clock](https://docs.alpaca.markets/us/reference/legacyclock-1.md): The clock API serves the current market timestamp, whether or not the market is currently open, as well as the times of the next market open and close. - [Get Market Clock](https://docs.alpaca.markets/us/reference/clock-2.md): This API serves information about multiple markets: the current time, if it's a market day, the current phase of the market, etc. - Events - [Subscribe to Journal Events (SSE) (Legacy)](https://docs.alpaca.markets/us/reference/subscribetojournalstatussse.md): The Events API provides event push as well as historical queries via SSE (server sent events). You can listen to journal status updates as they get processed by our backoffice. Historical events… - [Subscribe to Journal Events (SSE)](https://docs.alpaca.markets/us/reference/subscribetojournalstatusv2sse.md): The Events API provides event push as well as historical queries via SSE (server sent events). You can listen to journal status updates as they get processed by our backoffice. Historical events… - [Subscribe to Transfer Events (SSE) (Legacy)](https://docs.alpaca.markets/us/reference/subscribetotransferstatussse.md): **Deprecation notice** As part of the deprecation process, the legacy transfer events API is now only available for existing broker-partners at `GET /v1/events/transfers/status` and for… - [Subscribe to Trade Events (SSE)](https://docs.alpaca.markets/us/reference/subscribetotradev2sse.md): The Events API provides event push as well as historical queries via SSE (server sent events). You can listen to events related to trade updates. Most market trades sent during market hours are… - [Subscribe to Admin Action Events (SSE)](https://docs.alpaca.markets/us/reference/subscribetoadminactionsse.md): The Events API provides event push as well as historical queries via SSE (server sent events). This endpoint streams events related to administrative actions performed by our systems. Historical… - [Subscribe to Non-Trading Activities Events (SSE)](https://docs.alpaca.markets/us/reference/get-v1-events-nta.md): The Events API provides event push as well as historical queries via SSE (server sent events). You can listen to non-trading activities updates as they get processed by our backoffice, for both… - [Subscribe to Funding Status Events (SSE)](https://docs.alpaca.markets/us/reference/subscribetofundingstatussse.md): The Events API provides event push as well as historical queries via SSE (server sent events). You can listen to funding status updates as they get processed by our backoffice, for both end-user and… - [Subscribe to System Events (SSE)](https://docs.alpaca.markets/us/reference/subscribetosystemeventv2sse.md): The Events API provides event push as well as historical queries via SSE (server sent events). You can listen to system event updates as they happen in our backend. Historical events are streamed… - [Subscribe to Activity Events (SSE)](https://docs.alpaca.markets/us/reference/subscribetoactivitiessse-1.md): The Events API sends the real-time events and provides historical queries with SSE (Server Sent Events). This endpoint streams events on account activities. Historical events are streamed… - [Subscribe to IPO Events (SSE)](https://docs.alpaca.markets/us/reference/subscribetoipoeventssse.md): The Events API provides event push as well as historical queries via SSE (server sent events). You can listen to IPO offering lifecycle updates as they happen - including new offerings, offering… - [Subscribe to Account Status Events (SSE)](https://docs.alpaca.markets/us/reference/subscribetoaccountstatussse.md): The accounts events API provides streaming of account changes as they occur, via SSE (server sent events). Past events can also be queried. Events are generated for changes to the following account… - Funding - [Retrieve Bank Relationships for an Account](https://docs.alpaca.markets/us/reference/getrecipientbanks.md): Retrieves Bank Relationships for an account - [Create a Bank Relationship for an Account](https://docs.alpaca.markets/us/reference/createrecipientbank.md): If successful, retrieves Bank Relationships for an account - [Delete a Bank Relationship for an Account](https://docs.alpaca.markets/us/reference/deleterecipientbank.md): If successful, deletes Bank Relationship for an account - [Retrieve List of Transfers for an Account.](https://docs.alpaca.markets/us/reference/gettransfersforaccount.md): You can query a list of transfers for an account. You can filter requested transfers by values such as direction and status. Returns a list of transfer entities ordered by created_at - [Request a New Transfer](https://docs.alpaca.markets/us/reference/createtransferforaccount.md): Create a new transfer to deposit money into or withdraw money from an account. Two `transfer_type` values are accepted, and both are available in sandbox and production: - **`ach`** — supports both… - [Request to Close a Transfer](https://docs.alpaca.markets/us/reference/deletetransfer.md): Request to close a transfer - [Retrieve ACH Relationships for an account](https://docs.alpaca.markets/us/reference/getaccountachrelationships.md): Returns a list of ACH Relationships for an account - [Create an ACH Relationship](https://docs.alpaca.markets/us/reference/createachrelationshipforaccount.md): Create a new ACHRelationship for an account If successful, will return 200 code with a newly created ACH Relationship entity. - [Delete an existing ACH relationship](https://docs.alpaca.markets/us/reference/deleteachrelationshipfromaccount.md): Delete an existing ACH relationship for an account - [Retrieve JIT Reports](https://docs.alpaca.markets/us/reference/get-v1-transfers-jit-reports.md): Retrieves a JIT report for the requested report type and system date. By default, the report is returned inline. For large reports, use response_type=download_url to receive a temporary signed… - [Retrieve Daily Trading Limits](https://docs.alpaca.markets/us/reference/get-v1-transfers-jit-limits.md): The JIT Securities daily trading limit is set at the correspondent level and is used as the limit for the total amount due to Alpaca on the date of settlement. The limit in use returns the real time… - [Retrieve JIT Ledgers](https://docs.alpaca.markets/us/reference/get-v1-transfers-jit-ledgers.md): Returns an array of objects that correspond to each ledger account, each of which contains the following attributes. - [Retrieve JIT Ledger Balances](https://docs.alpaca.markets/us/reference/get-v1-transfers-jit-ledger_id-balances.md): Returns an array of objects that correspond to each ledger account. - [List all JIT Settlements](https://docs.alpaca.markets/us/reference/get-v1-jit-settlements.md): Returns all JIT settlements filtered by status if provided. - [Create a new JIT settlement](https://docs.alpaca.markets/us/reference/post-v1-jit-settlements.md): Creates a new JIT settlement, which will trigger the reconciliation process for all included accounts. There is a limit of 150,000 accounts per settlement. If more than 150,000 accounts need to be… - [Get a single JIT settlement](https://docs.alpaca.markets/us/reference/get-v1-jit-settlements-single.md): Returns the JIT settlement specified by the path parameter. - Funding Wallets - [Create sandbox deposit transfer](https://docs.alpaca.markets/us/reference/demodepositfunding.md): Simulates an inbound deposit into an account's funding wallet for end-to-end testing of the deposit flow. The transfer can only credit accounts that belong to your firm. Available in non-production… - [Batch create funding wallets](https://docs.alpaca.markets/us/reference/batchcreatefundingwallets.md): Creates funding wallets for a list of accounts in a single request. Every `account_id` in the request must belong to your firm, and the request is rejected if a funding wallet already exists for any… - [Retrieve funding wallet](https://docs.alpaca.markets/us/reference/getfundingwallet.md): Returns the funding wallet for the specified account. Responds with 404 if the account has not been onboarded to funding wallets or a wallet has not been created. - [Creates a funding wallet](https://docs.alpaca.markets/us/reference/createfundingwallet.md): Creates a funding wallet for the specified account. The request is rejected if the account already has a funding wallet. - [Retrieve funding details](https://docs.alpaca.markets/us/reference/listfundingdetails.md): Returns a list of funding details if it exists. Query parameters must be passed to create a new funding details object if none exist. - [Retrieve funding wallet transfers](https://docs.alpaca.markets/us/reference/getfundingwallettransfers.md): Returns all funding wallet transfers (deposits and withdrawals) associated with the specified account. - [Retrieve funding wallet transfer by ID](https://docs.alpaca.markets/us/reference/getfundingwallettransferbyid.md): Returns a single funding wallet transfer for the specified account by `transfer_id`. Responds with 404 if no matching transfer exists for the account. - [Retrieve recipient bank](https://docs.alpaca.markets/us/reference/getfundingwalletrecipientbank.md): Returns the recipient bank registered against the specified account's funding wallet. Responds with 404 if no recipient bank has been registered for the account. - [Create a recipient bank](https://docs.alpaca.markets/us/reference/createfundingwalletrecipientbank.md): Creates a new recipient bank. Returns the new recipient bank entity on success. entity. - [Delete a recipient bank](https://docs.alpaca.markets/us/reference/deletefundingwalletrecipientbank.md): deletes a recipient bank. - [Create a withdrawal](https://docs.alpaca.markets/us/reference/createfundingwalletwithdrawal.md): Creates a withdrawal - Instant Funding - [Get Instant Funding List](https://docs.alpaca.markets/us/reference/get-v1-instant-funding-list.md): Returns a list of instant funding records based on the query parameters. The results are paginated, sorted, and filtered based on the parameters provided. - [Create an instant funding request](https://docs.alpaca.markets/us/reference/post-v1-instant-funding.md): Creates an instant funding request. The request will be processed and the funds will be made available to the account in the form of a Memopost non trade activity. Upon settlement the Memoposted will… - [Get an instant funding request](https://docs.alpaca.markets/us/reference/get-v1-instant-funding-single.md): Returns an instant funding transfer based on the ID supplied. - [Cancel an instant funding request](https://docs.alpaca.markets/us/reference/delete-v1-instant-funding-single.md): Cancels a single instant funding request based on the ID supplied if possible. - [List settlements](https://docs.alpaca.markets/us/reference/get-v1-instant-funding-settlements.md): Returns all settlements filtered by status if provided. - [Create a new settlement](https://docs.alpaca.markets/us/reference/post-v1-instant-funding-settlements.md): Creates a new settlement, which will trigger the reconciliation process for all included transfers and their interests. There is a limit of 50,000 transfers per settlement. If more than 50,000… - [Get a single settlement](https://docs.alpaca.markets/us/reference/get-v1-instant-funding-settlements-single.md): Returns the settlement specified by the path parameter. - [Get instant funding limits](https://docs.alpaca.markets/us/reference/get-v1-instant-funding-correspondent-limits.md): Returns globally configured limits for the correspondent. These limits are used to determine the maximum amount that can be extended to all accounts, and reaching this limit will result in further… - [Get instant funding account limits](https://docs.alpaca.markets/us/reference/get-v1-instant-funding-account-limits.md): Returns the limits for individual partner accounts. - [Get instant funding report](https://docs.alpaca.markets/us/reference/get-v1-instant-funding-reports.md): Returns instant funding reports which are to be used for daily reconciliation reporting. - OAuth - [Get an OAuth client](https://docs.alpaca.markets/us/reference/getoauthclient.md): The endpoint returns the details of OAuth client to display in the authorization page. - [Issue an OAuth token](https://docs.alpaca.markets/us/reference/issueoauthtoken.md): The operation issues an OAuth code which can be used in the OAuth code flow. - [Authorize an OAuth Token](https://docs.alpaca.markets/us/reference/authorizeoauthtoken.md): The operation issues an OAuth code which can be used in the OAuth code flow. - Journals - [Retrieve a List Journals](https://docs.alpaca.markets/us/reference/getalljournals.md): Returns an array of journal objects. - [Create a Journal](https://docs.alpaca.markets/us/reference/createjournal.md): A journal can be JNLC (move cash) or JNLS (move shares), dictated by `entry_type`. Generally, journal requests are subject to approval and starts from the `pending` status. The status changes are… - [Cancel a Pending Journal](https://docs.alpaca.markets/us/reference/deletejournalbyid.md): You can only delete a journal if the journal is still in a pending state, if a journal is executed you will not be able to delete. The alternative is to create a mirror journal entry to reverse the… - [Retrieve a Single Journal Entry](https://docs.alpaca.markets/us/reference/get-v1-journals-journal_id.md): You can query a specific journal entry that you submitted to Alpaca by passing into the query the journal_id. Will return a journal entry if a journal entry with journal_id exists, otherwise will… - [Create a Batch Journal Transaction (One-to-Many)](https://docs.alpaca.markets/us/reference/createbatchjournal.md): You can create a batch of journal requests by using this endpoint. This is enabled on JNLC type Journals for now only. Every single request must be valid for the entire batch operation to succeed.… - [Create a Reverse Batch Journal Transaction (Many-to-One)](https://docs.alpaca.markets/us/reference/post-v1-journals-reverse_batch.md): You can also create a batch journal request by using the following endpoint. This is enabled on JNLC for now only. Note that if there is an invalid account_id the whole batch operation will be… - Corporate Actions - [Retrieve Announcements](https://docs.alpaca.markets/us/reference/getcorporateannouncements.md): This endpoint is deprecated, please use [the new corporate actions endpoint](https://docs.alpaca.markets/reference/corporateactions-1) instead. - [Retrieve a Specific Announcement](https://docs.alpaca.markets/us/reference/get-get-v1-corporate_actions-announcements-id.md): This endpoint is deprecated, please use [the new corporate actions endpoint](https://docs.alpaca.markets/reference/corporateactions-1) instead. - Watchlist - [Retrieve all Watchlists for an Account](https://docs.alpaca.markets/us/reference/getallwatchlistsforaccount.md): Fetch a list of all watchlists currently in an account. - [Create a New Watchlist for an Account](https://docs.alpaca.markets/us/reference/createwatchlistforaccount.md): Returns the watchlist object - [Manage watchlists](https://docs.alpaca.markets/us/reference/getwatchlistforaccountbyid.md): Retrieve Watchlist by ID - [Update a Watchlist](https://docs.alpaca.markets/us/reference/replacewatchlistforaccountbyid.md): Replace entirely the set of securities contained in the watchlist while optionally renaming it. Destructive operation. - [Remove a Watchlist](https://docs.alpaca.markets/us/reference/deletewatchlistfromaccountbyid.md): Irrevocably delete a watchlist. - [Add an Asset to a Watchlist](https://docs.alpaca.markets/us/reference/post-v1-trading-accounts-account_id-watchlists-watchlist_id.md): Adds an asset to an existing watchlist. - [Remove a Symbol from a Watchlist](https://docs.alpaca.markets/us/reference/delete-delete-v1-trading-accounts-account_id-watchlists-watchlist_id-symbol.md): Delete one entry for an asset by symbol name - KYC - [Upload CIP information](https://docs.alpaca.markets/us/reference/post-v1-accounts-account_id-cip.md): The customer identification program (CIP) API allows you to submit the CIP results received from your KYC provider. The minimum requirements to open an individual financial account are delimited and… - [Retrieve CIP information](https://docs.alpaca.markets/us/reference/get-v1-accounts-account_id-cip.md): You can retrieve the CIP information you've submitted for a given account. - [Retrieve an Onfido SDK Token](https://docs.alpaca.markets/us/reference/get-v1-accounts-account_id-onfido-sdk-tokens.md): Get an SDK token to activate the Onfido SDK flow within your app. You will have to keep track of the SDK token so you can pass it back when you upload the SDK outcome. We recommend storing the token… - [Update the Onfido SDK Outcome](https://docs.alpaca.markets/us/reference/patch-v1-accounts-account_id-onfido-sdk.md): This request allows you to send Alpaca the result of the Onfido SDK flow in your app. A notification of a successful outcome is required for Alpaca to continue the KYC process. - Rebalancing - [List Portfolios](https://docs.alpaca.markets/us/reference/get-v1-rebalancing-portfolios.md): Lists portfolios. When more than one query parameter is passed, only portfolios meeting all provided values will be returned (logical AND between parameter values). - [Create Portfolio](https://docs.alpaca.markets/us/reference/post-v1-rebalancing-portfolios.md): Creates a portfolio allocation containing securities and/or cash. Having no rebalancing conditions is allowed but the rebalance event would need to be triggered manually. Portfolios created with API… - [Get Portfolio by ID](https://docs.alpaca.markets/us/reference/get-v1-rebalancing-portfolios-portfolio_id.md): Get a portfolio by its ID. - [Update Portfolio by ID](https://docs.alpaca.markets/us/reference/patch-v1-rebalancing-portfolios-portfolio_id.md): Updates a portfolio. If weights or conditions are changed, all subscribed accounts will be evaluated for rebalancing at the next opportunity (normal market hours). If a cooldown is active on the… - [Inactivate Portfolio By ID](https://docs.alpaca.markets/us/reference/delete-v1-rebalancing-portfolios-portfolio_id.md): Archives a portfolio (soft delete). Only permitted when the portfolio has no active subscriptions. Archived portfolios are hidden from the default list response and cannot be used for new… - [List All Subscriptions](https://docs.alpaca.markets/us/reference/get-v1-rebalancing-subscriptions.md): Lists subscriptions - [Create Subscription](https://docs.alpaca.markets/us/reference/post-v1-rebalancing-subscriptions.md): Creates a subscription between an account and a portfolio. - [Get Subscription by ID](https://docs.alpaca.markets/us/reference/get-v1-rebalancing-subscriptions-subscription_id.md): Get a subscription by its ID. - [Unsubscribe Account (Delete Subscription)](https://docs.alpaca.markets/us/reference/delete-v1-rebalancing-subscriptions-subscription_id.md): Deletes the subscription which stops the rebalancing of an account. - [List All Runs.](https://docs.alpaca.markets/us/reference/get-v1-rebalancing-runs.md): Lists runs. - [Create Run](https://docs.alpaca.markets/us/reference/post-v1-rebalancing-runs.md): Creates a rebalance run. Omit `weights` or provide an empty array to create a subscription-driven run using the account's active subscription. Provide a non-empty `weights` array to create a manual… - [Get Run by ID](https://docs.alpaca.markets/us/reference/get-v1-rebalancing-runs-run_id.md): Get a run by its ID. - [Cancel Run by ID](https://docs.alpaca.markets/us/reference/delete-v1-rebalancing-runs-run_id.md): Cancels a run. Only runs within certain statuses (QUEUED, CANCELED, SELLS_IN_PROGRESS, BUYS_IN_PROGRESS) are cancelable. If this endpoint is called after orders have been submitted, we'll attempt to… - Logos - [Get Logo](https://docs.alpaca.markets/us/reference/get-v1beta1-logos-symbol.md): Alpaca's Logo API serves uniform logo images for select stock and crypto symbols. Note: For Logo API pricing details, reach out to sales@alpaca.markets The API response will return the raw image as… - Reporting - [Retrieve Aggregate Positions](https://docs.alpaca.markets/us/reference/get-v1-reporting-eod-aggregate_positions.md): This API endpoint provides reporting data to partners for aggregate common stock and crypto positions across their account base. Partners can view historical snapshots of their holding across their… - [Retrieve EOD Positions](https://docs.alpaca.markets/us/reference/get-v1-reporting-eod-positions.md): This API retrieves a comprehensive list of end-of-day positions for all accounts. End-of-day (EOD) positions are typically accessible after 4:00 am Eastern Time (ET) on the following day, providing a… - [Retrieve EOD Cash Interest Details](https://docs.alpaca.markets/us/reference/get-v1-get-eod-cash-interest-report.md): This API retrieves a list of cash interest details for the given date(s) for a single account or all accounts. End-of-day (EOD) details are typically accessible after 8:00pm Eastern Time (ET) and… - Country Info - [Retrieve countries information](https://docs.alpaca.markets/us/reference/querycountryinfos.md): The Country Info API serves country information for every supported countries including risk ratings and supported crypto states where applicable. - Crypto Funding - [Retrieve Crypto Funding Wallets](https://docs.alpaca.markets/us/reference/listcryptofundingwallets-1.md): Lists wallets for the account given in the path parameter. If an asset is specified and no wallet for the account and asset pair exists one will be created. If no asset is specified only existing… - [Retrieve Crypto Funding Transfers](https://docs.alpaca.markets/us/reference/listcryptofundingtransfers-1.md): Returns an array of all transfers associated with the given account across all wallets. - [Request a New Withdrawal](https://docs.alpaca.markets/us/reference/createcryptotransferforaccount-1.md): Creates a withdrawal request. Note that outgoing withdrawals must be sent to a whitelisted address and you must whitelist addresses at least 24 hours in advance. If you attempt to withdraw funds to a… - [Retrieve a Crypto Funding Transfer](https://docs.alpaca.markets/us/reference/getcryptofundingtransfer-1.md): Returns a specific wallet transfer by passing into the query the transfer_id. - [An array of whitelisted addresses](https://docs.alpaca.markets/us/reference/listwhitelistedaddress-1.md): Returns the list of whitelisted withdrawal addresses for the specified account. - [Request a new whitelisted address](https://docs.alpaca.markets/us/reference/createwhitelistedaddress-1.md): Submits a new whitelisted withdrawal address for the specified account. The chain is derived from the supplied asset symbol and address, and the same address cannot be whitelisted twice on the same… - [Delete a whitelisted address](https://docs.alpaca.markets/us/reference/deletewhitelistedaddress-1.md): Deletes a whitelisted withdrawal address from the specified account by ID. Subsequent withdrawals targeting the deleted address will be rejected. - [Returns the estimated gas fee for a proposed transaction.](https://docs.alpaca.markets/us/reference/getcryptotransferestimate-1.md): Returns the estimated on-chain network (gas) fee for a proposed crypto withdrawal at current chain conditions. Pass the `asset`, `from_address`, `to_address`, and `amount` you intend to send; the… - [Update travel rule information for a whitelisted wallet](https://docs.alpaca.markets/us/reference/updatewhitelistedaddresstravelruleinfo.md): You are required to supply travel rule information for the crypto wallets you're withdrawing to. It is preferred that you use the `Search VASPs` endpoint to find the VASP DID for the exchange you… - [Search for VASPs](https://docs.alpaca.markets/us/reference/searchvasps.md): Search for Virtual Asset Service Providers, or crypto exchanges, on Notabene's network. This endpoint can be used to find the VASP DID for your beneficiary's exchange when submitting travel rule… - IRA - [Retrieve Excess Contributions](https://docs.alpaca.markets/us/reference/listiraexcesscontributions.md): Returns all overcontributed IRA accounts - Cash Interest - [List APR Tiers](https://docs.alpaca.markets/us/reference/get-v1-list-apr-tiers.md): List all available APR tiers. These tiers may be assigned to an account, and will be used to determine the interest rate paid on uninvested cash balances. - FPSL Program - [List FPSL Tiers](https://docs.alpaca.markets/us/reference/get-v1-list-fpsl-tiers.md): List all available FPSL tiers. These tiers may be assigned to an account. - [List FPSL Loans](https://docs.alpaca.markets/us/reference/get-v1-list-fpsl-loans.md): Returns a list of all FPSL loans that match the specified filter criteria, ordered in ascending order by `date`, `account_number`, and `symbol`. Each entry represents a loan of a `symbol` on a given… - [Read FPSL Loans Analytics for an Account](https://docs.alpaca.markets/us/reference/get-v1-fpsl-analytics-account-loans.md): Returns aggregated FPSL interest and loan-activity counts for one account over a date range. Use this for "earned so far this month" customer UIs and for supervisory spot-checks against your internal… - Tokenization - [Mint a Tokenized Asset](https://docs.alpaca.markets/us/reference/posttokenizationmintbroker.md): This endpoint is used by an Authorized Participant to request the minting of a tokenized asset. Alpaca will initiate a journal of the underlying asset from the Authorized Participant's account to the… - [Redeem a Tokenized Asset](https://docs.alpaca.markets/us/reference/posttokenizationredeem.md): This endpoint is used by the tokenized asset issuer to confirm the redemption of tokens previously held in the Authorized Participant's wallet. When the issuer invokes this endpoint, Alpaca will… - [List Tokenization Requests](https://docs.alpaca.markets/us/reference/gettokenizationrequestsbroker.md): Retrieve tokenization requests for the account. This endpoint may be used by the tokenized asset issuer or by an Authorized Participant (AP). The list can contain both mint and redeem requests. - [Confirm Tokenized Asset Minted](https://docs.alpaca.markets/us/reference/posttokenizationcallbackmint.md): This endpoint is used by the issuer to confirm the minting of tokenized assets previously requested by the Authorized Participant. - [Get Tokenization Request by ID](https://docs.alpaca.markets/us/reference/gettokenizationrequestbyidbroker.md): Retrieve a single tokenization request by its `tokenization_request_id`. This endpoint may be used by the tokenized asset issuer or by an Authorized Participant (AP), and returns either a mint or a… - [Get Tokenization Request by `client_request_id`](https://docs.alpaca.markets/us/reference/gettokenizationrequestbyclientrequestidbroker.md): Retrieve a single tokenization request by the Authorized Participant's `client_request_id`, the AP-supplied label originally passed on the mint request. Available to Authorized Participants and to… - [Get Tokenization Request by `issuer_request_id`](https://docs.alpaca.markets/us/reference/gettokenizationrequestbyissuerrequestidbroker.md): Retrieve a single tokenization request by the `issuer_request_id`. Returns either a mint or a redeem request. Can be called by issuers only. - ACATS - [List transfers](https://docs.alpaca.markets/us/reference/listacatstransfers.md): List all incoming and outgoing transfers, for all accounts. The list may include transfers not initiated using this API. The list is paginated: use the `page_token` query parameter with the value… - [List transfers for an account](https://docs.alpaca.markets/us/reference/listacatstransfersbyaccount.md): List all incoming and outgoing transfers where the account was one of the parties. The list may include transfers not initiated using this API. By default, the response includes all transfers for the… - [Initiate an incoming transfer](https://docs.alpaca.markets/us/reference/requestacatstransfer.md): This endpoint allows you to create new incoming ACATS requests. We currently support full and partial transfer types, for US equities and cash. Note that after submitting a request, it might take… - [Get transfer details](https://docs.alpaca.markets/us/reference/getacatstransfer.md): Includes the same information returned by the list transfers endpoints, but for just one transfer. - [List assets for a transfer](https://docs.alpaca.markets/us/reference/listacatsassets.md): Assets are only available for partial transfers and for transfers where the deliverer has already responded with the list of assets. The asset list may change as the transfer is updated by the… - [List contra brokers](https://docs.alpaca.markets/us/reference/listacatscontrabrokers.md): This information is provided based on the latest ACATS Participant Master File, and contains the DTCC account numbers of valid contra brokers. Only participants that are either brokers or banks are… - IPO - [List IPO Offerings](https://docs.alpaca.markets/us/reference/listipoofferings.md): Returns a paginated list of IPO offerings currently known to Alpaca. Use this endpoint to power IPO discovery surfaces (e.g. an "Upcoming IPOs" list). Real-time lifecycle changes (availability,… - [Retrieve an IPO Offering](https://docs.alpaca.markets/us/reference/getipooffering.md): Returns a single IPO offering by `offering_reference`. The `offering_reference` value matches the one delivered on the [IPO Events Stream](#operation/subscribeToIPOEventsSSE). ## Changelog - [New endpoint for signing party- and account-level agreements](https://docs.alpaca.markets/us/changelog/2026-10-12-agreements-03db749.md) - [Account, order, and watchlist schema types corrected](https://docs.alpaca.markets/us/changelog/2026-10-09-schema-types-671f3d4.md) - [ACATS status events on the admin-actions SSE stream](https://docs.alpaca.markets/us/changelog/2026-10-09-acats-events-d66bb7b.md) - ["vasps" is now required on the VASP search response](https://docs.alpaca.markets/us/changelog/2026-10-08-vasps-79c9787.md) - [New "group_id" and "group_role" fields on orders](https://docs.alpaca.markets/us/changelog/2026-10-08-order-group-db02af7.md) - ["OptionDeliverable.amount" documented as non-nullable for delayed settlement](https://docs.alpaca.markets/us/changelog/2026-10-07-option-deliverable-amount-c94a723.md) - [Empty "Clock" tag removed from the Broker API reference](https://docs.alpaca.markets/us/changelog/2026-10-05-clock-tag-131d67e.md) - [New "fee_inclusive" field on funding wallet withdrawals](https://docs.alpaca.markets/us/changelog/2026-10-02-fee-inclusive-ac8aef2.md) - [Deprecation notices now rendered in API reference descriptions](https://docs.alpaca.markets/us/changelog/2026-10-01-deprecation-notices-14204e3.md) - [Operation ID and schema name corrections, plus description typos](https://docs.alpaca.markets/us/changelog/2026-09-29-spec-typos-fa635ee.md)