Account Activities #

The account activities API provides access to a historical record of transaction activities that have impacted any accounts you’ve created. Trade execution activities and non-trade activities, such as dividend payments, are both reported through this endpoint.

The Trade Activity Object #

Sample Object #

{
  "id": "20210510100104650::88b5f678-fef5-447b-af15-f21e367e6d8c",
  "account_id": "c8f1ef5d-edc0-4f23-9ee4-378f19cb92a4",
  "activity_type": "FILL",
  "transaction_time": "2021-05-10T14:01:04.650275Z",
  "type": "fill",
  "price": "128.33",
  "qty": "0.38962051",
  "side": "buy",
  "symbol": "AAPL",
  "leaves_qty": "0",
  "order_id": "fe060a1b-5b45-4eba-ba46-c3a3345d8255",
  "cum_qty": "0.38962051",
  "order_status": "filled"
}

Attributes #

Attribute	Type	Notes
`id`	string/UUID	The activity ID
`account_id`	string/UUID	The account ID attributed to this activity. Could be a user’s `account_id` or your firm `account_id`
`activity_type`	ENUM.ActivityType	For trade activities it is always `FILL`
`transaction_time`	string/timestamp	The time and date of when this trade was processed
`type`	string	`fill` or `partial_fill`
`price`	string/number	The per-share price that the trade was executed at.
`qty`	string/number	The number of shares involved in the trade execution.
`side`	string	Can be either `buy` or `sell`
`symbol`	string	The symbol of the asset
`leaves_qty`	string/number	For `partially_filled` orders, the quantity of shares that are left to be filled.
`order_id`	string/UUID	The ID for the order filled
`cum_qty`	string/number	The cumulative quantity of shares involved in the execution.
`order_status`	string	The status of the order

The Non Trade Activity (NTA) Object #

Sample Object #

{
  "id": "20210512000000000::46b11ac3-baa2-4c36-bd5d-f917ab52d3e7",
  "account_id": "62c925a3-e72e-4153-919d-6a71c407423b",
  "activity_type": "CSD",
  "date": "2021-05-12",
  "net_amount": "1234",
  "description": "",
  "status": "executed"
}

Attributes #

Attribute	Type	Notes
`id`	string/UUID	The activity ID
`account_id`	string/UUID	The account ID attributed to this activity. Could be a user’s `account_id` or your firm `account_id`
`activity_type`	ENUM.ActivityType	The type of the activity
`date`	string/date	The date on which the activity occurred or on which the transaction associated with the activity settled.
`net_amount`	string/number	The net amount of money (positive or negative) associated with the activity.
`description`	string
`status`	ENUM.ActivityStatus
`symbol`	string	The symbol of the security involved with the activity. Not present for all activity types.
`qty`	string/number	For dividend activities, the number of shares that contributed to the payment. Not present for other activity types.
`per_share_amount`	string/number	For dividend activities, the average amount paid per share. Not present for other activity types.
`execution_id`	string/UUID	The execution ID attributed to the execution of the corresponding activity. This field is typically for FEE entry types and is optional

ENUMS #

ENUM.AccountActivity #

Activity Status	Description
`executed`	Activity has been executed.
`correct`	Activity has been executed, but required manual input from Alpaca. This is as valid as `executed`
`canceled`	Activity recorded but canceled.

Enum.ActivityType #

Activity Type	Description
`FILL`	Order Fills (Partial/Full)
`ACATC`	ACATS IN/OUT (Cash)
`ACATS`	ACATS IN/OUT (Securities)
`CIL`	Cash in Lieu of Stock
`CSD`	Cash Disbursement (+)
`CSW`	Cash Withdrawable
`DIV`	Dividend
`DIVCGL`	Dividend (Capital Gain Long Term)
`DIVCGS`	Dividend (Capital Gain Short Term)
`DIVNRA`	Dividend Adjusted (NRA Withheld)
`DIVROC`	Dividend Return of Capital
`DIVTXEX`	Dividend (Tax Exempt)
`FEE`	REG and TAF Fees
`INT`	Interest (Credit/Margin)
`JNLC`	Journal Entry (Cash)
`JNLS`	Journal Entry (Stock)
`MA`	Merger/Acquisition
`PTC`	Pass Thru Change
`REORG`	Reorg CA
`SPIN`	Stock Spinoff
`SPLIT`	Stock Split

Retrieving Account Activities #

GET /v1/accounts/activities

Request #

Parameters #

Attribute	Type	Requirement	Notes
`date`	date	Optional	Both formats `YYYY-MM-DD` and `YYYY-MM-DDTHH:MM:SSZ` supported.
`until`	date	Optional	Both formats `YYYY-MM-DD` and `YYYY-MM-DDTHH:MM:SSZ` supported. Cannot be used with date.
`after`	date	Optional	Both formats `YYYY-MM-DD` and `YYYY-MM-DDTHH:MM:SSZ` supported. Cannot be used with date.
`direction`	string	Optional	Defaults to `desc`
`account_id`	string/UUID	Optional
`page_size`	int	Optional	The maximum number of entries to return in the response
`page_token`	string	Optional	The ID of the end of your current page of results

Notes:

Pagination is handled using the page_token and page_size parameters.
page_token represents the ID of the end of your current page of results.
If specified with a direction of desc, for example, the results will end before the activity with the specified ID.
If specified with a direction of asc, results will begin with the activity immediately after the one specified.
page_size is the maximum number of entries to return in the response.
If date is not specified, the default and maximum value is 100.
If date is specified, the default behavior is to return all results, and there is no maximum page size.
If the timezone is not specified for any of the date types, it defaults to UTC+00:00

Response #

Returns an array of activities.

Retrieving Account Activities by Type #

GET /v1/accounts/activities/{activity_type}

Request #

Parameters #

Attribute	Type	Requirement	Notes
`date`	date	Optional	Both formats `YYYY-MM-DD` and `YYYY-MM-DDTHH:MM:SSZ` supported.
`until`	date	Optional	Both formats `YYYY-MM-DD` and `YYYY-MM-DDTHH:MM:SSZ` supported. Cannot be used with date.
`after`	date	Optional	Both formats `YYYY-MM-DD` and `YYYY-MM-DDTHH:MM:SSZ` supported. Cannot be used with date.
`direction`	string	Optional	Defaults to `desc`
`account_id`	string/UUID	Optional
`page_size`	int	Optional	The maximum number of entries to return in the response
`page_token`	int	Optional	The ID of the end of your current page of results

Response #

Returns an array of activities.

Disclosures

Brokerage services are provided by Alpaca Securities, member FINRA/SIPC, a wholly-owned subsidiary of AlpacaDB, Inc.

Technology and services are offered by AlpacaDB, Inc.

Brokerage services are provided to customers who can write automated investment code and self-direct their own investments. Alpaca brokerage services are only provided to customers who agree to electronically sign agreements and agree to receive messages, confirmations, and statements electronically. Is Alpaca right for me?

This is not an offer, solicitation of an offer, or advice to buy or sell securities or cryptocurrencies, or open a brokerage account or cryptocurrency account in any jurisdiction where Alpaca Securities or Alpaca Crypto respectively, are not registered or licensed, as applicable.

The Paper Trading API is offered by AlpacaDB, Inc. and does not require real money or permit a user to transact in real securities in the market. Providing use of the Paper Trading API is not an offer or solicitation to buy or sell securities, securities derivative or futures products of any kind, or any type of trading or investment advice, recommendation or strategy, given or in any manner endorsed by AlpacaDB, Inc. or any AlpacaDB, Inc. affiliate and the information made available through the Paper Trading API is not an offer or solicitation of any kind in any jurisdiction where AlpacaDB, Inc. or any AlpacaDB, Inc. affiliate (collectively, "Alpaca") is not authorized to do business.

You should know that the use or granting of any third party access to your account information or place transactions in your account at your direction is solely at your risk. Alpaca does not warrant against loss of use or any direct, indirect or consequential damages or losses to you caused by your assent, expressed or implied, to a third party accessing your account or information, including access provided through any other third party apps, systems, or sites.

Market prices, data and other information available through Alpaca are not warranted as to completeness or accuracy and are subject to change without notice. System response and account access times may vary due to a variety of factors, including trading volumes, market conditions, system performance, and other factors. A more complete description of the impact these factors may have can be found in our risks of automated trading systems section.

All investments involve risk and the past performance of a security, or financial product does not guarantee future results or returns. Keep in mind that while diversification may help spread risk it does not assure a profit, or protect against loss, in a down market. There is always the potential of losing money when you invest in securities, or other financial products. Investors should consider their investment objectives and risks carefully before investing.

There are risks unique to automated trading algorithms that you should know about and plan for. You should setup a method or system of continuous monitoring or alerting to let you know if there is a mechanical failure, such as connectivity issues, power loss, a computer crash, or system quirk. You should also monitor for instances where your automated trading system experiences anomalies that could result in errant, missing, or duplicated orders. A more complete description of these and other risks can be found in our FAQ section.

Conditional orders may have increased risk as a result of their reliance on trigger processing, market data, and other internal and external systems. Such orders are not sent to the market until specified conditions are met. During that time, issues such as system outages with downstream technologies or third parties may occur. Conditional orders triggering near the market close may fail to execute that day. Furthermore, our executing partner may impose controls on conditional orders to limit erroneous trades triggering downstream orders. Alpaca Securities may not always be made aware of such changes to external controls immediately, which may lead to some conditional orders not being executed. As such, it is important to monitor conditional orders for reasonability. Conditional orders are “Not Held” orders whose execution instructions are on a best efforts basis upon being triggered. Furthermore, conditional orders may be subject to the increased risks of stop orders and market orders outlined above. Given the increased potential risk of using conditional orders, the client agrees that Alpaca Securities cannot be held responsible for losses, damages, or missed opportunity costs associated with market data problems, systems issues, and user error, among other factors. By using conditional orders the client understands and accepts the risks outlined above. Alpaca Securities encourages leveraging the use of Paper accounts to become more comfortable with the intricacies associated with these orders.

ETFs can entail risks similar to direct stock ownership, including market, sector, or industry risks. Some ETFs may involve international risk, currency risk, commodity risk, and interest rate risk. Trading prices may not reflect the net asset value of the underlying securities.

All accounts are opened as limited purpose margin accounts. You should know that margin trading involves interest charges and risks, including the potential to lose more than deposited or the need to deposit additional collateral in a falling market. Before using margin, customers must determine whether this type of trading strategy is right for them given their specific investment objectives, experience, risk tolerance, and financial situation. For more information please see Alpaca's Margin Disclosure Statement and Margin Agreement. These disclosures contain information on Alpaca Securities's lending policies, interest charges, and the risks associated with margin accounts.

Commission-Free trading means that there are no commission charges for Alpaca Securities self-directed individual brokerage accounts that trade U.S. listed securities through an API. Relevant regulatory fees may apply.

Commission free trading is available for Alpaca's retail customers. Alpaca reserves the right to charge additional fees if it is determined that orders flow is non-retail in nature.

Cryptocurrency is highly speculative in nature, involves a high degree of risks, such as volatile market price swings, market manipulation, flash crashes, and cybersecurity risks. Cryptocurrency is not regulated or is lightly regulated in most countries. Cryptocurrency trading can lead to large, immediate and permanent loss of financial value. You should have appropriate knowledge and experience before engaging in cryptocurrency trading. For additional information please click here.

Cryptocurrency services are made available by Alpaca Crypto, a FinCEN registered money services business (NMLS # 2160858), and a wholly-owned subsidiary of AlpacaDB, Inc. Alpaca Crypto is not a member of SIPC or FINRA. Cryptocurrencies are not stocks and your cryptocurrency investments are not protected by either FDIC or SIPC. Please see the Disclosure Library for more information.