Skip to main content
POST
Amazon research
Specify the marketplace. Actions: search, product, keywords, keyword_volume, reviews, price_history offers, merchant_search and merchant_page. Quote the intended request; max_charge_usd rejects an over-budget Run before admission. Unknown values stay null. Record observed review pages and filters; a filtered sample is not population prevalence. Prices and shipping retain their defined series, currency and observation time. Cached offers are not verified checkout prices. Read the same authenticated result_url for pending results. Native evidence stays on each Run.

Headers

idempotency-key
string
required

Generate a new unique value (prefer a random UUID) for each independent lookup, even with identical parameters on the same day. Retry the same intended execution with its original key and parameters to retrieve the original Run without another Charge. Changing execution parameters with the same key returns 409; changing task_id or metadata does not start a new Run. Existing opaque keys remain valid for recovery.

Minimum string length: 1

Body

application/json

merchant_search: query, optional language; merchant_page: exact public url; search: query and optional page; product/reviews/offers: exact asin; reviews supports bounded review_pages, review_rating, review_sort, verified_only and review_keyword; keywords: query, optional language/limit/offset (us/en only); keyword_volume: explicit keywords and language; max_charge_usd rejects requests exceeding the caller cap before creating a Run; price_history: exact asin and optional days (default 180). Unsupported fields are rejected before charging. No listing edits, fee estimates or recurring monitoring.

action
enum<string>
required
Available options:
search,
product,
keywords,
keyword_volume,
reviews,
price_history,
offers,
merchant_search,
merchant_page
country
string
required

Explicit Amazon marketplace country. Supported: us, gb, de, fr, it, es, ca, jp, in, au. Related keywords supports us/en only; exact keyword_volume has its own exposed locale/language pairs.

Minimum string length: 1
provider
enum<string> | null

Default auto: select the first eligible Provider in Glasser's preference order. A named Provider must support the request and be allowed by your Key; it does not fall back to another Provider. Available values are listed below.

Available options:
auto,
serpapi,
dataforseo,
apify,
keepa,
serper
max_charge_usd
string | null

Exact USD decimal string (min 2, max 6 decimals, one canonical spelling). Sum with decimal arithmetic or scale by 10^6 — never floats.

Maximum string length: 20
Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
review_pages
integer | null
Required range: 1 <= x <= 10
review_rating
integer | null
Required range: 1 <= x <= 5
review_sort
enum<string> | null
Available options:
recent,
helpful
verified_only
boolean | null
review_keyword
string | null
Required string length: 1 - 200
url
string | null
Required string length: 1 - 2048
Pattern: ^https?:\/\/
query
string | null
Required string length: 1 - 200
keywords
string[] | null
Required array length: 1 - 1000 elements
Minimum string length: 1
asin
string | null
Pattern: ^[A-Z0-9]{10}$
page
integer | null
Required range: 1 <= x <= 20
limit
integer | null
Required range: 1 <= x <= 100
offset
integer | null
Required range: 0 <= x <= 10000
language
string | null
Minimum string length: 1
days
integer | null
Required range: x >= 1
task_id
string | null

Group related Runs, including automatic fallback, under one Task. Reuse a stable string and filter the Runs list by task to retrieve them.

metadata

Optional tracking fields, returned on the Run and available as filters. They never go to the Provider or affect routing, Price, or idempotency.

  • Up to 20 keys: lowercase letters, digits, and underscores; start with a letter; at most 40 characters.
  • Values: strings of 1–500 characters.
  • user_id: your End user's opaque ID, never their email address or name.

Invalid entries are dropped whole, not truncated. The request continues, and the Run returns the fields that were stored.

Response

Success

id
string
required
run_url
string
required

Open this Run in the console. Requires Workspace membership.

provider
string
required
Pattern: ^[a-z0-9][a-z0-9-]*$
endpoint
string
required
Pattern: ^\/.+$
endpoint_version
integer
required
status
enum<string>
required

QUEUED or RUNNING: still in progress. COMPLETED: a Provider response is available, including non-2xx responses. FAILED: read failure. STOPPED: stopped before dispatch. Read charge_usd separately from status.

Available options:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPED
failure
object | null
required

Why the Run failed. Non-null only when status is FAILED.

input
object
required
output
object
required
provider_response
object | null
required

Non-null only when status is COMPLETED.

  • For 2xx responses, output contains Provider-native JSON (any shape), or null for an empty body.
  • For non-2xx responses, error contains the Provider's error body and output is null.

Sensitive fields are removed from both bodies.

charge_usd
string | null
required

Historical total Charge of the listed Runs, including replayed or read Runs. Null until all listed Runs settle. This is not new spending by the current request; request_charge reports that separately. Failures can also be charged.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
charge_basis
object | null
required

Single-Run charge basis, or null for a multi-Run total. Read runs[].charge_basis for each charge.

stoppable
boolean
required

Whether a stop request can currently be accepted. This does not guarantee that the Run can stop before dispatch.

stop_requested_at
string<date-time> | null
required

When a stop was requested. The Run can still continue if dispatch had already started.

created_at
string<date-time>
required

ISO-8601 UTC timestamp

started_at
string<date-time> | null
required

ISO-8601 UTC timestamp

completed_at
string<date-time> | null
required

ISO-8601 UTC timestamp

task_id
string | null
required
metadata
object
required

Your stored tracking fields. Use them to filter Runs. They never go to the Provider or affect routing, Price, or idempotency.

  • Up to 20 keys: lowercase letters, digits, and underscores; start with a letter; at most 40 characters.
  • Values: strings of 1–500 characters.
  • user_id: your End user's opaque ID, never their email address or name.
action
enum<string>
required
Available options:
search,
product,
keywords,
keyword_volume,
reviews,
price_history,
offers,
merchant_search,
merchant_page
result_status
enum<string>
required
Available options:
success,
no_result,
error,
pending
error
object | null
required
runs
object[]
required
result_url
string
required

Authenticated, read-only URL path for polling this normalized result and total charge. Use with the API origin. Does not create Runs or resume fallback. GET /v1/runs/:id still returns the native, individual Run.

response_file
object

Complete large Provider body, delivered as a JSON file. Glasser applies a 32 MiB runtime resource guard to captured bodies and serialized files. body_field identifies the replaced field; output is null or provider_response.error is omitted. Download URLs expire after at most one hour. Authenticated Get Run refreshes the URL while the file is available, for 7 days. Reads and downloads do not execute or charge another Run. If state is link_pending, read the same Run to prepare the link without another execution or charge. The URL grants temporary read access: share it only with intended recipients.

review_invitation
object

Present at most once per Run, on the first delivery of some completed Runs. After you use this result for the task, submit a review as the instruction says, then continue. Optional; it never affects the Run or its charge.

request_charge
object

Request-scoped admission and Charge evidence. Record created_run_ids across the user's work, then count each settled Run once. Changing task_id does not turn an idempotent replay into a new Run. A result read has zero Charge and empty admission lists.