Ninety Percent Muffin

    sneaks-api

    1.2.3 • Public • Published

    A StockX API, FlightClub API, Goat API, and Stadium Goods API all in one.

    Sneaks API is a sneaker API built using Node.JS, Express, and Got. The Sneaks API allows users to get essential sneaker content such as images, product links and even prices from resell sites while also collecting data and storing it within a database. This API mainly scrapes StockX for sneaker information and then asynchronously scrapes Stadium Goods, Goat, and Flight Club for additional sneaker information such as images and its respective resell price. This API outputs a sneaker object of the following variables:

    UPDATE 1.2.3: Updated and fixed the Goat API to reflect their API changes. Removed the web server (localhost:4000) the package creates.

    • Sneaker Name
    • Colorway
    • Description
    • Release Date
    • Retail Price
    • Style ID
    • Image Links
    • Product links from each of the resell sites
    • Price map (of shoe size to price) from each of the resell sites
    • And more

    I built this API so sneaker heads and developers are able to create sneaker based programs, trackers and websites without having to fumble with scrapping information on all 4 resell websites. Feel free to fork, edit and submit a pull request for this API for any changes or improvements. If you have any questions or issues regarding this feel free to create an issue and I will try to answer them as soon as I can.

    UPDATE: As per many requests, I updated this API to version 1.1 which removes the caching database from the API so no need to download and have MongoDB running for the API. If youd like to use the database version of the API, it is now a depreciated branch to this repository.

    Demo

    Sneaks App - Github

    Twilio Blog Tutorial: Build a Sneaker Price Tracker with Twilio Programmable SMS

    Technologies Used

    • Node.JS
    • Express
    • Got
    • Request
    • Mongoose

    Installation

    To use this API you will need to have node.js installed and running. Once installed, use this line on the terminal within your project directory

    npm install sneaks-api
    

    and place this line at the top of your main file

    const SneaksAPI = require('sneaks-api');

    How to Use

    const SneaksAPI = require('sneaks-api');
    const sneaks = new SneaksAPI();
    
    //getProducts(keyword, limit, callback) takes in a keyword and limit and returns a product array 
    sneaks.getProducts("Yeezy Cinder", 10, function(err, products){
        console.log(products)
    })
    
    //Product object includes styleID where you input it in the getProductPrices function
    //getProductPrices(styleID, callback) takes in a style ID and returns sneaker info including a price map and more images of the product
    sneaks.getProductPrices("FY2903", function(err, product){
        console.log(product)
    })
    //getMostPopular(limit, callback) takes in a limit and returns an array of the current popular products curated by StockX
    sneaks.getMostPopular(10, function(err, products){
        console.log(products)
    })

    Console log of sneaks.getProducts("Yeezy Cinder", ...)
    Console log of sneaks.getProductPrices("FY2903", ...)

    Install

    npm i sneaks-api

    DownloadsWeekly Downloads

    106

    Version

    1.2.3

    License

    MIT

    Unpacked Size

    5.66 MB

    Total Files

    16

    Last publish

    Collaborators

    • druv5319