api-ninjas-com Cats by API Ninjas API

openapi: 3.2.0
info:
  title: Cats by API Ninjas 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: Cats by API Ninjas
  description: The Cats API provides detailed, qualitative information on every recognized cat breed.
paths:
  /v1/cats:
    get:
      summary: Get a list of cat breeds matching specified parameters
      description: Returns cat breeds matching the given parameters, including weight, life expectancy, shedding, grooming and friendliness traits. For breed names only use /allcats.
      operationId: getCats
      parameters:
      - name: name
        in: query
        description: The name of cat breed.
        required: false
        schema:
          type: string
      - name: min_weight
        in: query
        description: Minimum weight in pounds.
        required: false
        schema:
          type: integer
      - name: max_weight
        in: query
        description: Maximum weight in pounds.
        required: false
        schema:
          type: integer
      - name: min_life_expectancy
        in: query
        description: Minimum life expectancy in years.
        required: false
        schema:
          type: integer
      - name: max_life_expectancy
        in: query
        description: Maximum life expectancy in years.
        required: false
        schema:
          type: integer
      - name: shedding
        in: query
        description: How much hair the cat sheds.
        required: false
        schema:
          type: integer
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
      - name: family_friendly
        in: query
        description: How affectionate the cat is to family.
        required: false
        schema:
          type: integer
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
      - name: playfulness
        in: query
        description: How playful the cat is.
        required: false
        schema:
          type: integer
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
      - name: grooming
        in: query
        description: How much work is required to properly groom the cat.
        required: false
        schema:
          type: integer
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
      - name: other_pets_friendly
        in: query
        description: How well the cat gets along with other pets in the household.
        required: false
        schema:
          type: integer
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
      - name: children_friendly
        in: query
        description: How well the cat gets along with children.
        required: false
        schema:
          type: integer
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
      - name: offset
        in: query
        description: Number of results to offset for pagination.
        required: false
        schema:
          type: integer
      responses:
        '200':
          $ref: '#/components/responses/CatsOpenapi_200'
        '400':
          $ref: '#/components/responses/CatsOpenapi_400'
        '401':
          $ref: '#/components/responses/CatsOpenapi_401'
        '500':
          $ref: '#/components/responses/CatsOpenapi_500'
      security:
      - ApiKeyAuth: []
      tags:
      - Cats by API Ninjas
  /v1/allcats:
    get:
      summary: Returns a list of all cat breed names
      description: Returns the names of every cat breed in the database and nothing else. Takes no parameters. For full breed detail and filtering use /cats.
      operationId: getAllCatNames
      responses:
        '200':
          $ref: '#/components/responses/200Names'
        '400':
          $ref: '#/components/responses/CatsOpenapi_400'
        '401':
          $ref: '#/components/responses/CatsOpenapi_401'
        '500':
          $ref: '#/components/responses/CatsOpenapi_500'
      security:
      - ApiKeyAuth: []
      tags:
      - Cats by API Ninjas
components:
  schemas:
    CatNames:
      type: array
      items:
        type: string
    Cat:
      type: object
      properties:
        length:
          type: string
        origin:
          type: string
        image_link:
          type: string
          format: uri
        family_friendly:
          type: integer
        shedding:
          type: integer
        general_health:
          type: integer
        playfulness:
          type: integer
        children_friendly:
          type: integer
        grooming:
          type: integer
        intelligence:
          type: integer
        other_pets_friendly:
          type: integer
        min_weight:
          type: integer
        max_weight:
          type: integer
        min_life_expectancy:
          type: integer
        max_life_expectancy:
          type: integer
        name:
          type: string
  responses:
    CatsOpenapi_200:
      description: A list of cat breeds
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Cat'
    200Names:
      description: A list of all cat breed names
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CatNames'
    CatsOpenapi_400:
      description: Bad Request
    CatsOpenapi_500:
      description: Internal Server Error
    CatsOpenapi_401:
      description: Unauthorized
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api