Python requests.POST(): Complete Guide for Making HTTP POST Requests

The requests.post() method is a powerful tool in Python for sending HTTP POST requests to web servers. It's essential for submitting forms, uploading files, and interacting with APIs.

Basic POST Request

Before using requests, make sure you have it installed. If not, you can learn how to install it in our guide on solving the No module named requests error.

import requests

url = "https://api.example.com/data"
response = requests.post(url)
print(response.status_code)

Sending Data with POST Request

You can send data using the data parameter. This is commonly used when submitting forms or sending JSON data to APIs.

import requests

url = "https://api.example.com/user"
data = {
    "username": "john_doe",
    "email": "john@example.com"
}
response = requests.post(url, data=data)
print(response.text)

Sending JSON Data

For API interactions, JSON is a common format. Use the json parameter to automatically handle JSON encoding.

import requests

url = "https://api.example.com/data"
json_data = {
    "name": "John",
    "age": 30
}
response = requests.post(url, json=json_data)
print(response.json())

Adding Headers

Headers are crucial for authentication and specifying content types. Learn more about handling headers in our guide on sending requests with headers and data.

import requests

url = "https://api.example.com/data"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_TOKEN"
}
response = requests.post(url, headers=headers)

Handling Response

Always check the response status code to ensure your request was successful. See our guide on getting request status codes for more details.

import requests

try:
    response = requests.post("https://api.example.com/data")
    response.raise_for_status()
    print("Success:", response.json())
except requests.exceptions.RequestException as e:
    print("Error:", e)

File Upload

You can upload files using the files parameter in your POST request.

import requests

url = "https://api.example.com/upload"
files = {
    'file': open('document.pdf', 'rb')
}
response = requests.post(url, files=files)

Using Proxies

For enhanced security or accessing restricted content, you might need to use proxies. Learn more in our guide about using Python requests with proxies.

Conclusion

requests.post() is a versatile method for making HTTP POST requests in Python. It supports various data formats, file uploads, and custom headers, making it essential for web development and API integration.