Unirest for Python 
Unirest is a set of lightweight HTTP libraries available in multiple languages, built and maintained by Mashape, who also maintain the open-source API Gateway Kong.
Features
- Make
GET,POST,PUT,PATCH,DELETErequests - Both syncronous and asynchronous (non-blocking) requests
- Supports form parameters, file uploads and custom body entities
- Supports gzip
- Supports Basic Authentication natively
- Customizable timeout
- Customizable default headers for every request (DRY)
- Automatic JSON parsing into a native object for JSON responses
Installing
To utilize Unirest, install it using pip:
$ pip install unirest
After installing the pip package, you can now begin simplifying requests by importing unirest:
import unirest
Creating Requests
So you're probably wondering how using Unirest makes creating requests in Python easier, let's start with a working example:
response = unirest.post("http://httpbin.org/post", headers={ "Accept": "application/json" }, params={ "parameter": 23, "foo": "bar" })
response.code # The HTTP status code
response.headers # The HTTP headers
response.body # The parsed response
response.raw_body # The unparsed response
Asynchronous Requests
Python also supports asynchronous requests in which you can define a callback function to be passed along and invoked when Unirest receives the response:
def callback_function(response):
response.code # The HTTP status code
response.headers # The HTTP headers
response.body # The parsed response
response.raw_body # The unparsed response
thread = unirest.post("http://httpbin.org/post", headers={ "Accept": "application/json" }, params={ "parameter": 23, "foo": "bar" }, callback=callback_function)
File Uploads
Transferring file data requires that you open the file in a readable r mode:
response = unirest.post("http://httpbin.org/post", headers={"Accept": "application/json"},
params={
"parameter": "value",
"file": open("/tmp/file", mode="r")
}
)
Custom Entity Body
import json
response = unirest.post("http://httpbin.org/post", headers={ "Accept": "application/json" },
params=json.dumps({
"parameter": "value",
"foo": "bar"
})
)
Note: For the sake of semplicity, even with custom entities in the body, the keyword argument is still params (instead of data for example). I'm looking for feedback on this.
Basic Authentication
Authenticating the request with basic authentication can be done by providing an auth array like:
response = unirest.get("http://httpbin.org/get", auth=('username', 'password'))
Request
unirest.get(url, headers = {}, params = {}, auth = (), callback = None)
unirest.post(url, headers = {}, params = {}, auth = (), callback = None)
unirest.put(url, headers = {}, params = {}, auth = (), callback = None)
unirest.patch(url, headers = {}, params = {}, auth = (), callback = None)
unirest.delete(url, headers = {}, params = {}, auth = (), callback = None)
url- Endpoint, address, or URI to be acted upon and requested information from in a string format.headers- Request Headers as an associative arrayparams- Request Body as an associative array or objectauth- The Basic Authentication credentials as an arraycallback- Asychronous callback method to be invoked upon result.
Response
Upon receiving a response, Unirest returns the result in the form of an Object. This object should always have the same keys for each language regarding to the response details.
code- HTTP Response Status Code (Example 200)headers- HTTP Response Headersbody- Parsed response body where applicable, for example JSON responses are parsed to Objects / Associative Arrays.raw_body- Un-parsed response body
Advanced Configuration
You can set some advanced configuration to tune Unirest-Python:
Timeout
You can set a custom timeout value (in seconds):
unirest.timeout(5) # 5s timeout
Default Request Headers
You can set default headers that will be sent on every request:
unirest.default_header('Header1','Value1')
unirest.default_header('Header2','Value2')
You can clear the default headers anytime with:
unirest.clear_default_headers()
Made with
13 Nov 19, 2022
32 Oct 1, 2022
21 Dec 25, 2022
151 Dec 31, 2022
1 Jan 24, 2022
1 Feb 15, 2022
5 Apr 28, 2022
4 Nov 16, 2022
7.9k Jan 2, 2023
3 Jul 14, 2022
6.2k Jan 8, 2023
756 Jan 6, 2023
7.3k Jan 1, 2023
3.8k Jan 1, 2023
2 May 24, 2022
0 Jun 29, 2022
81 Dec 26, 2022
7 Dec 16, 2022