# IPO Documents

> Returns the document catalog for a single IPO (prospectus, SEC filings, multi-language prospectus summaries).

`GET https://api.bavest.co/v2/ipo/documents`

Group: IPO. Route id: `v2_ipo_documents`. Included in: Growth.

## Description

Returns the document catalog for a single IPO (prospectus, SEC filings,
multi-language prospectus summaries). The optional `language` parameter
filters documents to the requested language (only that language is
returned); the optional `type` parameter filters to a single document
type. Supports offset and cursor pagination.

## Authentication

Send your API key in the `x-api-key` header on every request. No key yet? Sign up at https://dashboard.bavest.co/sign-up (free trial). The examples read the key from the `BAVEST_API_KEY` environment variable.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `symbol` | query | string | no | IPO ticker symbol (e.g., `SPCX` for SpaceX). Symbol only — ISIN is not supported for IPO endpoints. Example `SPCX`. |
| `language` | query | string | no | Filter documents to this language (ISO 639-1 / BCP-47). Only documents in the requested language are returned; omit for the full multi-language catalog. Example when explicitly filtering: `de`. |
| `type` | query | string | no | Filter to a single document type (e.g. `prospectus`, `sec_s1`, `prospectus_summary`). Example when explicitly filtering: `prospectus_summary`. |
| `limit` | query | integer (int32) | no | Maximum number of results to return (default 100, max 1000) Default `100`. |
| `offset` | query | integer (int32) | no | Number of results to skip for pagination (default 0) Default `0`. |
| `cursor` | query | string | no | Opaque cursor for cursor-based pagination. When provided, returns results after the cursor position. Takes precedence over offset. |

## Response

200 Successful response (`application/json`).

| Field | Type | Always present | Description |
|---|---|---|---|
| `data` | array of IPODocument | no |  |
| `data[].docType` | string | no | Document type key (e.g. `prospectus`, `sec_s1`, `prospectus_summary`) Example: `sec_s1`. |
| `data[].label` | string \| null | no | Localized document label. Example: `SEC S-1`. |
| `data[].language` | string \| null | no | Document language (ISO 639-1 / BCP-47) Example: `en`. |
| `data[].format` | string \| null | no | Document format. One of `pdf`, `html`. Example: `html`. |
| `data[].isPrimary` | boolean \| null | no | Whether this is the canonical language for its docType (used as fallback) Example: `true`. |
| `data[].url` | string \| null | no | Document URL, or null when not yet published. Example: `https://www.sec.gov/Archives/edgar/data/1181412/000162828026036936/spaceexplorationtechnologi.htm`. |
| `meta` | ResponseMeta | no | Response metadata for paginated endpoints. Offset pagination returns `page`/`pageSize`/`totalPages`/`totalCount`; cursor pagination returns `pageSize`/`hasMore`/`nextCursor` and `totalCount` only when known. |
| `meta.time` | integer | no | Server-side processing time in milliseconds. Example: `17`. |
| `meta.parameters` | object | no | Echo of the request parameters the endpoint resolved. |
| `meta.page` | integer | no | Current page number (offset pagination) Example: `1`. |
| `meta.pageSize` | integer | no | Number of results per page. Example: `50`. |
| `meta.totalPages` | integer | no | Total number of pages (offset pagination) Example: `2`. |
| `meta.totalCount` | integer | no | Total number of results across all pages. Example: `100`. |
| `meta.hasMore` | boolean | no | Whether more results follow (cursor pagination) |
| `meta.nextCursor` | string \| null | no | Cursor for the next page (cursor pagination), null on the last page. |

## Example request

```bash
curl 'https://api.bavest.co/v2/ipo/documents?symbol=SPCX' \
  -H "x-api-key: $BAVEST_API_KEY"
```

## Example response

```json
{
  "data": [
    {
      "docType": "prospectus",
      "label": "Prospectus",
      "language": "en",
      "format": "pdf",
      "isPrimary": true,
      "url": null
    },
    {
      "docType": "prospectus_summary",
      "label": "Prospectus Summary",
      "language": "en",
      "format": "pdf",
      "isPrimary": true,
      "url": null
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 8,
    "parameters": {
      "limit": "100",
      "symbol": "SPCX"
    },
    "time": 2349
  }
}
```

## Errors

| Status | Meaning |
|---|---|
| 400 | Invalid request parameters. Returned when required query parameters are missing, have invalid types, or violate constraints (e.g., providing both symbol and isin when they are mutually exclusive). |
| 401 | Missing or invalid API key. |
| 404 | Resource not found. |
| 429 | Rate limit exceeded. Retry after the `Retry-After` header interval. |
| 500 | An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value. |
| 502 | Upstream data provider returned an error or is temporarily unavailable. Retry after a short delay. |
| 504 | The request timed out waiting for a response from the upstream data provider. This may occur for complex queries or during peak load. |
| default | An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value. |

- `403` from the gateway: the API key is invalid or switched off.
- `429` with message `Limit Exceeded`: the monthly quota of the key is used up. With `Too Many Requests`: the key is throttled, or this route is not in the key's plan. Wait for `Retry-After` when it is sent.

## Links

- HTML page: https://dashboard.bavest.co/docs/v2_ipo_documents
- OpenAPI: https://dashboard.bavest.co/openapi.json (YAML: https://dashboard.bavest.co/openapi.yaml)
- Authentication: https://dashboard.bavest.co/docs/authentication.md
- MCP server for AI agents: https://dashboard.bavest.co/docs/mcp.md
- All routes: https://dashboard.bavest.co/llms.txt
