Skip to main content

ProductAdvertisingAPI 5.0 Python SDK

Project description

Product Advertising API 5.0 SDK for Python

pypi version pypi downloads

This repository contains the official Product Advertising API 5.0 Python SDK called paapi5-python-sdk that allows you to access the Product Advertising API from your Python app.


Python 2.7 and 3.4+

Installation & Usage

pip install

You can directly install it from pip using:

pip install paapi5-python-sdk

Or, you may also install directly from Github

pip install git+

(you may need to run pip with root permission: sudo pip install git+

Then import the package:

import paapi5_python_sdk 


Install via Setuptools.

python install --user

(or sudo python install to install the package for all users)

Then import the package:

import paapi5_python_sdk

Getting Started

Please follow the installation procedure and then run the following:

Simple example for SearchItems to discover Amazon products with the keyword 'Harry Potter' in Books category:

from paapi5_python_sdk.api.default_api import DefaultApi
from paapi5_python_sdk.models.partner_type import PartnerType
from import ApiException
from paapi5_python_sdk.models.search_items_request import SearchItemsRequest
from paapi5_python_sdk.models.search_items_resource import SearchItemsResource

def search_items():

    """ Following are your credentials """
    """ Please add your access key here """
    access_key = "<YOUR ACCESS KEY>"

    """ Please add your secret key here """
    secret_key = "<YOUR SECRET KEY>"

    """ Please add your partner tag (store/tracking id) here """
    partner_tag = "<YOUR PARTNER TAG>"

    """ PAAPI host and region to which you want to send request """
    """ For more details refer:"""
    host = ""
    region = "us-east-1"

    """ API declaration """
    default_api = DefaultApi(
        access_key=access_key, secret_key=secret_key, host=host, region=region

    """ Request initialization"""

    """ Specify keywords """
    keywords = "Harry Potter"

    """ Specify the category in which search request is to be made """
    """ For more details, refer: """
    search_index = "Books"

    """ Specify item count to be returned in search result """
    item_count = 1

    """ Choose resources you want from SearchItemsResource enum """
    """ For more details, refer: """
    search_items_resource = [

    """ Forming request """
        search_items_request = SearchItemsRequest(
    except ValueError as exception:
        print("Error in forming SearchItemsRequest: ", exception)

        """ Sending request """
        response = default_api.search_items(search_items_request)

        print("API called Successfully")
        print("Complete Response:", response)

        """ Parse response """
        if response.search_result is not None:
            print("Printing first item information in SearchResult:")
            item_0 = response.search_result.items[0]
            if item_0 is not None:
                if item_0.asin is not None:
                    print("ASIN: ", item_0.asin)
                if item_0.detail_page_url is not None:
                    print("DetailPageURL: ", item_0.detail_page_url)
                if (
                    item_0.item_info is not None
                    and item_0.item_info.title is not None
                    and item_0.item_info.title.display_value is not None
                    print("Title: ", item_0.item_info.title.display_value)
                if (
                    item_0.offers is not None
                    and item_0.offers.listings is not None
                    and item_0.offers.listings[0].price is not None
                    and item_0.offers.listings[0].price.display_amount is not None
                        "Buying Price: ", item_0.offers.listings[0].price.display_amount
        if response.errors is not None:
            print("\nPrinting Errors:\nPrinting First Error Object from list of Errors")
            print("Error code", response.errors[0].code)
            print("Error message", response.errors[0].message)

    except ApiException as exception:
        print("Error calling PA-API 5.0!")
        print("Status code:", exception.status)
        print("Errors :", exception.body)
        print("Request ID:", exception.headers["x-amzn-RequestId"])

    except TypeError as exception:
        print("TypeError :", exception)

    except ValueError as exception:
        print("ValueError :", exception)

    except Exception as exception:
        print("Exception :", exception)


Complete documentation, installation instructions, and examples are available here.


This SDK is distributed under the Apache License, Version 2.0, see LICENSE.txt and NOTICE.txt for more information.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for qempo-paapi5-python-sdk, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size qempo_paapi5_python_sdk-1.0.0-py3-none-any.whl (187.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size qempo-paapi5-python-sdk-1.0.0.tar.gz (58.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page