Skip to main content

Dog Breeds is a simple tool for getting information about dog breeds. It returns information such as breed name, temperament, lifespan, and more.

Project description

Dog Breeds API

Dog Breeds is a simple tool for getting information about dog breeds. It returns information such as breed name, temperament, lifespan, and more.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Dog Breeds API


Installation

Using pip:

pip install apiverve-dogbreeds

Using pip3:

pip3 install apiverve-dogbreeds

Configuration

Before using the dogbreeds API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_dogbreeds.apiClient import DogbreedsAPIClient

# Initialize the client with your APIVerve API key
api = DogbreedsAPIClient("[YOUR_API_KEY]")

query = { "breed": "beagle" }

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Dog Breeds API documentation is found here: https://docs.apiverve.com/ref/dogbreeds. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_dogbreeds.apiClient import DogbreedsAPIClient

# Initialize the client with your APIVerve API key
api = DogbreedsAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = { "breed": "beagle" }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "breed": "beagle",
    "foundCount": 1,
    "foundBreeds": [
      {
        "name": "Beagle",
        "weight": {
          "lowerLbs": 20,
          "upperLbs": 35
        },
        "height": {
          "lowerInches": 13,
          "upperInches": 15
        },
        "bredFor": "rabbit, hare hunting",
        "group": "hound",
        "life_span": {
          "lowerYears": 13,
          "upperYears": 16
        },
        "traits": [
          "amiable",
          "even tempered",
          "excitable",
          "determined",
          "gentle",
          "intelligent"
        ]
      }
    ]
  }
}

Error Handling

The API client provides comprehensive error handling through the DogbreedsAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_dogbreeds.apiClient import DogbreedsAPIClient, DogbreedsAPIClientError

api = DogbreedsAPIClient("[YOUR_API_KEY]")

query = { "breed": "beagle" }

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except DogbreedsAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_dogbreeds.apiClient import DogbreedsAPIClient, DogbreedsAPIClientError

api = DogbreedsAPIClient("[YOUR_API_KEY]")

query = { "breed": "beagle" }

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except DogbreedsAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_dogbreeds.apiClient import DogbreedsAPIClient, DogbreedsAPIClientError

query = { "breed": "beagle" }

# Using context manager ensures proper cleanup
with DogbreedsAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except DogbreedsAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_dogbreeds.apiClient import DogbreedsAPIClient

# Enable debug mode
api = DogbreedsAPIClient("[YOUR_API_KEY]", debug=True)

query = { "breed": "beagle" }

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_dogbreeds.apiClient import DogbreedsAPIClient

api = DogbreedsAPIClient("[YOUR_API_KEY]")

query = { "breed": "beagle" }

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_dogbreeds-1.1.14.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_dogbreeds-1.1.14-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_dogbreeds-1.1.14.tar.gz.

File metadata

  • Download URL: apiverve_dogbreeds-1.1.14.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_dogbreeds-1.1.14.tar.gz
Algorithm Hash digest
SHA256 3c00c4627421517a18d245327b0fd0783f3c30e55df381f5517fa70887939c70
MD5 5b3cdf2a933279c2a92a008a71f90f41
BLAKE2b-256 8973e4fd94b6b9ee997630a1a4522f98f1c16f725d0a37bfe5e57d4e6c9ec93d

See more details on using hashes here.

File details

Details for the file apiverve_dogbreeds-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_dogbreeds-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 2144ed301986475129d194a0a1ac3635d3f2c755803ebbd3a36b01f067bc9afa
MD5 245292af97c7563cc523f127dd7f2ebb
BLAKE2b-256 0d7f32ef50474050247664cbdc8fca86262f8e33796ba3411173f11a4702ed5e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page