NAV Navbar
shell python javascript

Introduction

Welcome to the Sellonaut API! You can use our API to access Sellonaut API endpoints, which can get product information from your database.

To retrieve product information, go use the Search API endpoint and start filtering through your database!

We have language bindings in Shell, Python, and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

To make requests include your API key with every request:

import requests

data = {
        "api_key": sellonaut_key,
       }

products = requests.post('https://www.api.sellonaut.com/api_endpoint_here', data)
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here" -d "api_key: sellonaut_key"
var request = require('request');

request.post('https://api.sellonaut.com/endpoint', {'api_key': sellonaut_key}, function(err, response, body) {
if (err) console.error(err);

});

Make sure to replace sellonaut_key with your API key.

Sellonaut uses API keys to allow access to the API. You can register a new Sellonaut API key by signing up for any plan.

Sellonaut expects for the API key to be included in all API requests to the server in a header that looks like the following:

api_key: sellonaut_key

Search

Search Items with Filters

import requests

data = {
        "api_key": sellonaut_key,
        "minROI": 30
        "searchTerms": "brand"
       }

products = requests.post('https://www.api.sellonaut.com/search', data)
curl "https://api.sellonaut.com/api/search"
  -d "api_key: sellonaut_key"
var request = require('request');

request.post('https://api.sellonaut.com/search', {'api_key': sellonaut_key, "minROI": 30, "searchTerms": "brand"}, function(err, response, body) {
if (err) console.error(err);

});

The above command returns JSON structured like this:

{
  "results": [
    {
      "brand": "",
      "lastUpdated": "",
      "ID": "",
      "Name": "",
      "Price": "",
      "Case": "",
      "ASIN": "",
      "availabilityAmazon": "",
      "reviewCount": "",
      "reviewRating": "",
      "ninetyDayBuyBoxAverage": "",
      "ninetyDayBSRAverage": "",
      "hasAmazon": "",
      "BSR": {
        "category": "",
        "rank": ""
      },
      "allOfferCount": "",
      "amazonBrand": "",
      "buyBoxOrLowestNew": "",
      "buyBoxPrice": "",
      "fbaFees": "",
      "fees": "",
      "itemDimensions": "",
      "itemPartNumber": "",
      "itemSize": "",
      "languages": "",
      "listPrice": "",
      "lowestNewPrice": "",
      "lowestPrice": "",
      "lowestUsedPrice": "",
      "manufacturer": "",
      "manufacturerMaximumAge": "",
      "manufacturerMaximumAgeUnits": "",
      "manufacturerMinimumAge": "",
      "manufacturerMinimumAgeUnits": "",
      "manufacturerPartsWarrantyDescription": "",
      "model": "",
      "newOfferCount": "",
      "packageDimensions": {
        "height": ,
        "heightUnits": "",
        "length": ,
        "lengthUnits": "",
        "width": ,
        "widthUnits": "",
        "weight": ,
        "weightUnits": ""
      },
      "packageQuantity": "",
      "partNumber": "",
      "referralFee": "",
      "referralFeePercentage": "",
      "size": "",
      "smallImage": "",
      "title": "",
      "totalDiamondWeight": "",
      "totalDiamondWeightUnits": "",
      "totalGemWeight": "",
      "totalGemWeightUnits": "",
      "usedOfferCount": "",
      "grossMarginAtBuyBox": "",
      "ninetyDayProfitAverage": "",
      "ninetyDayROIAverage": "",
      "profitAtBuyBox": "",
      "roiAtBuyBox": ""
    },
    {
      ...
     }
   ]
}

This endpoint retrieves all products with specified filters. The default value for all filters is null, which will return all items. Use the parameters below to filter through your data!

HTTP Request

POST https://api.sellonaut.com/search

Query Parameters

Parameter Type Description
minROI int set to see items with ROI > than the this value
maxROI int set to see items with ROI < than the this value
min90DayBSRAverage int set to see items with a 90 day BSR average > than this value
max90DayBSRAverage int set to see items with a 90 day BSR average < than this value
min90DayPriceAverage int set to see items with a 90 day Amazon price average > than this value
max90DayPriceAverag int set to see items with a 90 day Amazon price average < than this value
min90DayProfitAverage int set to see items with a 90 dayp profit average > than this value
max90DayProfitAverage int set to see items with a 90 day profit average < than this value
increaseMFPricing float see what listings would appear if MF prices were increased / decreased by X% (ex. 25% == 0.25)
increaseWholesaleCosts float see what listings would appear if wholesale prices were increased / decreased by X% (ex. -25% == -0.25)
min90DayROIAverage int set to see items with a 90 day ROI average > than this value
max90DayROIAverage int set to see items with a 90 day ROI average < than this value
minProfit float set to see items with profit > than the this value
maxProfit float set to see items with profit < than the this value
minSellers int set to see items with number of sellers > than the this value
maxSellers int set to see items with number of sellers < than the this value
minWholesalePrice float set to see items with wholesale price > than the this value
maxWholesalePrice float set to see items with wholesale price < than the this value
minBSR int set to see items with BSR > than the this value
maxBSR int set to see items with BSR < than the this value
minPrice float set to see items with Amazon price > than the this value
maxPrice float set to see items with Amazon price < than the this value
categories array provide an array of categories to filter by
sellerTypes array provide an array of seller types to filter by (available options are: MFN, FBA)
allowNullBSR bool allow items with non existent BSR values to appear
allowNullDimensions bool allow items with non existent Dimensions values to appear
allowOutOfStock bool allow items with no sellers to appear
includeNoReviews bool allow items with no reviews to appear
searchTerms string string of search terms to filter by (ie. brand, ASIN, ID, title...)
vendors array provide an array of brands you would like to filter by
sizeTier string filter by size (ie. STANDARD or OVERSIZED)
minReviewCount int set to see items with review counts > than the this value
maxReviewCount int set to see items with review counts < than the this value
minReviewRating float set to see items with review star rating > than the this value
maxReviewRating float set to see items with review star rating < than the this value
costPerUnitStandard float set value to add to cost if size is standard
costPerUnitOversize float set value to add to cost if size oversized
costPerPound float set a value to add for each additional pound
costPerBundleUnit float set a value to add for bundles

Errors

The Sellonaut API uses the following error codes:

Error Code Meaning
401 Unauthorized -- Your do not have enough tokens to fulfill this request.
403 Forbidden -- Your request is invalid.
500 Internal Server Error -- We had a problem with our server. Contact support.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.