get_short_interest
TOOLGet short interestscope: dataflow:short.read · read-only
Tool description, as exposed to the agent
Returns the short interest of a publicly listed company on a given date — that is, how heavily the stock is being sold short. The response breaks short interest into three sections: total (all short positions), public (positions large enough to require regulatory disclosure, with named short-sellers), and anonymous (the remainder, where short-sellers are not publicly named). Each section reports the number of shares short, the fraction of total share capital (with and without a free-float adjustment), days-to-cover (dtc — shares short divided by average daily volume), and the USD value of the short. The public section also reports the count of disclosed positions. Use search_securities first to obtain the company_id. The 'at' parameter selects the date (default today; max 2 years in the past). Pair with list_public_short_positions to see who the named short-sellers are. Successful calls may consume Dataflow credits.Parameters
| Parameter | Type | Description | |
|---|---|---|---|
| company_id | integer | required | The Modular Finance internal company_id from search_securities. Nonzero integer; the sign of the ID has NO meaning; negative IDs are normal and are NOT a flag for 'unlisted', 'private', or anything else. Pass it through verbatim. |
| at | string | optional | Optional snapshot date in YYYY-MM-DD. Defaults to today UTC. Maximum 2 years in the past. |
Billing
Pricing key: short.interest. Successful calls consume Dataflow credits per your contract. See Credits & pricing.