Sign in

v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Reporting

Retrieve Aggregate Positions

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.

get/v1/reporting/eod/aggregate_positions

Query parameters

datestring date required

"YYYY-MM-DD" format

symbolsstring

Comma-separated symbols. If populated, then only the specified symbols will be returned. If null, then all symbols will be included in the response.

firm_accountsstring

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.

asset_type'us_equity' | 'us_option' | 'crypto' | 'ipo'

This represents the category to which the asset belongs to. It serves to identify the nature of the financial instrument, with options including "us_equity" for U.S. equities, "us_option" for U.S. options, "crypto" for cryptocurrencies, and "ipo" for IPO indications of interest. This asset_class: ipo value is distinct from the assets API attributes: ["ipo"] flag.

closing_pricestring decimal

EOD asset price per share at session close

cusipstring decimal

Cusip (9 digits, can start with 0's)

long_market_valuestring decimal

Aggregate notional dollar amount of the partner's long positions

long_qtystring decimal

Aggregate number of shares that the partner is long

num_accountsinteger

Number of accounts that have a position in this asset (either long or short)

short_market_valuestring decimal

Aggregate notional dollar amount of the partner's short positions

short_qtystring decimal

Aggregate number of shares that the partner is short

symbolstring

Symbol of asset