Reporting #
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 entire account base. Please note that this API utilizes an 8:00 pm (EST) cutoff which aligns with the end of the Securities extended hours trading session as well as Alpaca’s 24 hour Crypto trading window. Additionally, the endpoint supports indexing to help the partner efficiently filter by key information including date and symbol while being able to include or remove firm accounts.
Retrieving Aggregate Positions #
GET /v1/reporting/eod/aggregate_positions
Retrieves end of day aggregated positions indexed by trade date and asset
Request #
Parameters
Attributes #
Attribute | Type | Requirement | Notes |
---|---|---|---|
date | string/timestamp | Required |
“YYYY-MM-DD” format |
symbols | string (comma-separated) | Optional |
If populated, then only the specified symbols will be returned. If null, then all symbols will be included in the response. |
firm_accounts | boolean | Optional |
Defaults to True which includes firm accounts. Passing False will exclude all firm accounts. |
Response #
Array of objects, each object pertains to the date specified in the request and a unique asset. See parameters below. Notes: Returns an empty array for non-trading days, assets with no positions are omitted.
Attributes
Attribute | Type | Notes |
---|---|---|
symbol | string | Symbol of asset |
cusip | string/number | Cusip (9 digits, can start with 0’s) |
long_qty | string/number | Aggregate number of shares that the partner is long |
short_qty | string/number | Aggregate number of shares that the partner is short |
long_market_value | string/number | Aggregate notional dollar amount of the partner’s long positions |
short_market_value | string/number | Aggregate notional dollar amount of the partner’s short positions |
num_accounts | string/number | Number of accounts that have a position in this asset (either long or short) |
asset_type | string | us_equity or crypto |
closing_price | string/number | EOD asset price per share at session close |
Sample Response
[
{
"symbol": "AAPL",
"cusip": "037833100",
"long_qty": "1",
"short_qty": "0",
"long_market_value": "148.4700",
"short_market_value": "0",
"num_accounts": "1",
"asset_type": "us_equity",
"closing_price": "148.4700"
},
{
"symbol": "ETHUSD",
"cusip": "ETH123456",
"long_qty": "673.483",
"short_qty": "0",
"long_market_value": "820706.38380",
"short_market_value": "0",
"num_accounts": "1",
"asset_type": "crypto",
"closing_price": "1218.60"
}
]