Skip to main content

A Python libray (and CLI) for Amazon order history

Project description

amazon-orders - A Python libray (and CLI) for Amazon order history

Version Python Versions Coverage Build Docs GitHub License

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. 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.

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.2.*, not ==4.2.1) 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

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_USERNAME
  • AMAZON_PASSWORD
  • AMAZON_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 Captcha auto-solve on Python <=3.12 (via the optional amazoncaptcha dependency), install with the captcha extra:

pip install amazon-orders[captcha]

Without this extra, Captcha challenges fall back to manual entry. amazoncaptcha is not available on Python 3.13+; see Captcha Blocking Login 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!

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

amazon_orders-4.2.1.tar.gz (50.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

amazon_orders-4.2.1-py3-none-any.whl (52.5 kB view details)

Uploaded Python 3

File details

Details for the file amazon_orders-4.2.1.tar.gz.

File metadata

  • Download URL: amazon_orders-4.2.1.tar.gz
  • Upload date:
  • Size: 50.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for amazon_orders-4.2.1.tar.gz
Algorithm Hash digest
SHA256 5aa3b5aea9befdb8be978dc7bf585b3b893cb398ac96f6579163ee9a9fe1e162
MD5 e806752c3fe18ca61d822115501cae69
BLAKE2b-256 09ec02954b785f739f62e24100258e6487000720be79d5e75a937fecde43cc3a

See more details on using hashes here.

File details

Details for the file amazon_orders-4.2.1-py3-none-any.whl.

File metadata

  • Download URL: amazon_orders-4.2.1-py3-none-any.whl
  • Upload date:
  • Size: 52.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for amazon_orders-4.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 42e2281f23a554f80300e1c325b15505ed2af5d28b9d9b627cc75f2a69550206
MD5 19b716e844f2ed428ced517180a7d5ed
BLAKE2b-256 645094b2873dc87614cabeea4d1890c7f422f62d5eff6d3ff34ade21e06cbb75

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page