shopscout
Scrape any Shopify store - products, collections, pages & metadata from the public JSON API. No API key required.
Three interfaces: Python SDK, CLI, and REST API.
Installation
# Core SDK only
pip install shopscout
# With CLI (click + rich tables)
pip install shopscout[cli]
# With REST API (FastAPI + uvicorn)
pip install shopscout[api]
# Everything
pip install shopscout[all]
Quick Start
from shopscout import Shopify
shop = Shopify('spharetech.com')
# Store metadata
store = shop.store()
print(store.name, store.currency)
# All products (auto-paginated)
products = shop.products()
for p in products:
print(p.title, p.price, p.available)
# All collections
collections = shop.collections()
for c in collections:
print(c.title, c.products_count)
# Products in a specific collection
power_banks = shop.collection_products('power-banks')
# Single product
product = shop.product('66w-transparent-power-bank-20000mah')
# Pages
pages = shop.pages()
Pagination
Fetch everything at once or paginate manually — your choice.
shop = Shopify('spharetech.com')
# Auto-paginate: fetches ALL products in one call
all_products = shop.products()
# Manual pagination: fetch one page at a time
page1 = shop.products_page(page=1, limit=30)
page2 = shop.products_page(page=2, limit=30)
# Same for collection products
all_power_banks = shop.collection_products('power-banks')
first_page = shop.collection_products_page('power-banks', page=1, limit=10)
Exporting
from shopscout import Exporter, Shopify
shop = Shopify('spharetech.com')
products = shop.products()
exporter = Exporter(output_dir='output')
exporter.products_to_json(products)
exporter.products_to_csv(products)
Proxy Support
shop = Shopify('store.com', proxy='http://user:pass@host:port')
CLI
# Scrape products
shopscout products spharetech.com
shopscout products spharetech.com --collection power-banks
shopscout products spharetech.com --json
shopscout products spharetech.com --save products.csv
# Scrape collections
shopscout collections spharetech.com
# Store metadata
shopscout store spharetech.com
# With proxy
shopscout --proxy http://host:port products spharetech.com
REST API
# Start the API server
shopscout serve
shopscout serve --port 3000
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/products?domain=store.com |
All products |
| GET | /api/v1/products?domain=store.com&collection=power-banks |
Collection products |
| GET | /api/v1/products/{handle}?domain=store.com |
Single product |
| GET | /api/v1/collections?domain=store.com |
All collections |
| GET | /api/v1/store?domain=store.com |
Store metadata |
| GET | /api/v1/pages?domain=store.com |
All pages |
| GET | /health |
Health check |
Interactive docs at http://localhost:8000/docs
Error Handling
from shopscout import Shopify, StoreNotFoundError, ProductNotFoundError
shop = Shopify('not-a-shopify-store.com')
try:
store = shop.store()
except StoreNotFoundError:
print('Not a Shopify store')
try:
product = shop.product('nonexistent')
except ProductNotFoundError:
print('Product not found')
Exception Hierarchy
ShopifyError
├── StoreNotFoundError
├── ProductNotFoundError
├── CollectionNotFoundError
├── PageNotFoundError
├── RateLimitError
├── RequestError
└── ParsingError
Data Models
| Model | Description |
|---|---|
Store |
Store metadata (name, currency, counts) |
Product |
Product with variants, images, options |
Variant |
Pricing, stock, SKU, weight |
ProductImage |
Image URL with dimensions |
ProductOption |
Option name and values |
Collection |
Collection with image and product count |
Page |
Static page content |
All models have a .to_dict() method for serialization.
License
MIT
Metadata
Release files for shopscout 0.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| shopscout-0.2.2.tar.gz | 18.6 kB | With provenance | Details for shopscout-0.2.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| shopscout-0.2.2-py3-none-any.whl | Python 3 | none | any | Details for shopscout-0.2.2-py3-none-any.whl |
Total release size: 42.6 kB
Release files / shopscout-0.2.2.tar.gz
| Download URL | shopscout-0.2.2.tar.gz |
|---|---|
| Size | 18.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9924c2f5083add6890e72b05bb6ab68822472c48b143c8568077286aaa7a03f5
|
|
BLAKE2b-256 checksum How to use checksums |
ff14539cd5ce9b374ba97e0e1e6dff903d500d4b1d1b6d98e521ac3a82d4d730
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 24, 2026.
Transparency logRelease files / shopscout-0.2.2-py3-none-any.whl
| Download URL | shopscout-0.2.2-py3-none-any.whl |
|---|---|
| Size | 24.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2ab3c2e4f7465c7a4a11c3b9d6f75d5326d7e516ad7497c2edbae4639846b99d
|
|
BLAKE2b-256 checksum How to use checksums |
1511e937f546a98864a80a6ce5233e646dcb1107bd5db38aa40cfbc5fbf4d42b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 24, 2026.
Transparency logSecurity for shopscout 0.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for shopscout-0.2.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 24, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.