Skip to main content
GET
Amazon: Get listing keywords

Request contract

  • Method and path: GET /apis/v1/commerce/amazon/listings/{country}/{listing_id}/keywords
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/keywords
  • country: path; required
  • listing_id: path; required
  • q: query; optional
  • language: query; required
  • cursor: query; optional
  • page_size: query; optional
  • period: query; optional
  • date: query; optional
  • keyword_flags: query; optional
  • sort_by: query; optional
  • sort_order: query; optional
  • fields: query; optional
  • provenance: query; optional
  • Runtime facts: e4ea23246d148272326d4d18f79f43b8fa99cd58edd96f4f3759a860c1c99cf8
Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

Cost and request rules

A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Authorizations

Authorization
string
header
required

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

Path Parameters

country
enum<string> | null
required

Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB, not UK). See the enum for supported countries.

Available options:
AE,
AU,
BR,
CA,
DE,
ES,
FR,
GB,
IT,
JP,
MX,
SA,
US
listing_id
string | null
required

Native product ID on the platform.

Query Parameters

q
string | null

Search keywords.

language
string | null
required

Result language as a BCP 47 tag, such as en, en-US, or zh-Hans.

cursor
string | null

Pass the previous response's next_cursor unchanged. Omit for the first page. A null next_cursor indicates the end of pagination.

page_size
string | null
default:20

Number of items per page. Use an unpadded decimal integer from 10 to 100; omit for the default 20.

Pattern: ^(?:[1-9][0-9]|100)$
period
enum<string> | null

Reporting window. 1d, 7d, 30d, and 90d are rolling windows ending at the latest update; calendar_month and calendar_week select the calendar period identified by date. See the enum for supported values. Defaults to the last 7 days.

Available options:
30d,
7d,
calendar_month,
calendar_week
date
string<date> | null

Date identifying a calendar period, in YYYY-MM-DD format. See operation-specific notes for the required day of the week or month. For calendar_month, use YYYY-MM or any date in the month; for calendar_week, use the start date of that week. Omit date for 7d and 30d.

keyword_flags
(enum<string> | null)[] | null

Comma-separated keyword flags; results must match all supplied flags. organic: organic ranking; sponsored_product_ad: sponsored product ad; sponsored_brand_ad: brand ad; sponsored_video_ad: video ad; amazons_choice: Amazon's Choice keyword; precise: precise keyword; precise_long_tail: precise long-tail keyword; purchase: purchase keyword; quality: quality keyword; stable: stable keyword; lost: lost keyword; invalid: invalid keyword; multi_variant: multiple variants; search_volume_up/search_volume_down: increasing/decreasing search volume. These labels reflect the source's classifications.

Available options:
amazons_choice,
invalid,
lost,
multi_variant,
organic,
precise,
precise_long_tail,
purchase,
quality,
search_volume_down,
search_volume_up,
sponsored_brand_ad,
sponsored_product_ad,
sponsored_video_ad,
stable
sort_by
enum<string> | null

Sort key. Usually an output field name; operation-specific notes explain keys that do not correspond to an output field. organic_rank and ad_rank correspond to output fields. estimated_search_volume sorts by estimated volume within the window; search_rank by keyword popularity rank; updated_at by the source row update time. The latter three have no same-named output fields.

Available options:
ad_rank,
estimated_search_volume,
organic_rank,
search_rank,
updated_at
sort_order
enum<string> | null

Sort direction: asc or desc. Requires sort_by.

Available options:
asc,
desc
fields
enum<string>[] | null

Comma-separated business field paths to return. Omit to use this operation's default field selection. The enum includes all fields of the shared item type. Some are populated only by other operations on the same platform; selecting them here does not supply missing data. Field selection trims output only and does not reduce source calls or charges.

Available options:
ad_rank,
competing_products,
estimated_search_volume,
estimated_search_volume_broad,
estimated_search_volume_exact,
keyword_popularity_rank,
organic_rank,
relation.listing_id,
relation_type,
supply_demand_ratio,
title,
traffic_share
provenance
enum<string> | null
default:compact

compact (default) returns value and source per field. Shared collection time, license, origin, and value_type are grouped in meta.sources; differing values retain their own metadata. full returns complete per-value provenance, including precision and confidence.

Available options:
compact,
full

Response

Success

items
(object | null)[] | null
meta
object | null
missing
(object | null)[] | null
next_cursor
string | null