request
Advanced tools
Package description
The 'request' npm package is a simple, yet powerful HTTP client that supports multiple features such as making HTTP calls, handling responses, streaming data, and more. It is designed to be the simplest way possible to make http calls and supports HTTPS and follows redirects by default.
Simple HTTP GET requests
This code performs a simple HTTP GET request to Google's homepage and logs the error, response status code, and the response body.
const request = require('request');
request('http://www.google.com', function (error, response, body) {
console.log('error:', error);
console.log('statusCode:', response && response.statusCode);
console.log('body:', body);
});Streaming data
This code demonstrates how to stream data from an HTTP request directly to a file, which can be useful for downloading files or handling large amounts of data.
const request = require('request');
const fs = require('fs');
const stream = fs.createWriteStream('file.txt');
request('http://www.google.com').pipe(stream);Custom HTTP headers
This code shows how to send a custom HTTP header (in this case, the User-Agent header) with a request. This is often required when using certain APIs, like GitHub's.
const request = require('request');
const options = {
url: 'https://api.github.com/repos/request/request',
headers: {
'User-Agent': 'request'
}
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
const info = JSON.parse(body);
console.log(info);
}
}
request(options, callback);Handling POST requests
This code snippet demonstrates how to send a POST request with form data, including how to upload a file as part of that form data.
const request = require('request');
const options = {
method: 'POST',
url: 'http://service.com/upload',
headers: {
'Content-Type': 'multipart/form-data'
},
formData: {
key: 'value',
file: fs.createReadStream('file.txt')
}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});Axios is a promise-based HTTP client for the browser and Node.js. It provides a simple API for making HTTP requests and is often used as an alternative to 'request' due to its promise support and interceptors for request/response manipulation.
Got is a human-friendly and powerful HTTP request library. It is designed to be a simpler and more performant alternative to 'request', with features like streams support, promise API, and better error handling.
Node-fetch is a light-weight module that brings the Fetch API to Node.js. It is an alternative to 'request' that provides a simpler, promise-based API for making HTTP requests, similar to what is available in modern web browsers.
Superagent is a small progressive client-side HTTP request library, and Node.js module with the same API, sporting many high-level HTTP client features. It compares to 'request' by offering a fluent API and being lightweight.
Readme
npm install request
Or from source:
git clone git://github.com/mikeal/request.git cd request npm link .
Request is designed to be the simplest way possible to make http calls. It support HTTPS and follows redirects by default.
var request = require('request');
request({uri:'http://www.google.com'}, function (error, response, body) {
if (!error && response.statusCode == 200) {
sys.puts(body) // Print the google web page.
}
})
The first argument is an options object. The only required option is uri, all others are optional.
uri || url - fully qualified uri or a parsed url object from url.parse()method - http method, defaults to GETheaders - http headers, defaults to {}body - entity body for POST and PUT requests. Must be buffer or string.json - sets body but to JSON representation of value and adds Content-type: application/json header.multipart - (experimental) array of objects which contains their own headers and body attribute. Sends multipart/related request. See example below.followRedirect - follow HTTP 3xx responses as redirects. defaults to true.maxRedirects - the maximum number of redirects to follow, defaults to 10.onResponse - If true the callback will be fired on the "response" event instead of "end". If a function it will be called on "response" and not effect the regular semantics of the main callback on "end".encoding - Encoding to be used on response.setEncoding when buffering the response data.pool - A hash object containing the agents for these requests. If omitted this request will use the global pool which is set to node's default maxSockets.pool.maxSockets - Integer containing the maximum amount of sockets in the pool.The callback argument gets 3 arguments. The first is an error when applicable (usually from the http.Client option not the http.ClientRequest object). The second in an http.ClientResponse object. The third is the response body buffer.
Examples:
var request = require('request');
var rand = Math.floor(Math.random()*100000000).toString();
request(
{ method: 'PUT'
, uri: 'http://mikeal.couchone.com/testjs/' + rand
, multipart:
[ { 'content-type': 'application/json'
, body: JSON.stringify({foo: 'bar', _attachments: {'message.txt': {follows: true, length: 18, 'content_type': 'text/plain' }}})
}
, { body: 'I am an attachment' }
]
}
, function (error, response, body) {
if(response.statusCode == 201){
console.log('document saved as: http://mikeal.couchone.com/testjs/'+ rand);
} else {
console.log('error: '+ response.statusCode);
console.log(body);
}
}
)
Notice for 2.0
You should no longer recycle mutations in the options object. Because node 0.4.0 has an internal pooling mechanism the preferred way of sharing a connection is using agents which request simplifies with it's new pool API. Therefor options.client and some other mutations have been deprecated.
requestBodyStream and responseBodyStream are also deprecated in favor of a more standard pipe interface documented below.
Previous versions of request had no return value and only accepted callbacks and streams for pumping in the options object.
Node has solidified it's Stream interface and request 2.0 is now compliant with that interface.
The return value of request() is now a Request object, which is a valid stream.
As a writable stream it accepts the body of an HTTP request. As a readable stream it emits the data events for the response.
var r = request(
{ url: "http://mysite.com/image.png"
, method: 'PUT'
, headers: {'content-type': 'image/png'}
}
)
fs.createReadStream('image.png').pipe(r)
r.pipe(fs.createWriteStream('pushlog.txt'))
This method returns a wrapper around the normal request API that defaults to whatever options you pass in to it.
Same as request() but defaults to method: "PUT".
Same as request() but defaults to method: "POST".
Same as request() but defaults to method: "HEAD".
Alias to normal request method for uniformity.
FAQs
Unknown package
We found that request demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A threat actor on BreachForums is selling an unverified npm vulnerability for account takeover, but npm has not officially confirmed the existence of this security concern.
Security News
Cyber insurance rates are dropping as the market matures, according to a new report projecting global premiums to reach $43 billion by 2030, driven by international market uptake and growth in the SME sector.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.