🐕 BestDogBox SDK

Official Node.js client for the BestDogBox API. Access 346 dog breeds, subscription box rankings, and breed comparisons.

Install

npm install bestdogbox

Quick Start

const BestDogBox = require('bestdogbox');
const client = new BestDogBox('your_api_key');

// Get all large breeds
const { data } = await client.breeds.list({ size: 'large' });
console.log(data);

// Get a single breed
const golden = await client.breeds.get('golden-retriever');
console.log(golden.data.name); // "Golden Retriever"

// Compare two breeds
const compare = await client.breeds.compare('golden-retriever', 'labrador-retriever');
console.log(compare.data.breed_a.name, 'vs', compare.data.breed_b.name);

// Get top subscription boxes
const boxes = await client.subscriptionBoxes.list({ limit: 5 });
console.log(boxes.data);

API Key

All requests require an API key. Get one for free at bestdogbox.com/developers.

Available Methods

| Method | Description | |--------|-------------| | client.breeds.list(options) | List all breeds (paginated, filterable) | | client.breeds.get(slug) | Get single breed by slug | | client.breeds.compare(slugA, slugB) | Compare two breeds side-by-side | | client.subscriptionBoxes.list(options) | Get top ranked subscription boxes |

Filter Options

client.breeds.list({
  page: 1,          // Page number
  limit: 50,        // Results per page (max 50)
  size: 'large',    // toy, small, medium, large, giant
  group: 'sporting', // AKC breed group
  search: 'retriever' // Search by name
});

TypeScript

Full TypeScript support included out of the box.

import BestDogBox = require('bestdogbox');
const client = new BestDogBox('your_api_key');
const { data } = await client.breeds.get('poodle');
console.log(data.lifespan_min); // number

Rate Limits

• 1,000 requests/day per API key (free)
• Need more? Contact [email protected]

Links

• API Documentation
• BestDogBox.com
• Dog Breed Profiles
• Best Dog Subscription Boxes

License

MIT © BestDogBox