amazon-orders is an unofficial library that provides a Python API (and CLI) for Amazon order history, line items, and transactions.
Only the English, .com version of Amazon is officially supported. Other Amazon domains can be
targeted by passing domain to AmazonSession
(or --domain on the CLI), and other English-based sites may work by chance — see
Known Limitations for details.
Note: 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, older versions of this package may break at any time, so it's recommended that you use the latest version.
Installation
amazon-orders is available on PyPI and can be installed and/or upgraded using pip:
pip install amazon-orders --upgrade
That'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.7.*, not ==4.7.0) to
ensure you always get the latest stable release.
Basic Usage
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)
# Get orders from a specific year
orders = amazon_orders.get_order_history(year=2023)
# Or use time filters for recent orders
orders = amazon_orders.get_order_history(time_filter="last30") # Last 30 days
orders = amazon_orders.get_order_history(time_filter="months-3") # Past 3 months
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.
Command Line Usage
You can also run any command available to the main Python interface from the command line:
amazon-orders login
amazon-orders history --year 2023
amazon-orders history --last-30-days
amazon-orders history --last-3-months
Pass --output to get json, yaml, or csv instead of the default text:
amazon-orders history --year 2023 --output json > orders.json
amazon-orders history --last-30-days --output csv > orders.csv
See Output Formats for details, including
to_dict().
Automating Authentication
Authentication 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)
To enable WAF auto-solve via a third-party integration, install with the relevant extra:
pip install amazon-orders[capsolver]
pip install amazon-orders[anticaptcha]
pip install amazon-orders[2captcha]
See Solving WAF Challenges for details.
To enable browser-based challenge handling (ACIC and JavaScript bot-detection pages) via
a headless browser, install with the browser extra:
pip install amazon-orders[browser]
playwright install chromium
See Browser Automation for details.
For legacy Captcha auto-solve on Python <=3.12, install with captcha extra:
pip install amazon-orders[captcha]
See Login Challenges for details.
Documentation
For more advanced usage, amazon-orders's official documentation is available
at Read the Docs.
Contributing
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!
1 maintainer
Metadata
1 maintainer
Release files for amazon-orders 4.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| amazon_orders-4.7.0.tar.gz | 75.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| amazon_orders-4.7.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 151.6 kB
Release files / amazon_orders-4.7.0.tar.gz
| Download URL | amazon_orders-4.7.0.tar.gz |
|---|---|
| Size | 75.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bf787a73f69bbcc773f5fc077e2edb07f2860cbab12b4cf2b57ff00f4b2c4965
|
|
BLAKE2b-256 checksum How to use checksums |
259f7d936357d6833e33b02a3b17a0c017e888b1c5a02effdee18eb88c9d64d4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / amazon_orders-4.7.0-py3-none-any.whl
| Download URL | amazon_orders-4.7.0-py3-none-any.whl |
|---|---|
| Size | 76.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
44513ad85e4e564ebc9846ed812ff162bd607e2f7da3d4213b4731ec0936b017
|
|
BLAKE2b-256 checksum How to use checksums |
a57d59083d73b9905b43bce9a38f6e209ee16393c459482ed9a1363805d7da72
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
