Switch branches/tags
Find file
Fetching contributors…
Cannot retrieve contributors at this time
107 lines (82 sloc) 2.4 KB


A simple network request helper that is geared towards crawling. (a few keywords GZIP, XML, JSON, PROXIES)


$ npm install requester

super simple to use

var Requester = require('requester'),
	requester = new Requester();

requester.get(/* URL */, function (body) {

requester.get(/* URL */, /* REQUEST_OBJECT */, function (body) {


var Requester = ('requester');

var requester = new Requester({
	cookies: {},
	headers: {},
	timeout: 4000,
	retries: 3,
	encoding 'utf8',
	// didRequestFail: null, (this has its own section)
	// signRequest: null, (this has its own section)
	dataType: 'RAW' // JSON or XML,
	auth: {username: 'username', password: 'password'}, // basic auth for all requests
	proxies: [{ip: '', port: 1337}, {ip: '', port: 1337}, {ip: '', port: 1337}] // rotating proxy array

if you initialize the request object with any of the above properties every request will default to those settings, you can over ride them on a per request basis

var options = {
	encoding: 'binary',
	proxy: {ip: '', port: 1337},
	data: {foo: 'bar'},
	cookies: {foo: 'bar'},
	auth: {username: 'username', password: 'password'} // basic auth for request

requester.get(/* URL */, options, function (body) {

request objects

they support the following properties

  • {Object} data
  • {String} dataType
  • {Object} headers
  • {Object} cookies
  • {Object} proxy
  • {Object} auth
  • {String} encoding
  • {Number} timeout
  • {Number} retries
  • {Function} didRequestFail
  • {Function} signRequest

request signatures

you can create a custom request signature function like this

var qs = require('querystring');

var requester = new Requester({
	signRequest: function (data) {
		// do something with the data
		return qs.stringify(data);

posting* URL */, {data: {foo: 'bar', bar: 'foo'}}, function (body) {


the multipart request works a little different, in the data object you can prefix a values key with '@' like this

requester.multipart(/* URL */, {data: {'@file': /* FILEPATH */, '@file2': /* FILEPATH */, bar: 'foo'}}, function (body) {

this will create a multipart request and upload files