Log in to see full request history

To utilize this endpoint, you will need to provide the product name you want to search for in the query parameter. In addition, you will also need to provide a category parameter in the body of the request.

The category parameter is used to filter the search results based on the category of the product. The allowed values for the category parameter are: Smartphones, Tablets, Smartwatches, Laptops, and Desktops. The category parameter is case-sensitive.

If you want to search for products in all categories, you can leave this parameter empty. To authenticate your requests, you will need to obtain an API Key from the dashboard.

Query Params
string
Defaults to iPhone 14

The query parameter for product name allows you to search for products by their name, version, machine ID or features. You can provide a partial or complete product name, and the API will return a list of products that match the search criteria.

string

Product category ex Smartphones, Tablets etc. Leave blank to search all categories

string

Product brand ex Apple, Samsung etc. Leave blank to search all brands

boolean
Defaults to true

when set to true, the attribute will maintain its original casing, while setting it to false will convert the attribute to lower case.

string

Machine ID for the product (optional)

string
required
Defaults to 0

Page number for pagination

string
Defaults to 10

Number of results per page

Headers
string
required

Your API ID can be obtained from your dashboard

string
required

Your API key can be obtained from your dashboard

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json