Skip to main content
POST
Target category products

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
category
string
required

Category (N-id or category URL). e.g. N-5xt3e

max_items
integer
default:25

Max items (up to 500)

Required range: 1 <= x <= 500
start_page
integer

Starting page

Required range: x >= 1
sort
enum<string>

Sort by. Options: featured = Featured, price_low = Price: low to high, price_high = Price: high to low, rating = Highest rated, bestselling = Best selling, newest = Newest

Available options:
featured,
price_low,
price_high,
rating,
bestselling,
newest

Response

Run completed.

session_id
string

Session identifier for this run.

kind
string

Data source identifier for this endpoint.

category
string
category_id
string
sort
string
max_items
integer
start_page
integer
partial
boolean

True when the scrape stopped early and returned the records collected so far.

human
string

Markdown summary of the result, for display.

machine
object

Structured result payload.

total_points
integer

Points charged for this run.