Equities

Equities Metrics History Export Status

GET/v2/equities/exports/{exportId}

Poll a submitted export job. 'ready' returns presigned download links for each Parquet part plus the manifest; 'pending' is still materialising; 'failed' includes an error. Scoped to the caller's API key.

Included in: Startup, Pro, 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
exportIdpathstringyes

The exportId returned by the submit call.

Try it

The exportId returned by the submit call.

Fill in exportId.

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

Export status · application/json

  • dataobject
    • exportIdstring
    • statusstring

      One of ready pending failed

    • rowsinteger
    • requestedinteger

      Count of explicitly-requested securities (absent for full-universe exports).

    • returnedinteger

      Requested securities that returned >=1 row.

    • missingarray of object

      Requested securities that returned no rows.

    • schemaarray of string
    • expiresInSecondsinteger

      Example 3600

    • manifestUrlstring
    • partsarray of object
    • errorstring

      Present only when status=failed

  • metaResponseMeta

    Response envelope metadata. Always present on a 200: time is set by core/response.py on every successful response. Errors carry the same block, built by the same code, so a client parses one meta shape whether the call succeeded or failed.

    • timeinteger

      Server-side processing time in milliseconds

      Example 17

    • parametersobject

      Echo of the request parameters the endpoint resolved

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.

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