Get Chart
get_chartRead-onlyIdempotent
Build an aggregated IPO chart and return its data plus canonical embed, page, and API URLs. Use this instead of hand-building chart URLs. Anonymous requests are quota-limited and may clamp a 52-week range to 26 weeks or a daily bucket to weekly unless the explicit date window is at most 31 days.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group | No | Dimension used to split chart series. Defaults to sector for proceeds/returns and form_family for filing counts. | |
| range | No | Trailing window when explicit dates are omitted. Defaults to 26w; anonymous 52w requests are clamped to 26w. | |
| scope | No | Include all matching records or only active offerings. Defaults to active. | |
| bucket | No | Time interval. Defaults to week; anonymous daily requests require an explicit window of at most 31 days or are clamped to week. | |
| issuer | No | Include every issuer or exclude SPACs. Defaults to all. | |
| metric | No | Value to aggregate. Defaults to gross_proceeds. | |
| date_to | No | Inclusive YYYY-MM-DD upper bound. Use with date_from for a custom window instead of range. | |
| date_from | No | Inclusive YYYY-MM-DD lower bound. Use with date_to for a custom window instead of range. | |
| materiality | No | Include all filing forms or only major IPO forms. Defaults to all. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| links | Yes |