Python Module Index

_ | a | b | c | d | e | f | g | h | i | j | k | l | m | n | o | p | q | r | s | t | u | v | w | x | z

Requests is an elegant and simple HTTP library for Python, built for human beings.

Behold, the power of Requests:

>>> r = requests.get('https://api.github.com/user', auth=('user', 'pass'))
>>> r.status_code
200
>>> r.headers['content-type']
'application/json; charset=utf8'
>>> r.encoding
'utf-8'
>>> r.text
'{"type":"User"...'
>>> r.json()
{'private_gists': 419, 'total_private_repos': 77, ...}

See similar code, sans Requests.

Requests allows you to send HTTP/1.1 requests extremely easily. There’s no need to manually add query strings to your URLs, or to form-encode your POST data. Keep-alive and HTTP connection pooling are 100% automatic, thanks to urllib3.

Beloved Features

Requests is ready for today’s web.

• Keep-Alive & Connection Pooling

• International Domains and URLs

• Sessions with Cookie Persistence

• Browser-style SSL Verification

• Automatic Content Decoding

• Basic/Digest Authentication

• Elegant Key/Value Cookies

• Automatic Decompression

• Unicode Response Bodies

• HTTP(S) Proxy Support

• Multipart File Uploads

• Streaming Downloads

• Connection Timeouts

• Chunked Requests

• .netrc Support

Requests officially supports Python 2.7 & 3.6+, and runs great on PyPy.

The User Guide

This part of the documentation, which is mostly prose, begins with some background information about Requests, then focuses on step-by-step instructions for getting the most out of Requests.

• Installation of Requests

  • $ python -m pip install requests

  • Get the Source Code

• Quickstart

  • Make a Request

  • Passing Parameters In URLs

  • Response Content

  • Binary Response Content

  • JSON Response Content

  • Raw Response Content

  • Custom Headers

  • More complicated POST requests

  • POST a Multipart-Encoded File

  • Response Status Codes

  • Response Headers

  • Cookies

  • Redirection and History

  • Timeouts

  • Errors and Exceptions

• Advanced Usage

  • Session Objects

  • Request and Response Objects

  • Prepared Requests

  • SSL Cert Verification

  • Client Side Certificates

  • CA Certificates

  • Body Content Workflow

  • Keep-Alive

  • Streaming Uploads

  • Chunk-Encoded Requests

  • POST Multiple Multipart-Encoded Files

  • Event Hooks

  • Custom Authentication

  • Streaming Requests

  • Proxies

  • Compliance

  • HTTP Verbs

  • Custom Verbs

  • Link Headers

  • Transport Adapters

  • Blocking Or Non-Blocking?

  • Header Ordering

  • Timeouts

• Authentication

  • Basic Authentication

  • Digest Authentication

  • OAuth 1 Authentication

  • OAuth 2 and OpenID Connect Authentication

  • Other Authentication

  • New Forms of Authentication

The Community Guide

This part of the documentation, which is mostly prose, details the Requests ecosystem and community.

• Recommended Packages and Extensions

  • Certifi CA Bundle

  • CacheControl

  • Requests-Toolbelt

  • Requests-Threads

  • Requests-OAuthlib

  • Betamax

• Frequently Asked Questions

  • Encoded Data?

  • Custom User-Agents?

  • Why not Httplib2?

  • Python 3 Support?

  • Python 2 Support?

  • What are “hostname doesn’t match” errors?

• Integrations

  • Python for iOS

• Articles & Talks

• Support

  • Stack Overflow

  • File an Issue

  • Send a Tweet

• Vulnerability Disclosure

  • Process

  • Previous CVEs

• Release Process and Rules

  • Major Releases

  • Minor Releases

  • Hotfix Releases

  • Reasoning

• Community Updates

• Release History

The API Documentation / Guide

If you are looking for information on a specific function, class, or method, this part of the documentation is for you.

• Developer Interface

  • Main Interface

  • Exceptions

  • Request Sessions

  • Lower-Level Classes

  • Lower-Lower-Level Classes

  • Authentication

  • Encodings

  • Cookies

  • Status Code Lookup

  • Migrating to 1.x

  • Migrating to 2.x

Main Interface

All of Requests’ functionality can be accessed by these 7 methods. They all return an instance of the Response object.requests.request(method, url, **kwargs)[source]

Constructs and sends a Request.

Usage:

>>> import requests
>>> req = requests.request('GET', 'https://httpbin.org/get')
>>> req
<Response [200]>

requests.head(url, **kwargs)[source]

Sends a HEAD request.

requests.get(url, params=None, **kwargs)[source]

Sends a GET request.

requests.post(url, data=None, json=None, **kwargs)[source]

Sends a POST request.

requests.put(url, data=None, **kwargs)[source]

Sends a PUT request.

requests.patch(url, data=None, **kwargs)[source]

Sends a PATCH request.

requests.delete(url, **kwargs)[source]

Sends a DELETE request.

Exceptions

exception requests.RequestException(*args, **kwargs)[source]

There was an ambiguous exception that occurred while handling your request.exception requests.ConnectionError(*args, **kwargs)[source]

A Connection error occurred.exception requests.HTTPError(*args, **kwargs)[source]

An HTTP error occurred.exception requests.URLRequired(*args, **kwargs)[source]

A valid URL is required to make a request.exception requests.TooManyRedirects(*args, **kwargs)[source]

Too many redirects.exception requests.ConnectTimeout(*args, **kwargs)[source]

The request timed out while trying to connect to the remote server.

Requests that produced this error are safe to retry.exception requests.ReadTimeout(*args, **kwargs)[source]

The server did not send any data in the allotted amount of time.exception requests.Timeout(*args, **kwargs)[source]

The request timed out.

Catching this error will catch both ConnectTimeout and ReadTimeout errors.

Request Sessions

class requests.Session[source]

A Requests session.

Provides cookie persistence, connection-pooling, and configuration.

Basic Usage:

>>> import requests
>>> s = requests.Session()
>>> s.get('https://httpbin.org/get')
<Response [200]>

Or as a context manager:

>>> with requests.Session() as s:
...     s.get('https://httpbin.org/get')
<Response [200]>

auth = None

Default Authentication tuple or object to attach to Request.cert = None

SSL client certificate default, if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair.close()[source]

Closes all adapters and as such the sessioncookies = None

A CookieJar containing all currently outstanding cookies set on this session. By default it is a RequestsCookieJar, but may be any other cookielib.CookieJar compatible object.delete(url, **kwargs)[source]

Sends a DELETE request. Returns Response object.

get(url, **kwargs)[source]

Sends a GET request. Returns Response object.

get_adapter(url)[source]

Returns the appropriate connection adapter for the given URL.

get_redirect_target(resp)

Receives a Response. Returns a redirect URI or Nonehead(url, **kwargs)[source]

Sends a HEAD request. Returns Response object.

headers = None

A case-insensitive dictionary of headers to be sent on each Request sent from this Session.hooks = None

Event-handling hooks.max_redirects = None

Maximum number of redirects allowed. If the request exceeds this limit, a TooManyRedirects exception is raised. This defaults to requests.models.DEFAULT_REDIRECT_LIMIT, which is 30.merge_environment_settings(url, proxies, stream, verify, cert)[source]

Check the environment and merge it with some settings.

mount(prefix, adapter)[source]

Registers a connection adapter to a prefix.

Adapters are sorted in descending order by prefix length.options(url, **kwargs)[source]

Sends a OPTIONS request. Returns Response object.

params = None

Dictionary of querystring data to attach to each Request. The dictionary values may be lists for representing multivalued query parameters.patch(url, data=None, **kwargs)[source]

Sends a PATCH request. Returns Response object.

post(url, data=None, json=None, **kwargs)[source]

Sends a POST request. Returns Response object.

prepare_request(request)[source]

Constructs a PreparedRequest for transmission and returns it. The PreparedRequest has settings merged from the Request instance and those of the Session.

proxies = None

Dictionary mapping protocol or protocol and host to the URL of the proxy (e.g. {‘http’: ‘foo.bar:3128’, ‘http://host.name’: ‘foo.bar:4012’}) to be used on each Request.put(url, data=None, **kwargs)[source]

Sends a PUT request. Returns Response object.

rebuild_auth(prepared_request, response)

When being redirected we may want to strip authentication from the request to avoid leaking credentials. This method intelligently removes and reapplies authentication where possible to avoid credential loss.rebuild_method(prepared_request, response)

When being redirected we may want to change the method of the request based on certain specs or browser behavior.rebuild_proxies(prepared_request, proxies)

This method re-evaluates the proxy configuration by considering the environment variables. If we are redirected to a URL covered by NO_PROXY, we strip the proxy configuration. Otherwise, we set missing proxy keys for this URL (in case they were stripped by a previous redirect).

This method also replaces the Proxy-Authorization header where necessary.

request(method, url, params=None, data=None, headers=None, cookies=None, files=None, auth=None, timeout=None, allow_redirects=True, proxies=None, hooks=None, stream=None, verify=None, cert=None, json=None)[source]

Constructs a Request, prepares it and sends it. Returns Response object.

resolve_redirects(resp, req, stream=False, timeout=None, verify=True, cert=None, proxies=None, yield_requests=False, **adapter_kwargs)

Receives a Response. Returns a generator of Responses or Requests.send(request, **kwargs)[source]

Send a given PreparedRequest.

should_strip_auth(old_url, new_url)

Decide whether Authorization header should be removed when redirectingstream = None

Stream response content default.trust_env = None

Trust environment settings for proxy configuration, default authentication and similar.verify = None

SSL Verification default. Defaults to True, requiring requests to verify the TLS certificate at the remote end. If verify is set to False, requests will accept any TLS certificate presented by the server, and will ignore hostname mismatches and/or expired certificates, which will make your application vulnerable to man-in-the-middle (MitM) attacks. Only set this to False for testing.

Lower-Level Classes

class requests.Request(method=None, url=None, headers=None, files=None, data=None, params=None, auth=None, cookies=None, hooks=None, json=None)[source]

A user-created Request object.

Used to prepare a PreparedRequest, which is sent to the server.

Usage:

>>> import requests
>>> req = requests.Request('GET', 'https://httpbin.org/get')
>>> req.prepare()
<PreparedRequest [GET]>

deregister_hook(event, hook)

Deregister a previously registered hook. Returns True if the hook existed, False if not.prepare()[source]

Constructs a PreparedRequest for transmission and returns it.register_hook(event, hook)

Properly register a hook.class requests.Response[source]

The Response object, which contains a server’s response to an HTTP request.apparent_encoding

The apparent encoding, provided by the charset_normalizer or chardet libraries.close()[source]

Releases the connection back to the pool. Once this method has been called the underlying raw object must not be accessed again.

Note: Should not normally need to be called explicitly.content

Content of the response, in bytes.cookies = None

A CookieJar of Cookies the server sent back.elapsed = None

The amount of time elapsed between sending the request and the arrival of the response (as a timedelta). This property specifically measures the time taken between sending the first byte of the request and finishing parsing the headers. It is therefore unaffected by consuming the response content or the value of the stream keyword argument.encoding = None

Encoding to decode with when accessing r.text.headers = None

Case-insensitive Dictionary of Response Headers. For example, headers['content-encoding'] will return the value of a 'Content-Encoding' response header.history = None

A list of Response objects from the history of the Request. Any redirect responses will end up here. The list is sorted from the oldest to the most recent request.is_permanent_redirect

True if this Response one of the permanent versions of redirect.is_redirect

True if this Response is a well-formed HTTP redirect that could have been processed automatically (by Session.resolve_redirects).iter_content(chunk_size=1, decode_unicode=False)[source]

Iterates over the response data. When stream=True is set on the request, this avoids reading the content at once into memory for large responses. The chunk size is the number of bytes it should read into memory. This is not necessarily the length of each item returned as decoding can take place.

chunk_size must be of type int or None. A value of None will function differently depending on the value of stream. stream=True will read data as it arrives in whatever size the chunks are received. If stream=False, data is returned as a single chunk.

If decode_unicode is True, content will be decoded using the best available encoding based on the response.iter_lines(chunk_size=512, decode_unicode=False, delimiter=None)[source]

Iterates over the response data, one line at a time. When stream=True is set on the request, this avoids reading the content at once into memory for large responses.

Note

This method is not reentrant safe.json(**kwargs)[source]

Returns the json-encoded content of a response, if any.

links

Returns the parsed header links of the response, if any.next

Returns a PreparedRequest for the next request in a redirect chain, if there is one.ok

Returns True if status_code is less than 400, False if not.

This attribute checks if the status code of the response is between 400 and 600 to see if there was a client error or a server error. If the status code is between 200 and 400, this will return True. This is not a check to see if the response code is 200 OK.raise_for_status()[source]

Raises HTTPError, if one occurred.raw = None

File-like object representation of response (for advanced usage). Use of raw requires that stream=True be set on the request. This requirement does not apply for use internally to Requests.reason = None

Textual reason of responded HTTP Status, e.g. “Not Found” or “OK”.request = None

The PreparedRequest object to which this is a response.status_code = None

Integer Code of responded HTTP Status, e.g. 404 or 200.text

Content of the response, in unicode.

If Response.encoding is None, encoding will be guessed using charset_normalizer or chardet.

The encoding of the response content is determined based solely on HTTP headers, following RFC 2616 to the letter. If you can take advantage of non-HTTP knowledge to make a better guess at the encoding, you should set r.encoding appropriately before accessing this property.url = None

Final URL location of Response.

Lower-Lower-Level Classes

class requests.PreparedRequest[source]

The fully mutable PreparedRequest object, containing the exact bytes that will be sent to the server.

Instances are generated from a Request object, and should not be instantiated manually; doing so may produce undesirable effects.

Usage:

>>> import requests
>>> req = requests.Request('GET', 'https://httpbin.org/get')
>>> r = req.prepare()
>>> r
<PreparedRequest [GET]>

>>> s = requests.Session()
>>> s.send(r)
<Response [200]>

body = None

request body to send to the server.deregister_hook(event, hook)

Deregister a previously registered hook. Returns True if the hook existed, False if not.headers = None

dictionary of HTTP headers.hooks = None

dictionary of callback hooks, for internal usage.method = None

HTTP verb to send to the server.path_url

Build the path URL to use.prepare(method=None, url=None, headers=None, files=None, data=None, params=None, auth=None, cookies=None, hooks=None, json=None)[source]

Prepares the entire request with the given parameters.prepare_auth(auth, url='')[source]

Prepares the given HTTP auth data.prepare_body(data, files, json=None)[source]

Prepares the given HTTP body data.prepare_content_length(body)[source]

Prepare Content-Length header based on request method and bodyprepare_cookies(cookies)[source]

Prepares the given HTTP cookie data.

This function eventually generates a Cookie header from the given cookies using cookielib. Due to cookielib’s design, the header will not be regenerated if it already exists, meaning this function can only be called once for the life of the PreparedRequest object. Any subsequent calls to prepare_cookies will have no actual effect, unless the “Cookie” header is removed beforehand.prepare_headers(headers)[source]

Prepares the given HTTP headers.prepare_hooks(hooks)[source]

Prepares the given hooks.prepare_method(method)[source]

Prepares the given HTTP method.prepare_url(url, params)[source]

Prepares the given HTTP URL.register_hook(event, hook)

Properly register a hook.url = None

HTTP URL to send the request to.class requests.adapters.BaseAdapter[source]

The Base Transport Adapterclose()[source]

Cleans up adapter specific items.send(request, stream=False, timeout=None, verify=True, cert=None, proxies=None)[source]

Sends PreparedRequest object. Returns Response object.

class requests.adapters.HTTPAdapter(pool_connections=10, pool_maxsize=10, max_retries=0, pool_block=False)[source]

The built-in HTTP Adapter for urllib3.

Provides a general-case interface for Requests sessions to contact HTTP and HTTPS urls by implementing the Transport Adapter interface. This class will usually be created by the Session class under the covers.

Usage:

>>> import requests
>>> s = requests.Session()
>>> a = requests.adapters.HTTPAdapter(max_retries=3)
>>> s.mount('http://', a)

add_headers(request, **kwargs)[source]

Add any headers needed by the connection. As of v2.0 this does nothing by default, but is left for overriding by users that subclass the HTTPAdapter.

This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

build_response(req, resp)[source]

Builds a Response object from a urllib3 response. This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter

cert_verify(conn, url, verify, cert)[source]

Verify a SSL certificate. This method should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

close()[source]

Disposes of any internal state.

Currently, this closes the PoolManager and any active ProxyManager, which closes any pooled connections.get_connection(url, proxies=None)[source]

Returns a urllib3 connection for the given URL. This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

init_poolmanager(connections, maxsize, block=False, **pool_kwargs)[source]

Initializes a urllib3 PoolManager.

This method should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

proxy_headers(proxy)[source]

Returns a dictionary of the headers to add to any request sent through a proxy. This works with urllib3 magic to ensure that they are correctly sent to the proxy, rather than in a tunnelled request if CONNECT is being used.

This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

proxy_manager_for(proxy, **proxy_kwargs)[source]

Return urllib3 ProxyManager for the given proxy.

This method should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

request_url(request, proxies)[source]

Obtain the url to use when making the final request.

If the message is being sent through a HTTP proxy, the full URL has to be used. Otherwise, we should only use the path portion of the URL.

This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

send(request, stream=False, timeout=None, verify=True, cert=None, proxies=None)[source]

Sends PreparedRequest object. Returns Response object.

Authentication

class requests.auth.AuthBase[source]

Base class that all auth implementations derive fromclass requests.auth.HTTPBasicAuth(username, password)[source]

Attaches HTTP Basic Authentication to the given Request object.class requests.auth.HTTPProxyAuth(username, password)[source]

Attaches HTTP Proxy Authentication to a given Request object.class requests.auth.HTTPDigestAuth(username, password)[source]

Attaches HTTP Digest Authentication to the given Request object.

Encodings

requests.utils.get_encodings_from_content(content)[source]

Returns encodings from given content string.

requests.utils.get_encoding_from_headers(headers)[source]

Returns encodings from given HTTP Header Dict.

requests.utils.get_unicode_from_response(r)[source]

Returns the requested content back in unicode.

Tried:

1. charset from content-type

2. fall back and replace all unicode characters

Cookies

requests.utils.dict_from_cookiejar(cj)[source]

Returns a key/value dictionary from a CookieJar.

requests.utils.add_dict_to_cookiejar(cj, cookie_dict)[source]

Returns a CookieJar from a key/value dictionary.

requests.cookies.cookiejar_from_dict(cookie_dict, cookiejar=None, overwrite=True)[source]

Returns a CookieJar from a key/value dictionary.

class requests.cookies.RequestsCookieJar(policy=None)[source]

Compatibility class; is a cookielib.CookieJar, but exposes a dict interface.

This is the CookieJar we create by default for requests and sessions that don’t specify one, since some clients may expect response.cookies and session.cookies to support dict operations.

Requests does not use the dict interface internally; it’s just for compatibility with external client code. All requests code should work out of the box with externally provided instances of CookieJar, e.g. LWPCookieJar and FileCookieJar.

Unlike a regular CookieJar, this class is pickleable.

Warning

dictionary operations that are normally O(1) may be O(n).add_cookie_header(request)

Add correct Cookie: header to request (urllib2.Request object).

The Cookie2 header is also added unless policy.hide_cookie2 is true.clear(domain=None, path=None, name=None)

Clear some cookies.

Invoking this method without arguments will clear all cookies. If given a single argument, only cookies belonging to that domain will be removed. If given two arguments, cookies belonging to the specified path within that domain are removed. If given three arguments, then the cookie with the specified name, path and domain is removed.

Raises KeyError if no matching cookie exists.clear_expired_cookies()

Discard all expired cookies.

You probably don’t need to call this method: expired cookies are never sent back to the server (provided you’re using DefaultCookiePolicy), this method is called by CookieJar itself every so often, and the .save() method won’t save expired cookies anyway (unless you ask otherwise by passing a true ignore_expires argument).clear_session_cookies()

Discard all session cookies.

Note that the .save() method won’t save session cookies anyway, unless you ask otherwise by passing a true ignore_discard argument.copy()[source]

Return a copy of this RequestsCookieJar.extract_cookies(response, request)

Extract cookies from response, where allowable given the request.get(name, default=None, domain=None, path=None)[source]

Dict-like get() that also supports optional domain and path args in order to resolve naming collisions from using one cookie jar over multiple domains.

Warning

operation is O(n), not O(1).get_dict(domain=None, path=None)[source]

Takes as an argument an optional domain and path and returns a plain old Python dict of name-value pairs of cookies that meet the requirements.

get_policy()[source]

Return the CookiePolicy instance used.items()[source]

Dict-like items() that returns a list of name-value tuples from the jar. Allows client-code to call dict(RequestsCookieJar) and get a vanilla python dict of key value pairs.

See also

keys() and values().iteritems()[source]

Dict-like iteritems() that returns an iterator of name-value tuples from the jar.

See also

iterkeys() and itervalues().iterkeys()[source]

Dict-like iterkeys() that returns an iterator of names of cookies from the jar.

See also

itervalues() and iteritems().itervalues()[source]

Dict-like itervalues() that returns an iterator of values of cookies from the jar.

See also

iterkeys() and iteritems().keys()[source]

Dict-like keys() that returns a list of names of cookies from the jar.

See also

values() and items().list_domains()[source]

Utility method to list all the domains in the jar.list_paths()[source]

Utility method to list all the paths in the jar.make_cookies(response, request)

Return sequence of Cookie objects extracted from response object.multiple_domains()[source]

Returns True if there are multiple domains in the jar. Returns False otherwise.