IPO

IPO Documents

GET/v2/ipo/documents

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.

Included in: Growth.

Authentication

Send your API key in the x-api-key header on every request to https://api.bavest.co. The samples read it from the BAVEST_API_KEY environment variable. Get an API key · Authentication guide

Parameters

NameInTypeRequiredDescription
symbolquerystringno

IPO ticker symbol (e.g., SPCX for SpaceX). Symbol only — ISIN is not supported for IPO endpoints.

Example SPCX

languagequerystringno

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.

typequerystringno

Filter to a single document type (e.g. prospectus, sec_s1, prospectus_summary). Example when explicitly filtering: prospectus_summary.

limitqueryinteger (int32)no

Maximum number of results to return (default 100, max 1000)

Default 100

offsetqueryinteger (int32)no

Number of results to skip for pagination (default 0)

Default 0

cursorquerystringno

Opaque cursor for cursor-based pagination. When provided, returns results after the cursor position. Takes precedence over offset.

Try it

IPO ticker symbol (e.g., `SPCX` for SpaceX). Symbol only — ISIN is not supported for IPO endpoints.

GET /v2/ipo/documents?symbol=SPCX

Sent only to api.bavest.co for this request; not stored.

Sign in to sendGet an API keySends with the key above, or sign in to use your account's key. Each request counts as one API call.

Response 200

Successful response · application/json

  • dataarray of IPODocument
    • docTypestring

      Document type key (e.g. prospectus, sec_s1, prospectus_summary)

      Example sec_s1

    • labelstring | null

      Localized document label

      Example SEC S-1

    • languagestring | null

      Document language (ISO 639-1 / BCP-47)

      Example en

    • formatstring | null

      Document format

      One of pdf html

      Example html

    • isPrimaryboolean | null

      Whether this is the canonical language for its docType (used as fallback)

      Example true

    • urlstring | null

      Document URL, or null when not yet published

      Example https://www.sec.gov/Archives/edgar/data/1181412/000162828026036936/spaceexplorationtechnologi.htm

  • metaResponseMeta

    Response metadata for paginated endpoints. Offset pagination returns page/pageSize/totalPages/totalCount; cursor pagination returns pageSize/hasMore/nextCursor and totalCount only when known.

    • timeinteger

      Server-side processing time in milliseconds

      Example 17

    • parametersobject

      Echo of the request parameters the endpoint resolved

    • pageinteger

      Current page number (offset pagination)

      Example 1

    • pageSizeinteger

      Number of results per page

      Example 50

    • totalPagesinteger

      Total number of pages (offset pagination)

      Example 2

    • totalCountinteger

      Total number of results across all pages

      Example 100

    • hasMoreboolean

      Whether more results follow (cursor pagination)

    • nextCursorstring | null

      Cursor for the next page (cursor pagination), null on the last page

Errors

  • 400Invalid 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).
  • 401Missing or invalid API key.
  • 404Resource not found.
  • 429Rate limit exceeded. Retry after the `Retry-After` header interval.
  • 500An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
  • 502Upstream data provider returned an error or is temporarily unavailable. Retry after a short delay.
  • 504The request timed out waiting for a response from the upstream data provider. This may occur for complex queries or during peak load.
  • defaultAn unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.

For AI agents: this page as Markdown at /docs/v2_ipo_documents.md, every route in /llms.txt, the OpenAPI spec at /openapi.json.