HTTPX is a fully featured HTTP client for Python 3, which provides sync and async APIs, and support for both HTTP/1.1 and HTTP/2.
The 0.20 release adds support for an integrated command-line client, and also includes a couple of design changes from 0.19. Redirects are no longer followed by default, and the low-level Transport API has been updated. See the CHANGELOG for more details.
Install HTTPX using pip:
$ pip install httpx
Now, let's get started:
>>> import httpx >>> r = httpx.get('https://www.example.org/') >>> r <Response [200 OK]> >>> r.status_code 200 >>> r.headers['content-type'] 'text/html; charset=UTF-8' >>> r.text '<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'
Or, using the command-line client.
# The command line client is an optional dependency. $ pip install 'httpx[cli]'
Which now allows us to use HTTPX directly from the command-line...
Sending a request...
HTTPX builds on the well-established usability of
requests, and gives you:
- A broadly requests-compatible API.
- Standard synchronous interface, but with async support if you need it.
- HTTP/1.1 and HTTP/2 support.
- Ability to make requests directly to WSGI applications or ASGI applications.
- Strict timeouts everywhere.
- Fully type annotated.
- 100% test coverage.
Plus all the standard features of
- International Domains and URLs
- Keep-Alive & Connection Pooling
- Sessions with Cookie Persistence
- Browser-style SSL Verification
- Basic/Digest Authentication
- Elegant Key/Value Cookies
- Automatic Decompression
- Automatic Content Decoding
- Unicode Response Bodies
- Multipart File Uploads
- HTTP(S) Proxy Support
- Connection Timeouts
- Streaming Downloads
- .netrc Support
- Chunked Requests
For a run-through of all the basics, head over to the QuickStart.
The Developer Interface provides a comprehensive API reference.
To find out about tools that integrate with HTTPX, see Third Party Packages.
The HTTPX project relies on these excellent libraries:
httpcore- The underlying transport implementation for
h11- HTTP/1.1 support.
h2- HTTP/2 support. (Optional, with
certifi- SSL certificates.
charset_normalizer- Charset auto-detection.
rfc3986- URL parsing & normalization.
idna- Internationalized domain name support.
sniffio- Async library autodetection.
rich- Rich terminal support. (Optional, with
click- Command line client support. (Optional, with
brotlicffi- Decoding for "brotli" compressed responses. (Optional, with
async_generator- Backport support for
contextlib.asynccontextmanager. (Only required for Python 3.6)
A huge amount of credit is due to
requests for the API layout that
much of this work follows, as well as to
urllib3 for plenty of design
inspiration around the lower-level networking details.
Install with pip:
$ pip install httpx
Or, to include the optional HTTP/2 support, use:
$ pip install httpx[http2]
To include the optional brotli decoder support, use:
$ pip install httpx[brotli]
HTTPX requires Python 3.6+