Skip to content

A TypeScript client for interacting with The Sneaker Database API on RapidAPI. This npm package provides easy-to-use functions to fetch and manipulate data from the sneaker database.

License

Notifications You must be signed in to change notification settings

angelxmoreno/sneakerdb-client

Repository files navigation

SneakerDB Client

Maintainability Test Coverage codecov Build on Main License Last Commit dependencies

Node.js client for interacting with the Sneaker Database API.

Installation

npm install sneakerdb-client

Usage

const { TheSneakerDatabaseClient } = require('sneakerdb-client');

// Create a client instance with your API key
const client = new TheSneakerDatabaseClient('your-api-key');

// Example: Get sneakers
client.getSneakers({ limit: 5 }).then(response => {
  console.log(response);
});

API

There are 4 methods available on the client instance:

  • getSneakers: gets a list of sneakers based on the provided options.
  • getSneakerById: gets a sneaker by its TheSneakerDatabase ID.
  • getBrands: Gets the list of brands
  • getGenders: get the list of genders
  • search: search for sneakers based on the provided options.

For more information on the available options, please refer to the API documentation.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

A TypeScript client for interacting with The Sneaker Database API on RapidAPI. This npm package provides easy-to-use functions to fetch and manipulate data from the sneaker database.

Resources

License

Stars

Watchers

Forks

Packages

No packages published