Python Requests head() Method
Example
Make a HEAD request to a web page, and return the HTTP headers:
import requests
x = requests.head('https://w3.p2hp.com/python/demopage.php')
print(x.headers)
Run Example »
Definition and Usage
The head()
method sends a HEAD request to the specified url.
HEAD requests are done when you do not need the content of the file, but only the status_code or HTTP headers.
Syntax
requests.head(url, args)
args means zero or more of the named arguments in the parameter table below. Example:
requests.head(url, timeout=2.50)
Parameter Values
Parameter | Description | |
---|---|---|
url | Try it | Required. The url of the request |
allow_redirects |
Try it Try it |
Optional. A Boolean to enable/disable redirection. Default False (not allowing redirects) |
auth | Try it | Optional. A tuple to enable a certain HTTP authentication. Default None |
cert | Try it | Optional. A String or Tuple specifying a cert file or key. Default None |
cookies | Try it | Optional. A dictionary of cookies to send to the specified url. Default None |
headers | Try it | Optional. A dictionary of HTTP headers to send to the specified url. Default None |
proxies | Try it | Optional. A dictionary of the protocol to the proxy url. Default None |
stream | Try it | Optional. A Boolean indication if the response should be immediately downloaded (False) or streamed (True). Default False |
timeout | Try it | Optional. A number, or a tuple, indicating how many seconds to wait for the client to make a connection and/or send a response. Default None which means the request will continue
until the connection is closed |
verify | Try it | Optional. A Boolean or a String indication to verify the servers TLS certificate or not. Default True |
Return Value
The head() method returns a requests.Response object.