Skip to content

Common Request Fields

Every Real-Time API request needs the same four parameters plus the identifier of the operation you call. This page describes those fields, the optional parameters that several operations share, and the rules for formatting values. Each operation's request page lists the parameters it accepts; output is accepted by every operation and is not repeated there.

Required parameters

ParameterTypeRequiredDescription
api_keystringYesYour API key, sent as a query parameter. Find it at https://app.easyparser.com/account/plan.
platformstringYesTarget platform. Allowed: AMZ (Amazon).
operationstringYesOperation code in upper case. Allowed: DETAIL, OFFER, SALES_ANALYSIS_HISTORY, BEST_SELLERS_RANK, PACKAGE_DIMENSION, SEARCH, PRODUCT_LOOKUP, SELLER_PROFILE, SELLER_PRODUCTS, SELLER_FEEDBACK, SIMILAR_PRODUCTS.
domainstringYesAmazon marketplace, written with a leading dot. Example: .com, .co.uk, .de. See Supported Marketplaces.

When you send a url or an address_id, use the domain of that URL or address. For example, a url on amazon.co.uk goes with domain=.co.uk.

Operation identifiers

Each operation also needs an identifier that tells it which product, search or seller to fetch. Where an operation accepts two identifiers, send exactly one of them. For example, DETAIL rejects a request that sends both asin and url.

OperationCodeIdentifier
DetailDETAILasin or url (product URL)
OfferOFFERasin
Sales Analysis and HistorySALES_ANALYSIS_HISTORYasin
Best Sellers RankBEST_SELLERS_RANKasin
Package DimensionPACKAGE_DIMENSIONasin
Similar ProductsSIMILAR_PRODUCTSasin
SearchSEARCHkeyword or url (search URL)
Product LookupPRODUCT_LOOKUPidentifier_type and identifier
Seller ProfileSELLER_PROFILEseller_id or url (seller profile URL)
Seller ProductsSELLER_PRODUCTSseller_id or url (storefront URL)
Seller FeedbackSELLER_FEEDBACKseller_id or url (seller profile URL)

The identifier parameters and their formats are below. Conditional means the parameter is required for the operations that take it, as listed in the table above.

ParameterTypeRequiredDescription
asinstringConditionalAmazon product ID: 10 upper-case letters or digits, for example B0CJB6V2L5.
urlstringConditionalFull Amazon URL of the product, search results page or seller page, depending on the operation. URL-encode it.
keywordstringConditionalSearch term for SEARCH. Maximum 255 characters.
seller_idstringConditionalAmazon seller ID: starts with A, 11 to 15 characters, for example A1MCYUGJD2ILFU. It is the seller= or me= value in an Amazon seller URL.
identifier_typestringConditionalType of identifier for PRODUCT_LOOKUP. Allowed: ASIN, EAN, GTIN, ISBN, JAN, MINSAN, UPC.
identifierstringConditionalValue to look up with PRODUCT_LOOKUP. Maximum 18 characters. Keep leading zeros.

You can read the asin and the seller_id from Amazon URLs: the ASIN follows /dp/ in a product URL, and the seller ID is the seller= value of a seller page URL.

Shared optional parameters

These parameters work the same way on every operation that accepts them. The Description column lists those operations.

ParameterTypeRequiredDescription
languagestringNoLanguage of the returned content, as a locale code valid for the domain, for example en_US. Operations: DETAIL, OFFER, SEARCH, SELLER_PROFILE, SELLER_PRODUCTS. Default: marketplace default.
currencystringNoCurrency of returned prices, as a lower-case ISO 4217 code valid for the domain, for example usd. Case-sensitive: USD returns HTTP 400. Operations: DETAIL, OFFER, SEARCH, SELLER_PRODUCTS. Default: marketplace default.
address_idintegerNoID of an Active saved address for the same domain. Operations: DETAIL, OFFER, SEARCH, SELLER_PRODUCTS. Default: marketplace default address.
zip_codestringNoInline delivery address: zip or postal code. Join two-part codes with a comma, for example N0E,1Y0. Operations: same as address_id.
citystringNoInline delivery address: city. Required with zip_code on .com.au and with district on .ae; send it alone on .sa and .eg. Operations: same as address_id.
districtstringNoInline delivery address: area within city. Only on .ae, together with city. Operations: same as address_id.
country_codestringNoInline delivery address: ISO 3166 alpha-2 country code, for example CA. Operations: same as address_id.
associate_idstringNoAmazon Associates tag added to product links in the response, for example mytag-20. Operations: DETAIL, OFFER, SEARCH, SELLER_PROFILE, SELLER_PRODUCTS.
parametersstringNoExtra Amazon URL query parameters, URL-encoded as one value, for example tag%3Dmytag-20%26ref%3Dcustom for tag=mytag-20&ref=custom. Separate pairs with an encoded & (%26); semicolons do not work. Operations: same as associate_id.
cookiestringNoCookies forwarded to Amazon in the HTTP Cookie header: key=value pairs separated by ;, URL-encoded as one value. Operations: same as associate_id.
outputstringNoResponse format. Accepted by every operation; you do not need to send it. Default: json. Allowed: json.
operation_versionintegerNoVersion of a versioned operation. Operations: BEST_SELLERS_RANK only, where 2 is the Live version since November 1, 2026 and 1 is the legacy version. Default: 2. Allowed: 1, 2. See Operation Versioning.

Valid language and currency values differ by marketplace; see Supported Marketplaces. A language the marketplace does not offer returns MSG1015 (Invalid language for domain).

You can set the delivery address in two ways: address_id for an address saved in the web app, or the inline fields zip_code, city, district and country_code. Inline fields take precedence over address_id and raise the server-side timeout from 15 to 45 seconds. Operations not listed above do not support an address. See Address Management for formats per marketplace.

Pagination

OFFER, SEARCH, SELLER_PRODUCTS and SELLER_FEEDBACK return results in pages. You choose a window of pages with min_page and max_page. SEARCH, SELLER_PRODUCTS and SELLER_FEEDBACK also accept a single page instead of the window.

ParameterTypeRequiredDescription
min_pageintegerNoFirst page to fetch. Default: 1. Allowed: 1 to 400.
max_pageintegerNoLast page to fetch. Must be greater than or equal to min_page, and one request covers at most 5 pages. Default: 1. Allowed: 1 to 400.
pageintegerNoOne results page to fetch, as an alternative to min_page and max_page. Operations: SEARCH, SELLER_PRODUCTS, SELLER_FEEDBACK. Send either page or min_page and max_page, not both. Default: 1.
  • One request can fetch at most 5 pages: max_page - min_page + 1 must be 5 or less.
  • Every requested page is charged, even when it has no results. Read the pagination details of a first request before you ask for more pages.
  • The window can start after page 5. For example, min_page=6&max_page=10 fetches pages 6 to 10.
  • A max_page lower than min_page returns MSG1010 (Maximum page count must be more than minimum page count).

Formatting rules

  • Send operation codes in upper case (PRODUCT_LOOKUP, not product_lookup).
  • Write domain with a leading dot (.com, not com).
  • URL-encode every value that contains spaces or reserved characters, for example keyword=wireless%20earbuds.
  • Leave out parameters you do not use. Do not send empty or null values.
  • Send boolean options only when you enable them, as =true (for example a_plus_content=true).