Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: Metric Duck Health API
description: 'SEC filing data API: equity fundamentals updated daily from SEC EDGAR'
version: 2.0.0
tags:
- name: Health
paths:
/health:
get:
tags:
- Health
summary: Health Check
description: Basic health check endpoint (supports GET and HEAD)
operationId: health_check_health_head
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
head:
tags:
- Health
summary: Health Check
description: Basic health check endpoint (supports GET and HEAD)
operationId: headHealth
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
x-operation-id-source: normalized
x-operation-id-original: health_check_health_head
/health/live:
get:
tags:
- Health
summary: Liveness Probe
description: 'True liveness probe endpoint (supports GET and HEAD).
Always returns 200 if the process is alive. This is the correct semantics
for a liveness probe - it should only fail if the process is deadlocked
or otherwise unresponsive, not during initialization.
Use /health/startup for startup probe (waits for init to complete).'
operationId: liveness_probe_health_live_head
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
head:
tags:
- Health
summary: Liveness Probe
description: 'True liveness probe endpoint (supports GET and HEAD).
Always returns 200 if the process is alive. This is the correct semantics
for a liveness probe - it should only fail if the process is deadlocked
or otherwise unresponsive, not during initialization.
Use /health/startup for startup probe (waits for init to complete).'
operationId: headHealthLive
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
x-operation-id-source: normalized
x-operation-id-original: liveness_probe_health_live_head
/health/startup:
get:
tags:
- Health
summary: Startup Probe
description: 'Startup probe endpoint - returns 200 when lifespan completed, 503 otherwise.
This endpoint is used by Cloud Run''s startupProbe to determine when the
container is ready to receive traffic. It waits until the app has completed
initialization before returning 200.'
operationId: startup_probe_health_startup_head
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
head:
tags:
- Health
summary: Startup Probe
description: 'Startup probe endpoint - returns 200 when lifespan completed, 503 otherwise.
This endpoint is used by Cloud Run''s startupProbe to determine when the
container is ready to receive traffic. It waits until the app has completed
initialization before returning 200.'
operationId: headHealthStartup
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
x-operation-id-source: normalized
x-operation-id-original: startup_probe_health_startup_head
/health/ready:
get:
tags:
- Health
summary: Readiness Probe
description: 'Kubernetes readiness probe endpoint (supports GET and HEAD)
Checks if the application is ready to serve traffic.
Uses caching to avoid expensive BigQuery/Supabase calls on every request.
Cache TTL is 30 seconds - this reduces costs and improves response time.'
operationId: readiness_probe_health_ready_head
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DetailedHealthResponse'
head:
tags:
- Health
summary: Readiness Probe
description: 'Kubernetes readiness probe endpoint (supports GET and HEAD)
Checks if the application is ready to serve traffic.
Uses caching to avoid expensive BigQuery/Supabase calls on every request.
Cache TTL is 30 seconds - this reduces costs and improves response time.'
operationId: headHealthReady
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DetailedHealthResponse'
x-operation-id-source: normalized
x-operation-id-original: readiness_probe_health_ready_head
/health/stripe-config:
get:
tags:
- Health
summary: Stripe Config Health
description: 'Stripe configuration health check - validates Stripe mode matches environment.
This endpoint validates that:
1. API key mode (TEST vs LIVE) matches the environment
2. Price IDs are configured for the correct mode
3. No configuration drift has occurred
Used by post-deployment smoke tests and monitoring to detect
misconfigurations before they impact customers.
Returns:
Dict with status, mode info, and validation results'
operationId: stripe_config_health_health_stripe_config_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Stripe Config Health Health Stripe Config Get
components:
schemas:
HealthResponse:
properties:
status:
type: string
title: Status
timestamp:
type: number
title: Timestamp
version:
type: string
title: Version
environment:
type: string
title: Environment
uptime_seconds:
type: number
title: Uptime Seconds
instance_id:
type: string
title: Instance Id
commit_sha:
type: string
title: Commit Sha
type: object
required:
- status
- timestamp
- version
- environment
- uptime_seconds
- instance_id
- commit_sha
title: HealthResponse
description: Health check response model
DetailedHealthResponse:
properties:
status:
type: string
title: Status
timestamp:
type: number
title: Timestamp
version:
type: string
title: Version
environment:
type: string
title: Environment
uptime_seconds:
type: number
title: Uptime Seconds
services:
additionalProperties:
additionalProperties: true
type: object
type: object
title: Services
commit_sha:
type: string
title: Commit Sha
type: object
required:
- status
- timestamp
- version
- environment
- uptime_seconds
- services
- commit_sha
title: DetailedHealthResponse
description: Detailed health check response
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
APIKeyHeader:
type: apiKey
in: header
name: X-API-Key