AmazonApi Module

This is the main class that provides authentication and methods for accessing the Amazon Product Advertising API. Instance it with your credentials and configuration.

class amazon_paapi.api.AmazonApi(key, secret, tag, country, throttling=1)

Bases: object

Provides methods to get information from Amazon using your API credentials.

Parameters:

  • key (str) – Your API key.

  • secret (str) – Your API secret.

  • tag (str) – Your affiliate tracking id, used to create the affiliate link.

  • country (CountryCode) – Country code for your affiliate account. Use values from models.Country, e.g. Country.ES.

  • throttling (float, optional) – Wait time in seconds between API calls. Use it to avoid reaching Amazon limits. Defaults to 1 second.

Raises:

InvalidArgumentException –

get_browse_nodes(browse_node_ids, languages_of_preference=None, **kwargs)

Return the specified browse node’s information.

Information includes name, children, and ancestors.

Parameters:

  • browse_node_ids (list[str]) – List of browse node ids. A browse node id is a unique ID assigned by Amazon that identifies a product category/sub-category.

  • languages_of_preference (list[str], optional) – Languages in order of preference in which the item information should be returned.

  • kwargs (dict, optional) – Other arguments to be passed to the Amazon API.

Returns:

A list of browse nodes.

Return type:

list[models.BrowseNode]

Raises:

  • InvalidArgumentException –

  • MalformedRequestException –

  • ApiRequestException –

  • ItemsNotFoundException –

get_items(items, condition=None, merchant=None, currency_of_preference=None, languages_of_preference=None, include_unavailable=False, **kwargs)

Get items information from Amazon.

Parameters:

  • items (str | list[str]) – One or more items, using ASIN or product URL. Items in string format should be separated by commas.

  • condition (models.Condition, optional) – Filters offers by condition type. Defaults to Any.

  • merchant (models.Merchant, optional) – Filters search results to return items having at least an offer sold by target merchant. Defaults to All.

  • currency_of_preference (str, optional) – Currency of preference in which the prices information should be returned. Expected currency code format is ISO 4217.

  • languages_of_preference (list[str], optional) – Languages in order of preference in which the item information should be returned.

  • include_unavailable (bool, optional) – The returned list includes not available items. Not available items have the ASIN and item_info equals None. Defaults to False.

  • kwargs (dict, optional) – Other arguments to be passed to the Amazon API.

Returns:

A list of items with Amazon information.

Return type:

list[models.Item]

Raises:

  • InvalidArgumentException –

  • MalformedRequestException –

  • ApiRequestException –

  • ItemsNotFoundException –

get_variations(asin, variation_count=None, variation_page=None, condition=None, currency_of_preference=None, languages_of_preference=None, merchant=None, **kwargs)

Return a set of items that are the same product but differ by theme.

Items can differ by size, color, or other variation attributes. A variation is a child ASIN.

Parameters:

  • asin (str) – One item, using ASIN or product URL.

  • variation_count (int, optional) – Number of items returned. Should be between 1 and 10. Defaults to 10.

  • variation_page (int, optional) – The specific page of items to be returned from the available results. Should be between 1 and 10. Defaults to 1.

  • condition (models.Condition, optional) – Filters offers by condition type. Defaults to Any.

  • currency_of_preference (str, optional) – Currency of preference in which the prices information should be returned. Expected currency code format is ISO 4217.

  • languages_of_preference (list[str], optional) – Languages in order of preference in which the item information should be returned.

  • merchant (models.Merchant, optional) – Filters search results to return items having at least an offer sold by target merchant. Defaults to All.

  • kwargs (dict, optional) – Other arguments to be passed to the Amazon API.

Returns:

Variations result containing the items list.

Return type:

models.VariationsResult

Raises:

  • InvalidArgumentException –

  • MalformedRequestException –

  • ApiRequestException –

  • ItemsNotFoundException –

search_items(item_count=None, item_page=None, actor=None, artist=None, author=None, brand=None, keywords=None, title=None, availability=None, browse_node_id=None, condition=None, currency_of_preference=None, delivery_flags=None, languages_of_preference=None, merchant=None, max_price=None, min_price=None, min_saving_percent=None, min_reviews_rating=None, search_index=None, sort_by=None, **kwargs)

Search for items on Amazon based on a search query.

At least one of the following parameters should be specified: keywords, actor, artist, author, brand, title, browse_node_id or search_index.

Parameters:

  • item_count (int, optional) – Number of items returned. Should be between 1 and 10. Defaults to 10.

  • item_page (int, optional) – The specific page of items to be returned from the available results. Should be between 1 and 10. Defaults to 1.

  • actor (str, optional) – Actor name associated with the item.

  • artist (str, optional) – Artist name associated with the item.

  • author (str, optional) – Author name associated with the item.

  • brand (str, optional) – Brand name associated with the item.

  • keywords (str, optional) – A word or phrase that describes an item.

  • title (str, optional) – Title associated with the item.

  • availability (models.Availability, optional) – Filters available items on Amazon. Defaults to Available.

  • browse_node_id (str, optional) – A unique ID assigned by Amazon that identifies a product category or subcategory.

  • condition (models.Condition, optional) – Filters offers by condition type. Defaults to Any.

  • currency_of_preference (str, optional) – Currency of preference in which the prices information should be returned. Expected currency code format is ISO 4217.

  • delivery_flags (list[str]) – Filters items which satisfy a certain delivery program.

  • languages_of_preference (list[str], optional) – Languages in order of preference in which the item information should be returned.

  • merchant (models.Merchant, optional) – Filters search results to return items having at least an offer sold by target merchant. Defaults to All.

  • max_price (int, optional) – Filters search results to items with at least one offer price below the specified value. Prices appear in lowest currency denomination. For example, $31.41 should be passed as 3141 or 28.00€ should be 2800.

  • min_price (int, optional) – Filters search results to items with at least one offer price above the specified value. Prices appear in lowest currency denomination. For example, $31.41 should be passed as 3141 or 28.00€ should be 2800.

  • min_saving_percent (int, optional) – Filters search results to items with at least one offer having saving percentage above the specified value. Value should be positive integer less than 100.

  • min_reviews_rating (int, optional) – Filters search results to items with customer review ratings above specified value. Value should be positive integer less than 5.

  • search_index (str, optional) – Indicates the product category to search. Defaults to All.

  • sort_by (models.SortBy, optional) – The way in which items are sorted.

  • kwargs (dict, optional) – Other arguments to be passed to the Amazon API.

Returns:

The search result containing the list of items.

Return type:

models.SearchResult

Raises:

  • InvalidArgumentException –

  • MalformedRequestException –

  • ApiRequestException –

  • ItemsNotFoundException –