Product Search API Documentation

Endpoints

/product_search

GET

Search for products by title, country and domain filter.

Parameters:

1. product_title : string (required)
   • Title of the product you want to search.
2. country_code : string (optional)
   • The country where you want to search the product. Default value is ‘United States’.
3. exclude_domains : string (optional)
   • Domains you want to exclude from the search. Multiple domains should be comma separated.

Request:

GET /product_search?product_title=jacket&country_code=Australia&exclude_domains=amazon.com,walmart.com

Response:

[
    {
        "url": "https://mywebsite.com/product1",
        "price":"100.0"
    },
    {
        "url": "https://mywebsite.com/product2",
        "price":"unable_to_scrape"
    },
    {
        "url": "https://mywebsite.com/product3",
        "price":"invalid_currency"
    },
    ...
]

Response is an array of dictionary values where each dictionary has the url of the product and its price.

Price can have 3 types of values:

• A float value which denotes the price of the product.
• “unable_to_scrape” if the price couldn’t be scraped from the product page.
• “invalid_currency” if the currency on the product price doesn’t match the provided country’s currency.

Error Handling

1. If the product_title is missing in the request, a 422 Unprocessable Entity error will be returned with an error message.
2. If the country_code provided in not valid, the products might not be found and the response could be an empty array.
3. If the exclude_domains provided are not valid or not properly formatted (comma separated), they will not be excluded from the search and might appear in the response.
4. If any internal server error occurs, a 500 Internal Server Error will be returned.

Rate Limiting

There is no rate limiting on the request unless you are on the free plan. However, heavy traffic might slow down the response time.

License

Use of this API is subjected to the standard API usage terms and conditions.

Support

For any queries or issues, drop an email at
stephanyazvinski@gmail.com

Version

1.0.0