v36

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2024-11-1856109168.6 KB

Retrieve Institutional Holdings

Returns the holdings for a given institution.

get/api/institution/{name}/holdings

Path parameters

namestring required
Example:VANGUARD GROUP INC

A large entity that manages funds and investments for others. Queryable by name or CIK.

Query parameters

datestring date
Example:2024-01-18T00:00:00.000Z

A trading date in the format of YYYY-MM-DD. Defaults to the last trading date if not provided.

limitinteger
Example:10

How many items to return. Default 500. Max 500. Min 1.

order'date' | 'ticker' | 'security_type' | 'put_call' | 'first_buy' | 'price_first_buy' | 'units' | 'units_change' | 'historical_units' | 'value' | 'avg_price' | 'close' | 'shares_outstanding'
Example:ticker

Optional columns to order the result by.

order_direction'desc' | 'asc'
Example:asc

Whether to sort descending or ascending. Default is descending.

pageinteger
Example:1

Page number (use with limit). Starts on page 0.

security_typesstring[]

An array of security types.

[
  "Share"
]

Response

Successful response with institutional holdings data.

Example response

{
  "data": [
    {
      "avg_price": "156.53",
      "close": "419.23",
      "date": "2024-10-02",
      "first_buy": "2012-02-23",
      "full_name": "MICROSOFT CORP",
      "historical_units": [
        4103,
        4423
      ],
      "price_first_buy": "23.42",
      "put_call": "put",
      "sector": "Technology",
      "security_type": "Share",
      "shares_outstanding": "71984388.0",
      "ticker": "MSFT",
      "units": 4103,
      "units_change": -320,
      "value": 1672230
    }
  ]
}