Skip to content

docs: improve GET request example with custom headers explanation #7074

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: improve GET request example with custom headers explanation #7074

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74cb948
docs: improve GET request example with custom headers explanation
Nikita20010 Oct 28, 2025
5e725f4
docs: add timeout handling example to quickstart guide
Nikita20010 Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions docs/user/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,25 @@ OPTIONS? These are all just as simple::
>>> r = requests.head('https://httpbin.org/get')
>>> r = requests.options('https://httpbin.org/get')

That's all well and good, but it's also only the start of what Requests can
do.
You can also specify **custom headers** while making a request, for example:

.. code-block:: python

import requests

url = "https://httpbin.org/get"
headers = {"User-Agent": "MyApp/1.0"}
response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())

>>> import requests
>>> try:
... r = requests.get('https://httpbin.org/delay/3', timeout=2)
... except requests.exceptions.Timeout:
... print("The request timed out")
... else:
... print("Request completed successfully:", r.status_code)


Passing Parameters In URLs
Expand Down