api-ninjas-com Covid 19 API

openapi: 3.2.0
info:
  title: Ninjas Covid 19 API
  description: 'Combined OpenAPI specification for every API Ninjas endpoint. Requests go to https://api.api-ninjas.com with an `X-Api-Key` header; get a free key at https://api-ninjas.com/register. Human-readable docs: https://api-ninjas.com/api. Index for LLMs: https://api-ninjas.com/llms.txt.'
  version: 1.0.0
  contact:
    name: API Ninjas
    url: https://api-ninjas.com
  license:
    name: Proprietary
servers:
- url: https://api.api-ninjas.com
  description: API Ninjas Production
security:
- ApiKeyAuth: []
tags:
- name: Covid-19
  description: The Covid-19 API provides current and historical Covid-19 data for every country in the world. Available data includes confirmed case counts and deaths, and is updated everyday.
paths:
  /v1/covid19:
    get:
      summary: Get Covid-19 case count or death data
      description: Returns Covid-19 case counts or deaths by country, administrative region, or US county, as a series or a single-day snapshot. Either `date` or `country` must be set.
      operationId: getCovidData
      tags:
      - Covid-19
      parameters:
      - name: date
        in: query
        description: Date to retrieve single-day snapshot. Must be in the form of YYYY-MM-DD (e.g. 2022-01-01). Either date or country must be set.
        required: false
        schema:
          type: string
          format: date
      - name: country
        in: query
        description: Country name (case insensitive). Either date or country must be set.
        required: false
        schema:
          type: string
      - name: region
        in: query
        description: Administrative region (also known as state or province in many countries) name (case insensitive). Must be used in conjunction with country. If not set, countries with data broken down by administrative regions will return separate data for each region.
        required: false
        schema:
          type: string
      - name: county
        in: query
        description: County name for US states (case insensitive). For United States data only. Must be used in conjunction with country (United States) and region (e.g. California).
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: Type of data to retrieve. Must be either cases or deaths. If not set, cases will be used by default.
        required: false
        schema:
          type: string
          enum:
          - cases
          - deaths
      responses:
        '200':
          description: Either a time series of Covid-19 case counts/deaths for a country/region or a single-day snapshot of every country in the world, returned as a list of data entries.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CovidData'
        '400':
          description: Bad Request - The request was invalid, details are provided in the error message.
        '401':
          description: Unauthorized - API key is missing or invalid.
        '500':
          description: Internal Server Error - We had a problem with our server. Try again later.
      security:
      - ApiKeyAuth: []
components:
  schemas:
    CaseData:
      type: object
      properties:
        total:
          type: integer
          description: Total cases/deaths.
        new:
          type: integer
          description: New cases/deaths for that day.
    CovidData:
      type: object
      properties:
        country:
          type: string
          description: Country name.
        region:
          type: string
          description: Administrative region (state or province) name, if applicable.
        cases:
          type: object
          description: Object with dates as keys, each containing total (total cases/deaths) and new (new cases/deaths for that day).
          additionalProperties:
            $ref: '#/components/schemas/CaseData'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api