api-ninjas-com Dogs API

openapi: 3.2.0
info:
  title: Ninjas Dogs 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: Dogs
  description: The Dogs API provides detailed, qualitative information on over 200 different breeds of dogs.
paths:
  /v1/dogs:
    get:
      summary: Get a list of dog breeds matching specified parameters
      description: Returns dog breeds matching filters such as name, height, weight, life expectancy, shedding, barking, energy, or trainability. For breed names only use /alldogs.
      operationId: getDogs
      parameters:
      - name: name
        in: query
        description: The name of breed.
        required: false
        schema:
          type: string
      - name: min_height
        in: query
        description: Minimum height in inches.
        required: false
        schema:
          type: integer
      - name: max_height
        in: query
        description: Maximum height in inches.
        required: false
        schema:
          type: integer
      - 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 breed sheds.
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 5
      - name: barking
        in: query
        description: How vocal the breed is.
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 5
      - name: energy
        in: query
        description: How much energy the breed has.
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 5
      - name: protectiveness
        in: query
        description: How likely the breed is to alert strangers.
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 5
      - name: trainability
        in: query
        description: How easy it is to train the breed.
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 5
      - name: offset
        in: query
        description: Number of results to offset for pagination.
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: A list of dog breeds.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dog'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DogsOpenapi_Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DogsOpenapi_Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DogsOpenapi_Error'
      security:
      - ApiKeyAuth: []
      tags:
      - Dogs
  /v1/alldogs:
    get:
      summary: Returns a list of all dog breed names
      description: Returns the names of every dog breed in the database and no other fields. For breed traits and measurements such as height, weight, and shedding use /dogs.
      operationId: getAllDogs
      responses:
        '200':
          description: A list of all dog breed names.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DogsOpenapi_Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DogsOpenapi_Error'
      security:
      - ApiKeyAuth: []
      tags:
      - Dogs
components:
  schemas:
    Dog:
      type: object
      properties:
        image_link:
          type: string
          format: uri
          description: URL to an image of the dog breed.
        good_with_children:
          type: integer
          minimum: 1
          maximum: 5
          description: Rating of how well the breed interacts with children.
        good_with_other_dogs:
          type: integer
          minimum: 1
          maximum: 5
          description: Rating of how well the breed interacts with other dogs.
        shedding:
          type: integer
          minimum: 1
          maximum: 5
          description: Rating of how much the breed sheds.
        grooming:
          type: integer
          minimum: 1
          maximum: 5
          description: Rating of grooming needs.
        drooling:
          type: integer
          minimum: 1
          maximum: 5
          description: Rating of how much the breed drools.
        coat_length:
          type: integer
          minimum: 1
          maximum: 5
          description: Rating of the breed's coat length.
        good_with_strangers:
          type: integer
          minimum: 1
          maximum: 5
          description: Rating of how well the breed interacts with strangers.
        playfulness:
          type: integer
          minimum: 1
          maximum: 5
          description: Rating of the breed's playfulness.
        protectiveness:
          type: integer
          minimum: 1
          maximum: 5
          description: Rating of the breed's protectiveness.
        trainability:
          type: integer
          minimum: 1
          maximum: 5
          description: Rating of how easy it is to train the breed.
        energy:
          type: integer
          minimum: 1
          maximum: 5
          description: Rating of the breed's energy level.
        barking:
          type: integer
          minimum: 1
          maximum: 5
          description: Rating of how vocal the breed is.
        min_life_expectancy:
          type: integer
          description: Minimum life expectancy of the breed in years.
        max_life_expectancy:
          type: integer
          description: Maximum life expectancy of the breed in years.
        max_height_male:
          type: integer
          description: Maximum height of a male dog of the breed in inches.
        max_height_female:
          type: integer
          description: Maximum height of a female dog of the breed in inches.
        max_weight_male:
          type: integer
          description: Maximum weight of a male dog of the breed in pounds.
        max_weight_female:
          type: integer
          description: Maximum weight of a female dog of the breed in pounds.
        min_height_male:
          type: integer
          description: Minimum height of a male dog of the breed in inches.
        min_height_female:
          type: integer
          description: Minimum height of a female dog of the breed in inches.
        min_weight_male:
          type: integer
          description: Minimum weight of a male dog of the breed in pounds.
        min_weight_female:
          type: integer
          description: Minimum weight of a female dog of the breed in pounds.
        name:
          type: string
          description: Name of the dog breed.
    DogsOpenapi_Error:
      type: object
      properties:
        error:
          type: string
          description: Error message.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api