Skip to content

AmazonApi.md

Latest commit

 

History

History
1691 lines (1374 loc) · 57.9 KB

AmazonApi.md

File metadata and controls

1691 lines (1374 loc) · 57.9 KB
Raw

ScrapeBadger.Api.AmazonApi

All URIs are relative to https://scrapebadger.com

Method HTTP request Description
AmazonAmazonScraperHealthCheck GET /v1/amazon/health Amazon scraper health check
AmazonAmazonScraperHealthCheckHead HEAD /v1/amazon/health Amazon scraper health check
AmazonBestsellersByCategory GET /v1/amazon/bestsellers Bestsellers by category
AmazonBrowseNodeCategoryListing GET /v1/amazon/category Browse-node category listing
AmazonGetAllSellerOffersBuybox GET /v1/amazon/products/{asin}/offers Get all seller offers (buybox)
AmazonGetProductDetail GET /v1/amazon/products/{asin} Get product detail
AmazonGetProductReviews GET /v1/amazon/products/{asin}/reviews Get product reviews
AmazonGetSellerFeedback GET /v1/amazon/sellers/{seller_id}/feedback Get seller feedback
AmazonGetSellerProfile GET /v1/amazon/sellers/{seller_id} Get seller profile
AmazonGetSellerStorefrontProducts GET /v1/amazon/sellers/{seller_id}/products Get seller storefront products
AmazonKeywordSuggestions GET /v1/amazon/autocomplete Keyword suggestions
AmazonListCategoryAliases GET /v1/amazon/categories List category aliases
AmazonListMarketplaces GET /v1/amazon/markets List marketplaces
AmazonNewReleasesByCategory GET /v1/amazon/new-releases New releases by category
AmazonSearchAmazonProducts GET /v1/amazon/search Search Amazon products
AmazonTodaySDeals GET /v1/amazon/deals Today's deals

AmazonAmazonScraperHealthCheck

Object AmazonAmazonScraperHealthCheck ()

Amazon scraper health check

Check health of the Amazon scraper service (accepts HEAD for UptimeRobot).

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonAmazonScraperHealthCheckExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);

            try
            {
                // Amazon scraper health check
                Object result = apiInstance.AmazonAmazonScraperHealthCheck();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonAmazonScraperHealthCheck: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonAmazonScraperHealthCheckWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Amazon scraper health check
    ApiResponse<Object> response = apiInstance.AmazonAmazonScraperHealthCheckWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonAmazonScraperHealthCheckWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonAmazonScraperHealthCheckHead

Object AmazonAmazonScraperHealthCheckHead ()

Amazon scraper health check

Check health of the Amazon scraper service (accepts HEAD for UptimeRobot).

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonAmazonScraperHealthCheckHeadExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);

            try
            {
                // Amazon scraper health check
                Object result = apiInstance.AmazonAmazonScraperHealthCheckHead();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonAmazonScraperHealthCheckHead: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonAmazonScraperHealthCheckHeadWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Amazon scraper health check
    ApiResponse<Object> response = apiInstance.AmazonAmazonScraperHealthCheckHeadWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonAmazonScraperHealthCheckHeadWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonBestsellersByCategory

Object AmazonBestsellersByCategory (string domain = null, string category = null, int? page = null)

Bestsellers by category

Top-selling products for a category (browse node).

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonBestsellersByCategoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var domain = "\"com\"";  // string |  (optional)  (default to "com")
            var category = "category_example";  // string | Bestsellers node id or slug (optional) 
            var page = 1;  // int? |  (optional)  (default to 1)

            try
            {
                // Bestsellers by category
                Object result = apiInstance.AmazonBestsellersByCategory(domain, category, page);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonBestsellersByCategory: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonBestsellersByCategoryWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Bestsellers by category
    ApiResponse<Object> response = apiInstance.AmazonBestsellersByCategoryWithHttpInfo(domain, category, page);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonBestsellersByCategoryWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
domain string [optional] [default to "com"]
category string Bestsellers node id or slug [optional]
page int? [optional] [default to 1]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonBrowseNodeCategoryListing

Object AmazonBrowseNodeCategoryListing (string node, string domain = null, int? page = null, string sortBy = null)

Browse-node category listing

List products within an Amazon browse-node category.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonBrowseNodeCategoryListingExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var node = "node_example";  // string | Amazon browse-node id
            var domain = "\"com\"";  // string |  (optional)  (default to "com")
            var page = 1;  // int? |  (optional)  (default to 1)
            var sortBy = "sortBy_example";  // string |  (optional) 

            try
            {
                // Browse-node category listing
                Object result = apiInstance.AmazonBrowseNodeCategoryListing(node, domain, page, sortBy);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonBrowseNodeCategoryListing: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonBrowseNodeCategoryListingWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Browse-node category listing
    ApiResponse<Object> response = apiInstance.AmazonBrowseNodeCategoryListingWithHttpInfo(node, domain, page, sortBy);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonBrowseNodeCategoryListingWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
node string Amazon browse-node id
domain string [optional] [default to "com"]
page int? [optional] [default to 1]
sortBy string [optional]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonGetAllSellerOffersBuybox

Object AmazonGetAllSellerOffersBuybox (string asin, string domain = null, string zip = null, int? page = null)

Get all seller offers (buybox)

All third-party offers for an ASIN, including the Buy Box winner.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonGetAllSellerOffersBuyboxExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var asin = "asin_example";  // string | 
            var domain = "\"com\"";  // string |  (optional)  (default to "com")
            var zip = "zip_example";  // string |  (optional) 
            var page = 1;  // int? | Offer page, 10 rows each (optional)  (default to 1)

            try
            {
                // Get all seller offers (buybox)
                Object result = apiInstance.AmazonGetAllSellerOffersBuybox(asin, domain, zip, page);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonGetAllSellerOffersBuybox: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonGetAllSellerOffersBuyboxWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get all seller offers (buybox)
    ApiResponse<Object> response = apiInstance.AmazonGetAllSellerOffersBuyboxWithHttpInfo(asin, domain, zip, page);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonGetAllSellerOffersBuyboxWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
asin string
domain string [optional] [default to "com"]
zip string [optional]
page int? Offer page, 10 rows each [optional] [default to 1]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonGetProductDetail

Object AmazonGetProductDetail (string asin, string domain = null, string zip = null, string language = null)

Get product detail

Full product detail by ASIN (price, variants, badges, buybox, ranks…).

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonGetProductDetailExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var asin = "asin_example";  // string | 
            var domain = "\"com\"";  // string |  (optional)  (default to "com")
            var zip = "zip_example";  // string | Delivery postal/zip for localized buybox (optional) 
            var language = "language_example";  // string |  (optional) 

            try
            {
                // Get product detail
                Object result = apiInstance.AmazonGetProductDetail(asin, domain, zip, language);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonGetProductDetail: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonGetProductDetailWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get product detail
    ApiResponse<Object> response = apiInstance.AmazonGetProductDetailWithHttpInfo(asin, domain, zip, language);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonGetProductDetailWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
asin string
domain string [optional] [default to "com"]
zip string Delivery postal/zip for localized buybox [optional]
language string [optional]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonGetProductReviews

Object AmazonGetProductReviews (string asin, string domain = null, int? page = null, string sortBy = null, string star = null, bool? verifiedOnly = null, bool? mediaOnly = null)

Get product reviews

Customer reviews for an ASIN (featured + paginated, with filters).

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonGetProductReviewsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var asin = "asin_example";  // string | 
            var domain = "\"com\"";  // string |  (optional)  (default to "com")
            var page = 1;  // int? | Review page (1-100, ~10 reviews/page) (optional)  (default to 1)
            var sortBy = "\"helpful\"";  // string | helpful | recent (optional)  (default to "helpful")
            var star = "star_example";  // string | one_star..five_star | positive | critical (optional) 
            var verifiedOnly = false;  // bool? |  (optional)  (default to false)
            var mediaOnly = false;  // bool? |  (optional)  (default to false)

            try
            {
                // Get product reviews
                Object result = apiInstance.AmazonGetProductReviews(asin, domain, page, sortBy, star, verifiedOnly, mediaOnly);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonGetProductReviews: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonGetProductReviewsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get product reviews
    ApiResponse<Object> response = apiInstance.AmazonGetProductReviewsWithHttpInfo(asin, domain, page, sortBy, star, verifiedOnly, mediaOnly);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonGetProductReviewsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
asin string
domain string [optional] [default to "com"]
page int? Review page (1-100, ~10 reviews/page) [optional] [default to 1]
sortBy string helpful recent
star string one_star..five_star positive
verifiedOnly bool? [optional] [default to false]
mediaOnly bool? [optional] [default to false]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonGetSellerFeedback

Object AmazonGetSellerFeedback (string sellerId, string domain = null, int? page = null)

Get seller feedback

Buyer feedback entries for a seller.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonGetSellerFeedbackExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var sellerId = "sellerId_example";  // string | 
            var domain = "\"com\"";  // string |  (optional)  (default to "com")
            var page = 1;  // int? |  (optional)  (default to 1)

            try
            {
                // Get seller feedback
                Object result = apiInstance.AmazonGetSellerFeedback(sellerId, domain, page);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonGetSellerFeedback: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonGetSellerFeedbackWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get seller feedback
    ApiResponse<Object> response = apiInstance.AmazonGetSellerFeedbackWithHttpInfo(sellerId, domain, page);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonGetSellerFeedbackWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sellerId string
domain string [optional] [default to "com"]
page int? [optional] [default to 1]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonGetSellerProfile

Object AmazonGetSellerProfile (string sellerId, string domain = null)

Get seller profile

Seller profile, ratings and feedback summary.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonGetSellerProfileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var sellerId = "sellerId_example";  // string | 
            var domain = "\"com\"";  // string |  (optional)  (default to "com")

            try
            {
                // Get seller profile
                Object result = apiInstance.AmazonGetSellerProfile(sellerId, domain);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonGetSellerProfile: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonGetSellerProfileWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get seller profile
    ApiResponse<Object> response = apiInstance.AmazonGetSellerProfileWithHttpInfo(sellerId, domain);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonGetSellerProfileWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sellerId string
domain string [optional] [default to "com"]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonGetSellerStorefrontProducts

Object AmazonGetSellerStorefrontProducts (string sellerId, string domain = null, int? page = null)

Get seller storefront products

Products listed in a seller's storefront.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonGetSellerStorefrontProductsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var sellerId = "sellerId_example";  // string | 
            var domain = "\"com\"";  // string |  (optional)  (default to "com")
            var page = 1;  // int? |  (optional)  (default to 1)

            try
            {
                // Get seller storefront products
                Object result = apiInstance.AmazonGetSellerStorefrontProducts(sellerId, domain, page);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonGetSellerStorefrontProducts: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonGetSellerStorefrontProductsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get seller storefront products
    ApiResponse<Object> response = apiInstance.AmazonGetSellerStorefrontProductsWithHttpInfo(sellerId, domain, page);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonGetSellerStorefrontProductsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
sellerId string
domain string [optional] [default to "com"]
page int? [optional] [default to 1]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonKeywordSuggestions

Object AmazonKeywordSuggestions (string query, string domain = null)

Keyword suggestions

Get Amazon search autocomplete suggestions for keyword research.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonKeywordSuggestionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var query = "query_example";  // string | Partial search term
            var domain = "\"com\"";  // string |  (optional)  (default to "com")

            try
            {
                // Keyword suggestions
                Object result = apiInstance.AmazonKeywordSuggestions(query, domain);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonKeywordSuggestions: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonKeywordSuggestionsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Keyword suggestions
    ApiResponse<Object> response = apiInstance.AmazonKeywordSuggestionsWithHttpInfo(query, domain);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonKeywordSuggestionsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
query string Partial search term
domain string [optional] [default to "com"]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonListCategoryAliases

Object AmazonListCategoryAliases (string domain = null)

List category aliases

List common Amazon department/category aliases and bestseller nodes.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonListCategoryAliasesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var domain = "\"com\"";  // string |  (optional)  (default to "com")

            try
            {
                // List category aliases
                Object result = apiInstance.AmazonListCategoryAliases(domain);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonListCategoryAliases: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonListCategoryAliasesWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // List category aliases
    ApiResponse<Object> response = apiInstance.AmazonListCategoryAliasesWithHttpInfo(domain);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonListCategoryAliasesWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
domain string [optional] [default to "com"]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonListMarketplaces

Object AmazonListMarketplaces ()

List marketplaces

List all supported Amazon marketplaces.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonListMarketplacesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);

            try
            {
                // List marketplaces
                Object result = apiInstance.AmazonListMarketplaces();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonListMarketplaces: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonListMarketplacesWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // List marketplaces
    ApiResponse<Object> response = apiInstance.AmazonListMarketplacesWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonListMarketplacesWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonNewReleasesByCategory

Object AmazonNewReleasesByCategory (string domain = null, string category = null, int? page = null)

New releases by category

Newly released products for a category (browse node).

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonNewReleasesByCategoryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var domain = "\"com\"";  // string |  (optional)  (default to "com")
            var category = "category_example";  // string |  (optional) 
            var page = 1;  // int? |  (optional)  (default to 1)

            try
            {
                // New releases by category
                Object result = apiInstance.AmazonNewReleasesByCategory(domain, category, page);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonNewReleasesByCategory: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonNewReleasesByCategoryWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // New releases by category
    ApiResponse<Object> response = apiInstance.AmazonNewReleasesByCategoryWithHttpInfo(domain, category, page);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonNewReleasesByCategoryWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
domain string [optional] [default to "com"]
category string [optional]
page int? [optional] [default to 1]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonSearchAmazonProducts

Object AmazonSearchAmazonProducts (string query, string domain = null, int? page = null, string sortBy = null, string category = null, decimal? minPrice = null, decimal? maxPrice = null, string zip = null, string language = null)

Search Amazon products

Search the Amazon catalog with filters and sorting.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonSearchAmazonProductsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var query = "query_example";  // string | Search keywords
            var domain = "\"com\"";  // string | Amazon marketplace TLD or code (com, co.uk, de…) (optional)  (default to "com")
            var page = 1;  // int? |  (optional)  (default to 1)
            var sortBy = "sortBy_example";  // string | relevance | price_low_to_high | price_high_to_low | avg_review | newest (optional) 
            var category = "category_example";  // string | Department/category alias (i= param) (optional) 
            var minPrice = 8.14D;  // decimal? |  (optional) 
            var maxPrice = 8.14D;  // decimal? |  (optional) 
            var zip = "zip_example";  // string | Delivery postal/zip code for localized pricing (optional) 
            var language = "language_example";  // string | Locale for results, e.g. en_US, fr_FR (optional) 

            try
            {
                // Search Amazon products
                Object result = apiInstance.AmazonSearchAmazonProducts(query, domain, page, sortBy, category, minPrice, maxPrice, zip, language);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonSearchAmazonProducts: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonSearchAmazonProductsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Search Amazon products
    ApiResponse<Object> response = apiInstance.AmazonSearchAmazonProductsWithHttpInfo(query, domain, page, sortBy, category, minPrice, maxPrice, zip, language);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonSearchAmazonProductsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
query string Search keywords
domain string Amazon marketplace TLD or code (com, co.uk, de…) [optional] [default to "com"]
page int? [optional] [default to 1]
sortBy string relevance price_low_to_high
category string Department/category alias (i= param) [optional]
minPrice decimal? [optional]
maxPrice decimal? [optional]
zip string Delivery postal/zip code for localized pricing [optional]
language string Locale for results, e.g. en_US, fr_FR [optional]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AmazonTodaySDeals

Object AmazonTodaySDeals (string domain = null, string category = null, int? page = null)

Today's deals

Current Amazon deals (lightning deals, best deals).

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class AmazonTodaySDealsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new AmazonApi(httpClient, config, httpClientHandler);
            var domain = "\"com\"";  // string |  (optional)  (default to "com")
            var category = "category_example";  // string |  (optional) 
            var page = 1;  // int? |  (optional)  (default to 1)

            try
            {
                // Today's deals
                Object result = apiInstance.AmazonTodaySDeals(domain, category, page);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AmazonApi.AmazonTodaySDeals: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the AmazonTodaySDealsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Today's deals
    ApiResponse<Object> response = apiInstance.AmazonTodaySDealsWithHttpInfo(domain, category, page);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AmazonApi.AmazonTodaySDealsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
domain string [optional] [default to "com"]
category string [optional]
page int? [optional] [default to 1]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]