Skip to main content
The health endpoints give you a quick way to verify that the API is online and to inspect the current size of the indexed dataset. Both GET / and GET /health return the same HealthResponse object, so you can use either path as a liveness probe in your monitoring stack.

Endpoints

Base URL: https://mkk-roan.vercel.app/api

GET /health

Returns a HealthResponse confirming the service is running along with aggregate counts for each major collection in the database.
GET / and GET /health are identical. Use whichever path is more convenient for your health check setup.

Response schema

string
required
Always "ok" when the service is healthy.
integer
required
Total number of parsed fund disclosure documents in the database.
integer
required
Total number of distinct funds tracked across all documents.
integer
required
Total number of canonical sections defined in the schema.
integer
required
Total number of canonical line item definitions.
integer
required
Total number of extracted line item values across all documents.
integer
required
Total number of normalized portfolio entries across all documents.
integer
required
Total number of raw portfolio table rows extracted from documents.

Example request

Example response

200

GET /openapi.json

Returns the full OpenAPI specification document describing every endpoint in the MKK Structured Data API.
You can import the OpenAPI document into tools like Postman, Insomnia, or any OpenAPI-compatible client to explore and test the API interactively.

Example request