# Developer Interface

This part of the documentation covers all the interfaces of Requests. For parts where Requests depends on external libraries, we document the most important right here and provide links to the canonical documentation.

## 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: str, url: _t.UriType, **kwargs: Unpack[_t.RequestKwargs]) → Response

  Constructs and sends a `Request`.

  Parameters:

    - method – method for the new `Request` object: `GET`, `OPTIONS`, `HEAD`, `POST`, `PUT`, `PATCH`, or `DELETE`.

    - url – URL for the new `Request` object.

    - params – (optional) Dictionary, list of tuples or bytes to send in the query string for the `Request`.

    - data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the `Request`.

    - json – (optional) A JSON serializable Python object to send in the body of the `Request`.

    - headers – (optional) Dictionary of HTTP Headers to send with the `Request`.

    - cookies – (optional) Dict or CookieJar object to send with the `Request`.

    - files – (optional) Dictionary of `'name': file-like-objects` (or `{'name': file-tuple}`) for multipart encoding upload. `file-tuple` can be a 2-tuple `('filename', fileobj)`, 3-tuple `('filename', fileobj, 'content_type')` or a 4-tuple `('filename', fileobj, 'content_type', custom_headers)`, where `'content_type'` is a string defining the content type of the given file and `custom_headers` a dict-like object containing additional headers to add for the file.

    - auth – (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth.

    - timeout (float or tuple) – (optional) How many seconds to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple.

    - allow_redirects (bool) – (optional) Boolean. Enable/disable GET/OPTIONS/POST/PUT/PATCH/DELETE/HEAD redirection. Defaults to `True`.

    - proxies – (optional) Dictionary mapping protocol to the URL of the proxy.

    - verify – (optional) Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. Defaults to `True`.

    - stream – (optional) if `False`, the response content will be immediately downloaded.

    - cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair.

  Returns:

    `Response` object

  Return type:

    requests.Response

  Usage:

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

requests.head(url: _t.UriType, **kwargs: Unpack[_t.RequestKwargs]) → Response

  Sends a HEAD request.

  Parameters:

    - url – URL for the new `Request` object.

    - **kwargs – Optional arguments that `request` takes. If allow_redirects is not provided, it will be set to False (as opposed to the default `request` behavior).

  Returns:

    `Response` object

  Return type:

    requests.Response

requests.get(url: _t.UriType, params: _t.ParamsType = None, **kwargs: Unpack[_t.GetKwargs]) → Response

  Sends a GET request.

  Parameters:

    - url – URL for the new `Request` object.

    - params – (optional) Dictionary, list of tuples or bytes to send in the query string for the `Request`.

    - **kwargs – Optional arguments that `request` takes.

  Returns:

    `Response` object

  Return type:

    requests.Response

requests.post(url: _t.UriType, data: _t.DataType = None, json: _t.JsonType = None, **kwargs: Unpack[_t.PostKwargs]) → Response

  Sends a POST request.

  Parameters:

    - url – URL for the new `Request` object.

    - data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the `Request`.

    - json – (optional) A JSON serializable Python object to send in the body of the `Request`.

    - **kwargs – Optional arguments that `request` takes.

  Returns:

    `Response` object

  Return type:

    requests.Response

requests.put(url: _t.UriType, data: _t.DataType = None, **kwargs: Unpack[_t.DataKwargs]) → Response

  Sends a PUT request.

  Parameters:

    - url – URL for the new `Request` object.

    - data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the `Request`.

    - json – (optional) A JSON serializable Python object to send in the body of the `Request`.

    - **kwargs – Optional arguments that `request` takes.

  Returns:

    `Response` object

  Return type:

    requests.Response

requests.patch(url: _t.UriType, data: _t.DataType = None, **kwargs: Unpack[_t.DataKwargs]) → Response

  Sends a PATCH request.

  Parameters:

    - url – URL for the new `Request` object.

    - data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the `Request`.

    - json – (optional) A JSON serializable Python object to send in the body of the `Request`.

    - **kwargs – Optional arguments that `request` takes.

  Returns:

    `Response` object

  Return type:

    requests.Response

requests.delete(url: _t.UriType, **kwargs: Unpack[_t.RequestKwargs]) → Response

  Sends a DELETE request.

  Parameters:

    - url – URL for the new `Request` object.

    - **kwargs – Optional arguments that `request` takes.

  Returns:

    `Response` object

  Return type:

    requests.Response

## Exceptions

exception requests.RequestException(*args: Any, **kwargs: Any)

  There was an ambiguous exception that occurred while handling your request.

exception requests.ConnectionError(*args: Any, **kwargs: Any)

  A Connection error occurred.

exception requests.HTTPError(*args: Any, **kwargs: Any)

  An HTTP error occurred.

exception requests.TooManyRedirects(*args: Any, **kwargs: Any)

  Too many redirects.

exception requests.ConnectTimeout(*args: Any, **kwargs: Any)

  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: Any, **kwargs: Any)

  The server did not send any data in the allotted amount of time.

exception requests.Timeout(*args: Any, **kwargs: Any)

  The request timed out.

  Catching this error will catch both `ConnectTimeout` and `ReadTimeout` errors.

exception requests.JSONDecodeError(*args: Any, **kwargs: Any)

  Couldn’t decode the text into json

## Request Sessions

class requests.Session

  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: _t.AuthType

    Default Authentication tuple or object to attach to `Request`.

  cert: _t.CertType

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

  close() → None

    Closes all adapters and as such the session

  cookies: RequestsCookieJar

    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: _t.UriType, **kwargs: Unpack[_t.RequestKwargs]) → Response

    Sends a DELETE request. Returns `Response` object.

    Parameters:

      - url – URL for the new `Request` object.

      - **kwargs – Optional arguments that `request` takes.

    Return type:

      requests.Response

  get(url: _t.UriType, params: _t.ParamsType = None, **kwargs: Unpack[_t.GetKwargs]) → Response

    Sends a GET request. Returns `Response` object.

    Parameters:

      - url – URL for the new `Request` object.

      - params – (optional) Dictionary, list of tuples or bytes to send

    in the query string for the `Request`. :param **kwargs: Optional arguments that `request` takes. :rtype: requests.Response

  get_adapter(url: str) → BaseAdapter

    Returns the appropriate connection adapter for the given URL.

    Return type:

      requests.adapters.BaseAdapter

  get_redirect_target(resp: Response) → str | None

    Receives a Response. Returns a redirect URI or `None`

  head(url: _t.UriType, **kwargs: Unpack[_t.RequestKwargs]) → Response

    Sends a HEAD request. Returns `Response` object.

    Parameters:

      - url – URL for the new `Request` object.

      - **kwargs – Optional arguments that `request` takes.

    Return type:

      requests.Response

  headers: CaseInsensitiveDict[str]

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

  hooks: dict[str, list[_t.HookType]]

    Event-handling hooks.

  max_redirects: int

    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: str, proxies: dict[str, str] | None, stream: bool | None, verify: _t.VerifyType | None, cert: _t.CertType) → dict[str, Any]

    Check the environment and merge it with some settings.

    Return type:

      dict

  mount(prefix: str, adapter: BaseAdapter) → None

    Registers a connection adapter to a prefix.

    Adapters are sorted in descending order by prefix length.

  options(url: _t.UriType, **kwargs: Unpack[_t.RequestKwargs]) → Response

    Sends a OPTIONS request. Returns `Response` object.

    Parameters:

      - url – URL for the new `Request` object.

      - **kwargs – Optional arguments that `request` takes.

    Return type:

      requests.Response

  params: MutableMapping[str, Any]

    Dictionary of querystring data to attach to each `Request`. The dictionary values may be lists for representing multivalued query parameters.

  patch(url: _t.UriType, data: _t.DataType = None, **kwargs: Unpack[_t.DataKwargs]) → Response

    Sends a PATCH request. Returns `Response` object.

    Parameters:

      - url – URL for the new `Request` object.

      - data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the `Request`.

      - **kwargs – Optional arguments that `request` takes.

    Return type:

      requests.Response

  post(url: _t.UriType, data: _t.DataType = None, json: _t.JsonType = None, **kwargs: Unpack[_t.PostKwargs]) → Response

    Sends a POST request. Returns `Response` object.

    Parameters:

      - url – URL for the new `Request` object.

      - data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the `Request`.

      - json – (optional) json to send in the body of the `Request`.

      - **kwargs – Optional arguments that `request` takes.

    Return type:

      requests.Response

  prepare_request(request: Request) → PreparedRequest

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

    Parameters:

      request – `Request` instance to prepare with this session’s settings.

    Return type:

      requests.PreparedRequest

  proxies: dict[str, str]

    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: _t.UriType, data: _t.DataType = None, **kwargs: Unpack[_t.DataKwargs]) → Response

    Sends a PUT request. Returns `Response` object.

    Parameters:

      - url – URL for the new `Request` object.

      - data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the `Request`.

      - **kwargs – Optional arguments that `request` takes.

    Return type:

      requests.Response

  rebuild_auth(prepared_request: PreparedRequest, response: Response) → None

    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: PreparedRequest, response: Response) → None

    When being redirected we may want to change the method of the request based on certain specs or browser behavior.

  rebuild_proxies(prepared_request: PreparedRequest, proxies: dict[str, str] | None) → dict[str, str]

    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.

    Return type:

      dict

  request(method: str, url: _t.UriType, params: _t.ParamsType = None, data: _t.DataType = None, headers: _t.HeadersType = None, cookies: RequestsCookieJar | CookieJar | dict[str, str] | None = None, files: _t.FilesType = None, auth: _t.AuthType = None, timeout: _t.TimeoutType = None, allow_redirects: bool = True, proxies: dict[str, str] | None = None, hooks: _t.HooksInputType | None = None, stream: bool | None = None, verify: _t.VerifyType | None = None, cert: _t.CertType = None, json: _t.JsonType = None) → Response

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

    Parameters:

      - method – method for the new `Request` object.

      - url – URL for the new `Request` object.

      - params – (optional) Dictionary or bytes to be sent in the query string for the `Request`.

      - data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the `Request`.

      - json – (optional) json to send in the body of the `Request`.

      - headers – (optional) Dictionary of HTTP Headers to send with the `Request`.

      - cookies – (optional) Dict or CookieJar object to send with the `Request`.

      - files – (optional) Dictionary of `'filename': file-like-objects` for multipart encoding upload.

      - auth – (optional) Auth tuple or callable to enable Basic/Digest/Custom HTTP Auth.

      - timeout (float or tuple) – (optional) How many seconds to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple.

      - allow_redirects (bool) – (optional) Set to True by default.

      - proxies – (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy.

      - hooks – (optional) Dictionary mapping hook name to one event or list of events, event must be callable.

      - stream – (optional) whether to immediately download the response content. Defaults to `False`.

      - verify – (optional) Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. Defaults to `True`. When 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. Setting verify to `False` may be useful during local development or testing.

      - cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair.

    Return type:

      requests.Response

  resolve_redirects(resp: Response, req: PreparedRequest, stream: bool = False, timeout: _t.TimeoutType = None, verify: _t.VerifyType = True, cert: _t.CertType = None, proxies: dict[str, str] | None = None, yield_requests: bool = False, **adapter_kwargs: Any) → Generator[Response, None, None]

    Receives a Response. Returns a generator of Responses or Requests.

  send(request: PreparedRequest, **kwargs: Any) → Response

    Send a given PreparedRequest.

    Return type:

      requests.Response

  should_strip_auth(old_url: str, new_url: str) → bool

    Decide whether Authorization header should be removed when redirecting

  stream: bool

    Stream response content default.

  trust_env: bool

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

  verify: _t.VerifyType

    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. If verify is set to a string, it must be the path to a CA bundle file that will be used to verify the TLS certificate.

## Lower-Level Classes

class requests.Request(method: str | None = None, url: _t.UriType | None = None, headers: _t.HeadersType = None, files: _t.FilesType = None, data: _t.DataType = None, params: _t.ParamsType = None, auth: _t.AuthType = None, cookies: RequestsCookieJar | CookieJar | dict[str, str] | None = None, hooks: _t.HooksInputType | None = None, json: _t.JsonType = None)

  A user-created `Request` object.

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

  Parameters:

    - method – HTTP method to use.

    - url – URL to send.

    - headers – dictionary of headers to send.

    - files – dictionary of {filename: fileobject} files to multipart upload.

    - data – the body to attach to the request. If a dictionary or list of tuples `[(key, value)]` is provided, form-encoding will take place.

    - json – json for the body to attach to the request (if files or data is not specified).

    - params – URL parameters to append to the URL. If a dictionary or list of tuples `[(key, value)]` is provided, form-encoding will take place.

    - auth – Auth handler or (user, pass) tuple.

    - cookies – dictionary or CookieJar of cookies to attach to this request.

    - hooks – dictionary of callback hooks, for internal usage.

  Usage:

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

  deregister_hook(event: str, hook: _t.HookType) → bool

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

  prepare() → PreparedRequest

    Constructs a `PreparedRequest` for transmission and returns it.

  register_hook(event: str, hook: Iterable[_t.HookType] | _t.HookType) → None

    Properly register a hook.

class requests.Response

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

  property apparent_encoding: str | None

    The apparent encoding, provided by the charset_normalizer or chardet libraries.

  close() → None

    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.

  property content: bytes

    Content of the response, in bytes.

  cookies: RequestsCookieJar

    A CookieJar of Cookies the server sent back.

  elapsed: datetime.timedelta

    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: str | None

    Encoding to decode with when accessing r.text.

  headers: CaseInsensitiveDict[str]

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

  history: list[Response]

    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.

  property is_redirect: bool

    True if this Response is a well-formed HTTP redirect that could have been processed automatically (by `Session.resolve_redirects`).

  iter_content(chunk_size: int | None = 1, decode_unicode: Literal[False] = False) → Iterator[bytes]
  iter_content(chunk_size: int | None = 1, *, decode_unicode: Literal[True]) → Iterator[str | bytes]

    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 encoding information from the response. If no encoding information is available, bytes will be returned. This can be bypassed by manually setting encoding on the response.

  iter_lines(chunk_size: int = ITER_CHUNK_SIZE, decode_unicode: Literal[False] = False, delimiter: bytes | None = None) → Iterator[bytes]
  iter_lines(chunk_size: int = ITER_CHUNK_SIZE, *, decode_unicode: Literal[True], delimiter: str | bytes | None = None) → Iterator[str | bytes]

    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.

    The decode_unicode param works the same as in iter_content, with the same caveats.

    Note

    This method is not reentrant safe.

  json(**kwargs: Any) → Any

    Decodes the JSON response body (if any) as a Python object.

    This may return a dictionary, list, etc. depending on what is in the response.

    Parameters:

      **kwargs – Optional arguments that `json.loads` takes.

    Raises:

      requests.exceptions.JSONDecodeError – If the response body does not contain valid json.

  property links: dict[str, dict[str, str]]

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

  property next: PreparedRequest | None

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

  property ok: bool

    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() → None

    Raises `HTTPError`, if one occurred.

  raw: Any

    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: str

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

  request: PreparedRequest

    The `PreparedRequest` object to which this is a response.

  status_code: int

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

  property text: str

    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: str

    Final URL location of Response.

## Lower-Lower-Level Classes

class requests.PreparedRequest

  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: _t.BodyType

    request body to send to the server.

  deregister_hook(event: str, hook: _t.HookType) → bool

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

  headers: CaseInsensitiveDict[str | bytes]

    dictionary of HTTP headers.

  hooks: dict[str, list[_t.HookType]]

    dictionary of callback hooks, for internal usage.

  method: str | None

    HTTP verb to send to the server.

  property path_url: str

    Build the path URL to use.

  prepare(method: str | None = None, url: _t.UriType | None = None, headers: Mapping[str, str | bytes] | None = None, files: _t.FilesType = None, data: _t.DataType = None, params: _t.ParamsType = None, auth: _t.AuthType = None, cookies: RequestsCookieJar | CookieJar | dict[str, str] | None = None, hooks: _t.HooksInputType | None = None, json: _t.JsonType = None) → None

    Prepares the entire request with the given parameters.

  prepare_auth(auth: _t.AuthType, url: _t.UriType = '') → None

    Prepares the given HTTP auth data.

  prepare_body(data: _t.DataType, files: _t.FilesType, json: _t.JsonType = None) → None

    Prepares the given HTTP body data.

  prepare_content_length(body: _t.BodyType) → None

    Prepare Content-Length header based on request method and body

  prepare_cookies(cookies: RequestsCookieJar | CookieJar | dict[str, str] | None) → None

    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: Mapping[str, str | bytes] | None) → None

    Prepares the given HTTP headers.

  prepare_hooks(hooks: _t.HooksInputType | None) → None

    Prepares the given hooks.

  prepare_method(method: str | None) → None

    Prepares the given HTTP method.

  prepare_url(url: _t.UriType, params: _t.ParamsType) → None

    Prepares the given HTTP URL.

  register_hook(event: str, hook: Iterable[_t.HookType] | _t.HookType) → None

    Properly register a hook.

  url: str | None

    HTTP URL to send the request to.

class requests.adapters.BaseAdapter

  The Base Transport Adapter

  close() → None

    Cleans up adapter specific items.

  send(request: PreparedRequest, stream: bool = False, timeout: _t.TimeoutType = None, verify: _t.VerifyType = True, cert: _t.CertType = None, proxies: dict[str, str] | None = None) → Response

    Sends PreparedRequest object. Returns Response object.

    Parameters:

      - request – The `PreparedRequest` being sent.

      - stream – (optional) Whether to stream the request content.

      - timeout (float or tuple) – (optional) How long to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple.

      - verify – (optional) Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use

      - cert – (optional) Any user-provided SSL certificate to be trusted.

      - proxies – (optional) The proxies dictionary to apply to the request.

class requests.adapters.HTTPAdapter(pool_connections: int = 10, pool_maxsize: int = 10, max_retries: int | Retry = 0, pool_block: bool = False)

  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.

  Parameters:

    - pool_connections – The number of urllib3 connection pools to cache.

    - pool_maxsize – The maximum number of connections to save in the pool.

    - max_retries – The maximum number of retries each connection should attempt. Note, this applies only to failed DNS lookups, socket connections and connection timeouts, never to requests where data has made it to the server. By default, Requests does not retry failed connections. If you need granular control over the conditions under which we retry a request, import urllib3’s `Retry` class and pass that instead.

    - pool_block – Whether the connection pool should block for connections.

  Usage:

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

  add_headers(request: PreparedRequest, **kwargs: Any) → None

    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`.

    Parameters:

      - request – The `PreparedRequest` to add headers to.

      - kwargs – The keyword arguments from the call to send().

  build_connection_pool_key_attributes(request: PreparedRequest, verify: _t.VerifyType, cert: _t.CertType = None) → tuple[dict[str, Any], dict[str, Any]]

    Build the PoolKey attributes used by urllib3 to return a connection.

    This looks at the PreparedRequest, the user-specified verify value, and the value of the cert parameter to determine what PoolKey values to use to select a connection from a given urllib3 Connection Pool.

    The SSL related pool key arguments are not consistently set. As of this writing, use the following to determine what keys may be in that dictionary:

    - If `verify` is `True`, `"ssl_context"` will be set and will be the default Requests SSL Context

    - If `verify` is `False`, `"ssl_context"` will not be set but `"cert_reqs"` will be set

    - If `verify` is a string, (i.e., it is a user-specified trust bundle) `"ca_certs"` will be set if the string is not a directory recognized by `os.path.isdir`, otherwise `"ca_cert_dir"` will be set.

    - If `"cert"` is specified, `"cert_file"` will always be set. If `"cert"` is a tuple with a second item, `"key_file"` will also be present

    To override these settings, one may subclass this class, call this method and use the above logic to change parameters as desired. For example, if one wishes to use a custom `ssl.SSLContext` one must both set `"ssl_context"` and based on what else they require, alter the other keys to ensure the desired behaviour.

    Parameters:

      - request (`PreparedRequest`) – The PreparedRequest being sent over the connection.

      - verify – Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use.

      - cert – (optional) Any user-provided SSL certificate for client authentication (a.k.a., mTLS). This may be a string (i.e., just the path to a file which holds both certificate and key) or a tuple of length 2 with the certificate file path and key file path.

    Returns:

      A tuple of two dictionaries. The first is the “host parameters” portion of the Pool Key including scheme, hostname, and port. The second is a dictionary of SSLContext related parameters.

  build_response(req: PreparedRequest, resp: Any) → Response

    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`

    Parameters:

      - req – The `PreparedRequest` used to generate the response.

      - resp – The urllib3 response object.

    Return type:

      requests.Response

  cert_verify(conn: Any, url: str, verify: _t.VerifyType, cert: _t.CertType) → None

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

    Parameters:

      - conn – The urllib3 connection object associated with the cert.

      - url – The requested URL.

      - verify – Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use

      - cert – The SSL certificate to verify.

  close() → None

    Disposes of any internal state.

    Currently, this closes the PoolManager and any active ProxyManager, which closes any pooled connections.

  get_connection(url: str, proxies: dict[str, str] | None = None) → HTTPConnectionPool

    DEPRECATED: Users should move to get_connection_with_tls_context for all subclasses of HTTPAdapter using Requests>=2.32.2.

    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`.

    Parameters:

      - url – The URL to connect to.

      - proxies – (optional) A Requests-style dictionary of proxies used on this request.

    Return type:

      urllib3.HTTPConnectionPool

  get_connection_with_tls_context(request: PreparedRequest, verify: _t.VerifyType, proxies: dict[str, str] | None = None, cert: _t.CertType = None) → HTTPConnectionPool

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

    Parameters:

      - request – The `PreparedRequest` object to be sent over the connection.

      - verify – Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use.

      - proxies – (optional) The proxies dictionary to apply to the request.

      - cert – (optional) Any user-provided SSL certificate to be used for client authentication (a.k.a., mTLS).

    Return type:

      urllib3.HTTPConnectionPool

  init_poolmanager(connections: int, maxsize: int, block: bool = False, **pool_kwargs: Any) → None

    Initializes a urllib3 PoolManager.

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

    Parameters:

      - connections – The number of urllib3 connection pools to cache.

      - maxsize – The maximum number of connections to save in the pool.

      - block – Block when no free connections are available.

      - pool_kwargs – Extra keyword arguments used to initialize the Pool Manager.

  proxy_headers(proxy: str) → dict[str, str]

    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`.

    Parameters:

      proxy – The url of the proxy being used for this request.

    Return type:

      dict

  proxy_manager_for(proxy: str, **proxy_kwargs: Any) → Any

    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`.

    Parameters:

      - proxy – The proxy to return a urllib3 ProxyManager for.

      - proxy_kwargs – Extra keyword arguments used to configure the Proxy Manager.

    Returns:

      ProxyManager

    Return type:

      urllib3.ProxyManager

  request_url(request: PreparedRequest, proxies: dict[str, str] | None) → str

    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`.

    Parameters:

      - request – The `PreparedRequest` being sent.

      - proxies – A dictionary of schemes or schemes and hosts to proxy URLs.

    Return type:

      str

  send(request: PreparedRequest, stream: bool = False, timeout: _t.TimeoutType = None, verify: _t.VerifyType = True, cert: _t.CertType = None, proxies: dict[str, str] | None = None) → Response

    Sends PreparedRequest object. Returns Response object.

    Parameters:

      - request – The `PreparedRequest` being sent.

      - stream – (optional) Whether to stream the request content.

      - timeout (float or tuple or urllib3 Timeout object) – (optional) How long to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple.

      - verify – (optional) Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use

      - cert – (optional) Any user-provided SSL certificate to be trusted.

      - proxies – (optional) The proxies dictionary to apply to the request.

    Return type:

      requests.Response

## Authentication

class requests.auth.AuthBase

  Base class that all auth implementations derive from

class requests.auth.HTTPBasicAuth(username: str, password: str)
class requests.auth.HTTPBasicAuth(username: bytes, password: bytes)

  Attaches HTTP Basic Authentication to the given Request object.

class requests.auth.HTTPProxyAuth(username: str, password: str)
class requests.auth.HTTPProxyAuth(username: bytes, password: bytes)

  Attaches HTTP Proxy Authentication to a given Request object.

class requests.auth.HTTPDigestAuth(username: str, password: str)
class requests.auth.HTTPDigestAuth(username: bytes, password: bytes)

  Attaches HTTP Digest Authentication to the given Request object.

## Encodings

requests.utils.get_encodings_from_content(content: str) → list[str]

  Returns encodings from given content string.

  Parameters:

    content – bytestring to extract encodings from.

requests.utils.get_encoding_from_headers(headers: CaseInsensitiveDict[str]) → str | None

  Returns encodings from given HTTP Header Dict.

  Parameters:

    headers – dictionary to extract encoding from.

  Return type:

    str

requests.utils.get_unicode_from_response(r: Response) → str | bytes | None

  Returns the requested content back in unicode.

  Parameters:

    r – Response object to get unicode content from.

  Tried:

  1. charset from content-type

  2. fall back and replace all unicode characters

  Return type:

    str

## Cookies

requests.utils.dict_from_cookiejar(cj: CookieJar) → dict[str, str | None]

  Returns a key/value dictionary from a CookieJar.

  Parameters:

    cj – CookieJar object to extract cookies from.

  Return type:

    dict

requests.utils.add_dict_to_cookiejar(cj: CookieJar, cookie_dict: dict[str, str]) → CookieJar

  Returns a CookieJar from a key/value dictionary.

  Parameters:

    - cj – CookieJar to insert cookies into.

    - cookie_dict – Dict of key/values to insert into CookieJar.

  Return type:

    CookieJar

requests.cookies.cookiejar_from_dict(cookie_dict: dict[str, str] | None, cookiejar: None = None, overwrite: bool = True) → RequestsCookieJar
requests.cookies.cookiejar_from_dict(cookie_dict: dict[str, str] | None, cookiejar: _CookieJarT, overwrite: bool = True) → _CookieJarT

  Returns a CookieJar from a key/value dictionary.

  Parameters:

    - cookie_dict – Dict of key/values to insert into CookieJar.

    - cookiejar – (optional) A cookiejar to add the cookies to.

    - overwrite – (optional) If False, will not replace cookies already in the jar with new ones.

  Return type:

    CookieJar

class requests.cookies.RequestsCookieJar(policy=None)

  Compatibility class; is a http.cookiejar.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 (urllib.request.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() → RequestsCookieJar

    Return a copy of this RequestsCookieJar.

  extract_cookies(response, request)

    Extract cookies from response, where allowable given the request.

  get(name: str, default: str | None = None, domain: str | None = None, path: str | None = None) → str | None

    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: str | None = None, path: str | None = None) → dict[str, str | None]

    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.

    Return type:

      dict

  get_policy() → CookiePolicy

    Return the CookiePolicy instance used.

  items() → list[tuple[str, str | None]]

    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() → Iterator[tuple[str, str | None]]

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

    See also

    iterkeys() and itervalues().

  iterkeys() → Iterator[str]

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

    See also

    itervalues() and iteritems().

  itervalues() → Iterator[str | None]

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

    See also

    iterkeys() and iteritems().

  keys() → list[str]

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

    See also

    values() and items().

  list_domains() → list[str]

    Utility method to list all the domains in the jar.

  list_paths() → list[str]

    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() → bool

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

    Return type:

      bool

  pop(k[, d]) → v, remove specified key and return the corresponding

    value. If key is not found, d is returned if given, otherwise KeyError is raised.

  popitem() → (k, v), remove and return some (key, value) pair

    as a 2-tuple; but raise KeyError if D is empty.

  set(name: str, value: str | Morsel[dict[str, str]] | None, **kwargs: Any) → Cookie | None

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

  set_cookie(cookie: Cookie, *args: Any, **kwargs: Any) → None

    Set a cookie, without checking whether or not it should be set.

  set_cookie_if_ok(cookie, request)

    Set a cookie if policy says it’s OK to do so.

  setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D
  update(other: CookieJar | SupportsKeysAndGetItem[str, str]) → None

    Updates this jar with cookies from another CookieJar or dict-like

  values() → list[str | None]

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

    See also

    keys() and items().

class requests.cookies.CookieConflictError

  There are two cookies that meet the criteria specified in the cookie jar. Use .get and .set and include domain and path args in order to be more specific.

  add_note(note, /)

    Add a note to the exception

  with_traceback(tb, /)

    Set self.__traceback__ to tb and return self.

## Status Code Lookup

requests.codes

  alias of {}

The `codes` object defines a mapping from common names for HTTP statuses to their numerical codes, accessible either as attributes or as dictionary items.

Example:

    >>> import requests
    >>> requests.codes['temporary_redirect']
    307
    >>> requests.codes.teapot
    418
    >>> requests.codes['\o/']
    200

Some codes have multiple names, and both upper- and lower-case versions of the names are allowed. For example, `codes.ok`, `codes.OK`, and `codes.okay` all correspond to the HTTP status code 200.

- 100: `continue`

- 101: `switching_protocols`

- 102: `processing`, `early-hints`

- 103: `checkpoint`

- 122: `uri_too_long`, `request_uri_too_long`

- 200: `ok`, `okay`, `all_ok`, `all_okay`, `all_good`, `\o/`, `✓`

- 201: `created`

- 202: `accepted`

- 203: `non_authoritative_info`, `non_authoritative_information`

- 204: `no_content`

- 205: `reset_content`, `reset`

- 206: `partial_content`, `partial`

- 207: `multi_status`, `multiple_status`, `multi_stati`, `multiple_stati`

- 208: `already_reported`

- 226: `im_used`

- 300: `multiple_choices`

- 301: `moved_permanently`, `moved`, `\o-`

- 302: `found`

- 303: `see_other`, `other`

- 304: `not_modified`

- 305: `use_proxy`

- 306: `switch_proxy`

- 307: `temporary_redirect`, `temporary_moved`, `temporary`

- 308: `permanent_redirect`, `resume_incomplete`, `resume`

- 400: `bad_request`, `bad`

- 401: `unauthorized`

- 402: `payment_required`, `payment`

- 403: `forbidden`

- 404: `not_found`, `-o-`

- 405: `method_not_allowed`, `not_allowed`

- 406: `not_acceptable`

- 407: `proxy_authentication_required`, `proxy_auth`, `proxy_authentication`

- 408: `request_timeout`, `timeout`

- 409: `conflict`

- 410: `gone`

- 411: `length_required`

- 412: `precondition_failed`, `precondition`

- 413: `request_entity_too_large`, `content_too_large`

- 414: `request_uri_too_large`, `uri_too_long`

- 415: `unsupported_media_type`, `unsupported_media`, `media_type`

- 416: `requested_range_not_satisfiable`, `requested_range`, `range_not_satisfiable`

- 417: `expectation_failed`

- 418: `im_a_teapot`, `teapot`, `i_am_a_teapot`

- 421: `misdirected_request`

- 422: `unprocessable_entity`, `unprocessable`, `unprocessable_content`

- 423: `locked`

- 424: `failed_dependency`, `dependency`

- 425: `unordered_collection`, `unordered`, `too_early`

- 426: `upgrade_required`, `upgrade`

- 428: `precondition_required`, `precondition`

- 429: `too_many_requests`, `too_many`

- 431: `header_fields_too_large`, `fields_too_large`

- 444: `no_response`, `none`

- 449: `retry_with`, `retry`

- 450: `blocked_by_windows_parental_controls`, `parental_controls`

- 451: `unavailable_for_legal_reasons`, `legal_reasons`

- 499: `client_closed_request`

- 500: `internal_server_error`, `server_error`, `/o\`, `✗`

- 501: `not_implemented`

- 502: `bad_gateway`

- 503: `service_unavailable`, `unavailable`

- 504: `gateway_timeout`

- 505: `http_version_not_supported`, `http_version`

- 506: `variant_also_negotiates`

- 507: `insufficient_storage`

- 509: `bandwidth_limit_exceeded`, `bandwidth`

- 510: `not_extended`

- 511: `network_authentication_required`, `network_auth`, `network_authentication`

## Migrating to 1.x

This section details the main differences between 0.x and 1.x and is meant to ease the pain of upgrading.

### API Changes

- `Response.json` is now a callable and not a property of a response.

      import requests
      r = requests.get('https://api.github.com/events')
      r.json()   # This *call* raises an exception if JSON decoding fails

- The `Session` API has changed. Sessions objects no longer take parameters. `Session` is also now capitalized, but it can still be instantiated with a lowercase `session` for backwards compatibility.

      s = requests.Session()    # formerly, session took parameters
      s.auth = auth
      s.headers.update(headers)
      r = s.get('https://httpbin.org/headers')

- All request hooks have been removed except ‘response’.

- Authentication helpers have been broken out into separate modules. See requests-oauthlib and requests-kerberos.

- The parameter for streaming requests was changed from `prefetch` to `stream` and the logic was inverted. In addition, `stream` is now required for raw response reading.

      # in 0.x, passing prefetch=False would accomplish the same thing
      r = requests.get('https://api.github.com/events', stream=True)
      for chunk in r.iter_content(8192):
          ...

- The `config` parameter to the requests method has been removed. Some of these options are now configured on a `Session` such as keep-alive and maximum number of redirects. The verbosity option should be handled by configuring logging.

      import requests
      import logging

      # Enabling debugging at http.client level (requests->urllib3->http.client)
      # you will see the REQUEST, including HEADERS and DATA, and RESPONSE with HEADERS but without DATA.
      # the only thing missing will be the response.body which is not logged.
      try: # for Python 3
          from http.client import HTTPConnection
      except ImportError:
          from httplib import HTTPConnection
      HTTPConnection.debuglevel = 1

      logging.basicConfig() # you need to initialize logging, otherwise you will not see anything from requests
      logging.getLogger().setLevel(logging.DEBUG)
      requests_log = logging.getLogger("urllib3")
      requests_log.setLevel(logging.DEBUG)
      requests_log.propagate = True

      requests.get('https://httpbin.org/headers')

### Licensing

One key difference that has nothing to do with the API is a change in the license from the ISC license to the Apache 2.0 license. The Apache 2.0 license ensures that contributions to Requests are also covered by the Apache 2.0 license.

## Migrating to 2.x

Compared with the 1.0 release, there were relatively few backwards incompatible changes, but there are still a few issues to be aware of with this major release.

For more details on the changes in this release including new APIs, links to the relevant GitHub issues and some of the bug fixes, read Cory’s blog on the subject.

### API Changes

- There were a couple changes to how Requests handles exceptions. `RequestException` is now a subclass of `IOError` rather than `RuntimeError` as that more accurately categorizes the type of error. In addition, an invalid URL escape sequence now raises a subclass of `RequestException` rather than a `ValueError`.

      requests.get('http://%zz/')   # raises requests.exceptions.InvalidURL

  Lastly, `httplib.IncompleteRead` exceptions caused by incorrect chunked encoding will now raise a Requests `ChunkedEncodingError` instead.

- The proxy API has changed slightly. The scheme for a proxy URL is now required.

      proxies = {
        "http": "10.10.1.10:3128",    # use http://10.10.1.10:3128 instead
      }

      # In requests 1.x, this was legal, in requests 2.x,
      #  this raises requests.exceptions.MissingSchema
      requests.get("http://example.org", proxies=proxies)

### Behavioural Changes

- Keys in the `headers` dictionary are now native strings on all Python versions, i.e. bytestrings on Python 2 and unicode on Python 3. If the keys are not native strings (unicode on Python 2 or bytestrings on Python 3) they will be converted to the native string type assuming UTF-8 encoding.

- Values in the `headers` dictionary should always be strings. This has been the project’s position since before 1.0 but a recent change (since version 2.11.0) enforces this more strictly. It’s advised to avoid passing header values as unicode when possible.