amazon-orders is an unofficial library that provides a Python API (and CLI) for Amazon order history.
This package works by parsing data from Amazon's consumer-facing website. A periodic build validates functionality to ensure its stability, but as Amazon provides no official API to use, this package may break at any time (so check often to ensure you're on the latest version).
Only the English, .com version of Amazon is officially supported.
amazon-orders is available on PyPI and can be installed and/or upgraded using pip:
pip install amazon-orders --upgradeThat's it! amazon-orders is now available as a package to your Python projects and from the command line.
If pinning, be sure to use a wildcard for the minor version (ex. ==4.0.*, not ==4.0.8) to
ensure you always get the latest stable release.
You'll use AmazonSession to
authenticate your Amazon account, then AmazonOrders
and AmazonTransactions
to interact with account data. get_order_history
and get_order are good places to start.
from amazonorders.session import AmazonSession
from amazonorders.orders import AmazonOrders
amazon_session = AmazonSession("<AMAZON_EMAIL>",
"<AMAZON_PASSWORD>")
amazon_session.login()
amazon_orders = AmazonOrders(amazon_session)
orders = amazon_orders.get_order_history(year=2023)
for order in orders:
print(f"{order.order_number} - {order.grand_total}")If the fields you're looking for aren't populated with the above, set full_details=True (or pass --full-details to
the history CLI command), since by default it is False (enabling it slows down querying, since an additional
request for each order is necessary). Have a look at the Order entity's docs to see what fields are only
populated with full details.
You can also run any command available to the main Python interface from the command line:
amazon-orders login
amazon-orders history --year 2023Authentication can be automated by (in order of precedence) storing credentials in environment variables, passing them
to AmazonSession, or storing them
in AmazonOrdersConfig. The
environment variables amazon-orders looks for are:
AMAZON_USERNAMEAMAZON_PASSWORDAMAZON_OTP_SECRET_KEY(see docs for usage)
For more advanced usage, amazon-orders's official documentation is available
at Read the Docs.
If you would like to get involved, be sure to review the Contribution Guide.
Want to contribute financially? If you've found amazon-orders
useful, sponsorship would
also be greatly appreciated!
