Skip to main content

aioscraper

aioscraper logo

Python GitHub License PyPI - Version PyPI - Downloads GitHub Actions Workflow Status codecov Read the Docs GitHub last commit

High-performance asynchronous Python framework for large-scale API data collection.

API-first. aioscraper orchestrates thousands of concurrent JSON/REST calls with adaptive rate limiting, retries, priority queues and item pipelines. Selectors and a crawling engine are not part of the core - plug in your own parser if you need one (see examples/quotes.py).

Beta notice: APIs and behavior may change; expect sharp edges while things settle.

Table of Contents

What is aioscraper?

aioscraper is an async Python framework designed for mass data collection from APIs and external services at scale.

Built for:

  • Fetching data from hundreds/thousands of REST API endpoints concurrently
  • Integrating multiple external services (payment gateways, analytics APIs, etc.)
  • Building data aggregation pipelines from heterogeneous API sources
  • Queue-based scraping workers consuming tasks from Redis/RabbitMQ
  • Microservice fan-out requests with automatic rate limiting and retries

NOT built for:

  • Parsing HTML/CSS (but nothing stops you from using BeautifulSoup if you want - see examples/quotes.py)
  • Single API requests (use httpx or aiohttp directly)
  • GraphQL or WebSocket scraping (different paradigm)

Think: "I need to fetch data from 10,000 product API endpoints" or "I need to poll 50 microservices every minute" → aioscraper is for you.

Key Features

  • Async-first core with pluggable HTTP backends (aiohttp/httpx/httpx2) and aiojobs scheduling
  • Declarative flow: requests → callbacks → pipelines, with middleware hooks at each stage
  • Priority queueing with backpressure, a global concurrency limit and per-group rate limits
  • Adaptive rate limiting with EWMA + AIMD algorithm - automatically backs off on server overload
  • Small, explicit API that is easy to test and compose with existing async applications

Installation

Choose your HTTP backend:

# Option 1: Use aiohttp (recommended for most cases)
pip install "aioscraper[aiohttp]"

# Option 2: Use httpx (if you prefer httpx ecosystem)
pip install "aioscraper[httpx]"

# Option 3: Use httpx2, the Pydantic-maintained fork of httpx
pip install "aioscraper[httpx2]"

# Option 4: Install several backends for flexibility
pip install "aioscraper[aiohttp,httpx,httpx2]"

Quick Start

Create scraper.py:

import logging
from aioscraper import AIOScraper, Request, Response, SendRequest, Pipeline
from dataclasses import dataclass

logger = logging.getLogger("github_repos")
scraper = AIOScraper()


@dataclass(slots=True)
class RepoStats:
    """Data model for extracted repository stats."""

    name: str
    stars: int
    language: str


# this decorator registers this pipeline to handle RepoStats items
@scraper.pipeline(RepoStats)
class StatsPipeline:
    """Pipeline for processing extracted repository data."""

    def __init__(self):
        self.total_stars = 0

    async def put_item(self, item: RepoStats) -> RepoStats:
        """
        Called for each extracted item.

        This is where you'd:
        - Save to database
        - Send to message queue
        - Perform validation/transformation
        - Aggregate statistics
        """
        self.total_stars += item.stars
        logger.info("✓ %s: ⭐ %s (%s)", item.name, item.stars, item.language)
        return item

    async def close(self):
        """
        Called when scraper shuts down.

        Use for:
        - Final aggregations
        - Closing database connections
        - Cleanup operations
        """
        logger.info("Total stars collected: %s", self.total_stars)


# this decorator marks this as the scraper's entry point.
@scraper
async def get_repos(send_request: SendRequest):
    """
    Entry point: defines what to scrape.

    Receives send_request - a function to schedule HTTP requests.
    """
    repos = (
        "django/django",
        "fastapi/fastapi",
        "pallets/flask",
        "encode/httpx",
        "aio-libs/aiohttp",
    )

    for repo in repos:
        await send_request(
            Request(
                url=f"https://api.github.com/repos/{repo}",  # API endpoint
                callback=parse_repo,  # Success handler
                errback=on_failure,  # Error handler (network failures, timeouts)
                cb_kwargs={"repo": repo},  # Additional arguments to pass to callbacks
                headers={"Accept": "application/vnd.github+json"},  # Required by GitHub API
            )
        )


async def parse_repo(response: Response, pipeline: Pipeline):
    """
    Success callback: parse response and extract data.

    The `pipeline` dependency is automatically injected by aioscraper.
    """
    data = await response.json()  # Parse JSON response from API
    await pipeline(  # Send extracted item to pipeline
        RepoStats(
            name=data["full_name"],
            stars=data["stargazers_count"],
            language=data.get("language", "Unknown"),
        )
    )


async def on_failure(exc: Exception, repo: str):
    """
    Error callback: handle request/processing failures.

    Use for:
    - Logging errors
    - Sending alerts
    - Custom retry logic
    """
    logger.error("%s: cannot parse response: %s", repo, exc)

Run it:

aioscraper scraper

What's happening?

  1. @scraper registers your entry point
  2. @scraper.pipeline registers a pipeline for processing extracted data
  3. send_request() schedules multiple API requests concurrently with automatic queuing
  4. callback=parse_repo processes successful responses, errback=on_failure handles errors

Recommendation:

Configure retries, rate limiting, concurrency via environment variables for production use.

Examples

See the examples/ directory for fully commented code demonstrating.

Why aioscraper?

vs Scrapy:

  • Scrapy is built for HTML scraping with CSS/XPath selectors and website crawling
  • aioscraper is optimized for API data collection (JSON, REST, microservices)
  • Native asyncio (no Twisted), modern type hints, minimal footprint
  • Easily embeds into existing async applications

vs httpx/aiohttp directly:

  • Manual approach: you handle rate limiting, retries, queuing, concurrency, backpressure
  • aioscraper: adaptive rate limits, priority queues, pipelines, middleware out of the box
  • Declarative Request → callback → pipeline instead of imperative control flow

vs building custom async workers:

  • Less boilerplate: focus on business logic, not infrastructure
  • Production-ready components: EWMA+AIMD rate limiting, graceful shutdown, dependency injection
  • Testable: explicit dependencies, no global state, easy mocking

When to use aioscraper:

  • Collecting data from 100+ API endpoints
  • Fan-out calls to microservices for data enrichment
  • Queue consumers processing API scraping tasks
  • API aggregation/monitoring pipelines
  • High-throughput data collection jobs

Use Cases

1. E-commerce price monitoring

Poll 10,000 product API endpoints across multiple marketplaces:

  • Adaptive rate limiting prevents bans
  • Priority queue for trending products
  • Pipeline aggregates prices → saves to DB → sends alerts on changes

2. Cryptocurrency data aggregation

Collect real-time prices from 20+ exchange APIs:

  • Concurrent requests with per-exchange rate limits
  • Built-in retry for transient failures
  • Pipeline normalizes data formats → writes to time-series DB

3. Microservice data hydration

Your FastAPI app needs data from 50 internal services:

  • Embed aioscraper in your async application
  • Fan-out concurrent requests with backpressure control
  • Middleware for auth, logging, circuit breaking

4. Queue-based scraping workers

Distributed architecture with Redis/RabbitMQ/SQS:

  • Message queue publishes scraping tasks (URLs + params)
  • aioscraper workers consume queue → fetch data → process
  • Pipeline acknowledges messages after successful processing

5. Social media API aggregation

Aggregate user stats from Twitter, LinkedIn, GitHub APIs:

  • Different rate limits per platform (adaptive throttling)
  • Error callbacks for quota exceeded / auth failures
  • Pipeline deduplicates → enriches → stores to database

6. Multi-source data snapshots

Collect point-in-time data from 500+ API sources simultaneously:

  • Health monitoring: poll status endpoints of distributed services every minute
  • Market data: snapshot prices from 200+ suppliers at exact intervals
  • Analytics aggregation: fetch metrics from dozens of analytics APIs on schedule
  • Concurrent execution with precise timing and automatic retries for failed sources

Performance

Benchmarks show stable throughput across CPython 3.11–3.14 (see benchmarks)

Documentation

Full documentation at aioscraper.readthedocs.io

Changelog

See CHANGELOG.md for version history and release notes.

Contributing

Please see the Contributing guide for workflow, tooling, and review expectations.

License

MIT License

Copyright (c) 2025 darkstussy

Download files

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

Source Distribution

aioscraper-0.13.0.tar.gz (879.5 kB view details)

Uploaded Source

Built Distribution

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

aioscraper-0.13.0-py3-none-any.whl (67.8 kB view details)

Uploaded Python 3

File details

Details for the file aioscraper-0.13.0.tar.gz.

File metadata

  • Download URL: aioscraper-0.13.0.tar.gz
  • Upload date:
  • Size: 879.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for aioscraper-0.13.0.tar.gz
Algorithm Hash digest
SHA256 403ca07c509f4acf8343a98f20a52ca0e4b9db6329f9a6de759945066e2658a5
MD5 3861f16c343bd8616c8b341ddcdf6b8c
BLAKE2b-256 632ea96e155c5d5931efd7fbc31c14ec3b01dcee2f23f5d27c25ef85d8b76a0e

See more details on using hashes here.

Provenance

The following attestation bundles were made for aioscraper-0.13.0.tar.gz:

Publisher: release.yml on DarkStussy/aioscraper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aioscraper-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: aioscraper-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 67.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for aioscraper-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0ed7118034eb244490405417d9fd5c676a4db45986731f3bff73c4d7df2b8a4
MD5 9127367063530c62a81a14ff695b8fe7
BLAKE2b-256 bf1de35670d51b05171d041845d66169d6d641cedd1eceb579fc52521d9133bd

See more details on using hashes here.

Provenance

The following attestation bundles were made for aioscraper-0.13.0-py3-none-any.whl:

Publisher: release.yml on DarkStussy/aioscraper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.16.0

2 files

0.15.0

2 files

0.14.0

2 files

This release

0.13.0 This release

2 files

0.12.0

2 files

0.11.0

2 files

0.10.4

2 files

0.10.3

2 files

0.10.2

2 files

0.10.1

2 files

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.1

2 files

0.7.0

2 files

0.6.1

2 files

0.6.0

2 files

0.5.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.1

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page