/short/aggregate
GET/short/aggregateapplication/json · application/xml · text/csv
Requires your access key in the X-Dataflow-Key header (or key query parameter). Which parameters and response fields are available to you depends on your contract; your personal OpenAPI spec from /resources/open-api shows your exact surface.
curl -H "X-Dataflow-Key: $DATAFLOW_KEY" \
"https://dataflow.modularfinance.com/api/short/aggregate"Query parameters
| Parameter | Type | Description |
|---|---|---|
| countries | string[] | Filter to companies listed in these countries (ISO 3166-1 alpha-2, e.g. 'SE'). |
| date | string | Snapshot date (YYYY-MM-DD). Defaults to the most recent data. |
Response
An array of ShortShortAggregate rows, streamed for JSON and CSV.
| Field | Type | Description |
|---|---|---|
| anonymous_capital | number | Undisclosed (below-threshold) short interest as a percentage of capital. |
| anonymous_shares | integer | Shares sold short in undisclosed positions. |
| company_id | integer | Modular Finance company identifier. |
| company_name | string | Company name. |
| date | string | Date of this snapshot (YYYY-MM-DD). |
| isin | string | ISIN of the share class. |
| lei | string | Legal Entity Identifier (LEI) of the company. |
| public_capital | number | Publicly disclosed short interest as a percentage of capital. |
| public_shares | integer | Shares sold short in publicly disclosed positions. |
| stock_id | integer | Modular Finance stock (share class) identifier. |
| stock_name | string | Share class name. |
| total_capital | number | Total short interest (public plus anonymous) as a percentage of capital. |
| total_shares | integer | Total shares sold short (public plus anonymous). |