Skip to content

aiohttp

15,197 30 250 NOASSERTION
3.11.10 (5 Dec 2024) Jul 26 2019 208.0 million (month)

aiohttp is an asynchronous HTTP client/server framework for asyncio and Python. It provides a simple API for making HTTP requests and handling both client and server functionality. Like the requests package, aiohttp is designed to be easy to use and handle many of the low-level details of working with HTTP.

The main benefit of aiohttp over requests is that it is built on top of the asyncio library, which means that it can handle many requests at the same time without blocking the execution of your program. This can lead to significant performance improvements when making many small requests, or when dealing with slow or unreliable network connections.

aiohttp provides both client and server side functionality, so you can use it to create web servers and handle client requests in a non-blocking manner. It also supports WebSocket protocol, so it can be used for building real-time application like chat, game, etc.

aiohttp also provide several features for handling connection errors, managing timeouts, and client sessions. It also provide similar features like requests package like redirect handling, cookies, and support for several authentication modules.

You can install aiohttp via pip package manager:

pip install aiohttp

In terms of API design, aiohttp is similar to requests and thus should be familiar to anyone who has used the requests library, but it provides an async with block to manage the context of the connection and used await statement to wait for the result.

It''s worth noting that aiohttp is built on top of asyncio and is designed to be used in Python 3.5 and above. It provides the same functionality as httpx but it is specifically built for the asyncio framework.

Highlights


asynciowebsocketshttp2http-servermulti-partresponse-streaminghttp-proxy

Example Use


import asyncio
from aiohttp import ClientSession, WSMsgType

# aiohttp only provides async client so we must use a coroutine:
async def run():
    async with ClientSession(headers={"User-Agent": "webscraping.fyi"}) as session:
        # we can use the session to make requests:
        response = await session.get("http://httpbin.org/headers")
        print(response.status)
        # note: to read the response body we must use await:
        print(await response.text())

        # aiohttp also comes with convenience methods for common requests:
        # POST json
        resp = await session.post("http://httpbin.org/post", json={"key": "value"})
        # POST form data
        resp = await session.post("http://httpbin.org/post", data={"key": "value"})
        # decode response as json
        resp = await session.get("http://httpbin.org/json")
        data = await resp.json()
        print(data)

        # aiohttp also supports websocket connections
        # which can be used to scrape websites that use websockets:
        async with session.ws_connect("http://example.org/ws") as ws:
            async for msg in ws:
                if msg.type == WSMsgType.TEXT:
                    if msg.data == "close cmd":
                        await ws.close()
                        break
                    else:
                        await ws.send_str(msg.data + "/answer")
                elif msg.type == WSMsgType.ERROR:
                    break


asyncio.run(run())

Alternatives / Similar


52,271 2.32.3 (6 months ago) Feb 14 2011 compare
13,397 0.28.1 (3 days ago) Jul 26 2019 compare
3,854 v0.6.1 (9 months ago) Feb 23 2022 compare
1,080 7.45.3 (9 months ago) Feb 25 2003 compare
1,751 0.7.1 (4 months ago) Feb 23 2022 compare
587 23.11.0 (1 year, 1 month ago) Dec 28 2012 compare
713 0.9.2 (9 days ago) Feb 23 2022 compare

Other Languages

8,800 3.3.2 (1 year, 10 days ago) Dec 28 2012 compare
105,935 1.7.9 (6 days ago) Aug 29 2014 compare
got
14,222 14.4.2 (3 months ago) Mar 27 2014 compare
16,600 10.1.1 (a month ago) Aug 22 2011 compare
1,624 3.3.1 (11 months ago) Dec 11 2011 compare
5,764 2.12.1 (26 days ago) Dec 19 2009 compare
704 2.8.3 (8 years ago) Jul 25 2009 compare
1,162 1.2.2 (12 days ago) Oct 31 2009 compare
5,820 0.22.0 (7 months ago) Jul 25 2009 compare
4,081 1.4.1 (1 year, 24 days ago) Oct 06 2009 compare
986 1.4.7 (1 year, 7 months ago) May 06 2012 compare
1,494 1.0.4 (2 years ago) Nov 22 2014 compare
23,055 7.9.1 (4 months ago) Nov 14 2011 compare
1,218 1.1.7 (4 years ago) Oct 25 2009 compare
382 18.1.0 (4 months ago) Aug 06 2011 compare
1,933 v7.1.5 (2 months ago) Apr 28 2019 compare
899 1.0.2 (a month ago) Sep 25 2013 compare
req
4,324 v3.48.0 (a month ago) Aug 11 2023 compare
10,249 v3.0.0-alpha.2 (8 days ago) Oct 10 2019 compare
507 1.1.4 (4 years ago) Apr 20 2010 compare
106 1.5.0 (8 months ago) Nov 09 2016 compare
3,573 v2.0.13 (a month ago) Oct 06 2013 compare
1,918 1.3.0 (2 months ago) Nov 11 2011 compare
1,744 1.0.0 (7 months ago) Apr 14 2012 compare
3,014 0.12.0 (7 years ago) Mar 20 2015 compare
156 2.2.4 (3 years ago) Dec 22 2019 compare
Was this page helpful?