openapi: 3.0.0
info:
  version: 1.0.0
  title: Consumer Complaint Database Aggregations Health API
  description: The API for searching the CFPB Consumer Complaint Database, which contains over 15 million consumer financial complaint records.
  termsOfService: https://cfpb.github.io/source-code-policy/
  contact:
    name: Report API Issues
    url: https://github.com/cfpb/ccdb5-api/issues
  license:
    name: Creative Commons License CC0
    url: https://github.com/cfpb/ccdb5-api/blob/main/LICENSE
servers:
- url: https://www.consumerfinance.gov/data-research/consumer-complaints/search/api/v1/
  description: Production server
security: []
tags:
- name: Health
  description: Service health check
paths:
  /:
    get:
      tags:
      - Health
      summary: Service health check
      description: Returns the health status of the HMDA Platform Filing API
      security: []
      responses:
        '200':
          description: Service is running
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
components:
  schemas:
    HealthStatus:
      type: object
      properties:
        status:
          type: string
          description: Service name
        service:
          type: string
          description: Service name
        timestamp:
          type: string
          format: date-time
          description: Current timestamp
        host:
          type: string
          description: Host name
externalDocs:
  description: Additional API Information
  url: https://cfpb.github.io/api/ccdb/