ecommerce/amazon

Best-selling / trending product listings on Amazon, optionally within a category. Returns a normalized Product page.

The platform's own best-seller or trending ranking on Amazon. Pass a category when the platform ranks per category. Normalized to the Product object; page with next_cursor.

Fixed price: 4.4 credits per successful call, whichever provider serves it.

post/v2/ops/ecommerce.amazon.product.rank

Request

  • Base URL
    https://api.agentkey.app
  • URL
    https://api.agentkey.app/v2/ops/ecommerce.amazon.product.rank
  • Auth
    HTTP bearer

Request body

categorystring

Required on Amazon. Either the Best Sellers category path as in amazon.com/Best-Sellers-…/zgbs/<path> (electronics, toys-and-games, electronics/172456 …) or a numeric browse-node id (172282) for the category product listing sorted by best sellers.

country'US' | 'AU' | 'BR' | 'CA' | 'CN' | 'FR' | 'DE' | 'IN' | 'IT' | 'MX' | 'NL' | 'SG' | 'ES' | 'TR' | 'AE' | 'GB' | 'JP' | 'SA' | 'PL' | 'SE' | 'BE' | 'EG' | 'ZA' | 'IE'

Amazon marketplace, ISO 3166-1 alpha-2.

cursorstring

Opaque pagination cursor from the previous response's next_cursor. Send the same parameters with it.

fieldsstring[]

Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].

include_rawboolean

Attach the raw upstream payload as raw (not a stable contract; truncated above 256 KB).

limitinteger

Maximum number of products to return.

providerstring

Shorthand for routing.only = [provider].

Response

Success envelope

credits_chargednumber required

Credits charged for this call (the method's fixed price).

opstring required

Method name.

op_versioninteger required

Method version that served the call.

providerstring required

Provider that actually served the call.

rawunknown
raw_truncatedboolean
request_idstring required

Correlation id; quote it in support requests.

took_msinteger required
unsupported_fieldsstring[] required

Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

Changes

No recorded changes to this operation across all 1 revision of this API.