get_lockups
TOOLGet lock-upsscope: dataflow:lockups.read · read-only
Tool description, as exposed to the agent
Returns the share lock-up agreements for one company or one owner. A lock-up is a commitment by a shareholder not to sell certain shares before a stated expiry date — common in the months after an IPO or a share placement. Pass exactly one of company_id (use search_securities) or owner_id (use search_owners). Each row reports the company and owner (both as navigable ids), the lock-up's start and end dates, the shares and capital fraction the owner held at the start of the lock-up (note: this is the at-start amount, not necessarily still-locked today), the monetary value, and whether the lock-up is still active. Expired lock-ups are excluded unless include_expired=true. Rows are ordered by soonest expiry first. Successful calls may consume Dataflow credits.Parameters
| Parameter | Type | Description | |
|---|---|---|---|
| company_id | integer | optional | Company whose lock-up agreements to return, from search_securities. Mutually exclusive with owner_id. Nonzero integer; the sign of the ID has NO meaning. Pass it through verbatim. |
| owner_id | integer | optional | Owner whose lock-up agreements to return (across the companies they hold locked shares in), from search_owners. Mutually exclusive with company_id. Nonzero integer; the sign of the ID has NO meaning. Pass it through verbatim. |
| include_expired | boolean | optional | When true, includes lock-ups whose end_date is in the past. Default false — return only lock-ups that have not yet expired.default false |
Billing
Pricing key: lockups.snapshot. Successful calls consume Dataflow credits per your contract. See Credits & pricing.