Package - got

_{Huge thanks to these companies for helping make open source sustainable by sponsoring Sindre Sorhus}

^{Optimised Image Delivery made simple}

Simplified HTTP requests

Got is a human-friendly and powerful HTTP request library.

It was created because the popular request package is bloated:

Got is for Node.js. For browsers, we recommend Ky.

This readme reflects the next major version that is currently in development. You probably want the v9 readme.

Highlights

Promise & stream API
Request cancelation
RFC compliant caching
Follows redirects
Retries on failure
Progress events
Handles gzip/deflate/brotli
Timeout handling
Errors with metadata
JSON mode
WHATWG URL support
Hooks
Instances with custom defaults
Composable
Plugins
Electron support
Used by ~2000 packages and ~500K repos
Actively maintained

Moving from Request?

See how Got compares to other HTTP libraries

Install

$ npm install got

Usage

const got = require('got');

(async () => {
	try {
		const response = await got('https://sindresorhus.com');
		console.log(response.body);
		//=> '<!doctype html> ...'
	} catch (error) {
		console.log(error.response.body);
		//=> 'Internal server error ...'
	}
})();

Streams

const stream = require('stream');
const {promisify} = require('util');
const fs = require('fs');
const got = require('got');

const pipeline = promisify(stream.pipeline);

(async () => {
    await pipeline(
        got.stream('https://sindresorhus.com'),
        fs.createWriteStream('index.html')
    );

    // For POST, PUT, and PATCH methods `got.stream` returns a `stream.Writable`
    await pipeline(
        fs.createReadStream('index.html'),
        got.stream.post('https://sindresorhus.com')
    );
})();

Tip: Using from.pipe(to) doesn't forward errors. If you use it, switch to Stream.pipeline(from, ..., to, callback) instead (available from Node v10).

API

It's a GET request by default, but can be changed by using different methods or via options.method.

got([url], [options])

Returns a Promise for a response object or a stream if options.stream is set to true.

url

Type: string | object

The URL to request, as a string, a https.request options object, or a WHATWG URL.

Properties from options will override properties in the parsed url.

If no protocol is specified, it will throw a TypeError.

Note: this can also be an option.

options

Type: object

Any of the https.request options.

prefixUrl

Type: string | URL

When specified, prefixUrl will be prepended to url. The prefix can be any valid URL, either relative or absolute. A trailing slash / is optional, one will be added automatically, if needed, when joining prefixUrl and url. The url argument cannot start with a / when using this option.

Useful when used with got.extend() to create niche-specific Got-instances.

Note: prefixUrl will be ignored if the url argument is a URL instance.

const got = require('got');

(async () => {
	await got('unicorn', {prefixUrl: 'https://cats.com'});
	//=> 'https://cats.com/unicorn'
})();

headers

Type: object
Default: {}

Request headers.

Existing headers will be overwritten. Headers set to null will be omitted.

stream

Type: boolean
Default: false

Returns a Stream instead of a Promise. This is equivalent to calling got.stream(url, [options]).

body

Type: string | Buffer | stream.Readable or form-data instance

Note: The body option cannot be used with the json or form option.

Note: If you provide this option, got.stream() will be read-only.

If present in options and options.method is not set, it will throw a TypeError.

The content-length header will be automatically set if body is a string / Buffer / fs.createReadStream instance / form-data instance, and content-length and transfer-encoding are not manually set in options.headers.

json

Note: If you provide this option, got.stream() will be read-only.

JSON body. If the Content-Type header is not set, it will be set to application/json.

context

Type: object

User data. In contrast to other options, context is not enumerable.

Note: The object is never merged, it's just passed through. Got will not modify the object in any way.

It's very useful for storing auth tokens:

const got = require('got');

const instance = got.extend({
	hooks: {
		beforeRequest: [
			options => {
				if (!options.context && !options.context.token) {
					throw new Error('Token required');
				}

				options.header.token = options.context.token;
			}
		]
	}
});

(async () => {
	const context = {
		token: 'secret'
	};

	const response = await instance('https://httpbin.org/headers', {context});

	// Let's see the headers
	console.log(response.body);
})();

responseType

Type: string
Default: text

Note: When using streams, this option is ignored.

Parsing method used to retrieve the body from the response. Can be text, json or buffer. The promise has .json() and .buffer() and .text() functions which set this option automatically.

Example:

const {body} = await got(url).json();

resolveBodyOnly

Type: string
Default: false

When set to true the promise will return the Response body instead of the Response object.

cookieJar

Type: tough.CookieJar instance

Note: If you provide this option, options.headers.cookie will be overridden.

Cookie support. You don't have to care about parsing or how to store them. Example.

ignoreInvalidCookies

Type: boolean
Default: false

Ignore invalid cookies instead of throwing an error. Only useful when the cookieJar option has been set. Not recommended.

encoding

Type: string | null
Default: 'utf8'

Encoding to be used on setEncoding of the response data. If null, the body is returned as a Buffer (binary data).

form

Type: object | true

Note: If you provide this option, got.stream() will be read-only.

The form body is converted to query string using (new URLSearchParams(object)).toString().

If set to true and the Content-Type header is not set, it will be set to application/x-www-form-urlencoded.

searchParams

Type: string | object<string, string | number> | URLSearchParams

Note: The query option was renamed to searchParams in Got v10. The query option name is still functional, but is being deprecated and will be completely removed in Got v11.

Query string that will be added to the request URL. This will override the query string in url.

If you need to pass in an array, you can do it using a URLSearchParams instance:

const got = require('got');

const searchParams = new URLSearchParams([['key', 'a'], ['key', 'b']]);

got('https://example.com', {searchParams});

console.log(searchParams.toString());
//=> 'key=a&key=b'

And if you need a different array format, you could use the query-string package:

const got = require('got');
const queryString = require('query-string');

const searchParams = queryString.stringify({key: ['a', 'b']}, {arrayFormat: 'bracket'});

got('https://example.com', {searchParams});

console.log(searchParams);
//=> 'key[]=a&key[]=b'

timeout

Type: number | object

Milliseconds to wait for the server to end the response before aborting the request with got.TimeoutError error (a.k.a. request property). By default, there's no timeout.

This also accepts an object with the following fields to constrain the duration of each phase of the request lifecycle:

lookup starts when a socket is assigned and ends when the hostname has been resolved. Does not apply when using a Unix domain socket.
connect starts when lookup completes (or when the socket is assigned if lookup does not apply to the request) and ends when the socket is connected.
secureConnect starts when connect completes and ends when the handshaking process completes (HTTPS only).
socket starts when the socket is connected. See request.setTimeout.
response starts when the request has been written to the socket and ends when the response headers are received.
send starts when the socket is connected and ends with the request has been written to the socket.
request starts when the request is initiated and ends when the response's end event fires.

retry

Type: number | object
Default:

limit: 2
calculateDelay: (attemptCount, retryOptions, error, computedValue) => computedValue
methods: GET PUT HEAD DELETE OPTIONS TRACE
statusCodes: 408 413 429 500 502 503 504
maxRetryAfter: undefined
errorCodes: ETIMEDOUT ECONNRESET EADDRINUSE ECONNREFUSED EPIPE ENOTFOUND ENETUNREACH EAI_AGAIN

An object representing limit, calculateDelay, methods, statusCodes, maxRetryAfter and errorCodes fields for maximum retry count, retry handler, allowed methods, allowed status codes, maximum Retry-After time and allowed error codes.

Note: When using streams, this option is ignored.

If maxRetryAfter is set to undefined, it will use options.timeout.
If Retry-After header is greater than maxRetryAfter, it will cancel the request.

Delays between retries counts with function 1000 * Math.pow(2, retry) + Math.random() * 100, where retry is attempt number (starts from 1).

The calculateDelay property is a function with attemptCount, retryOptions, error and computedValue arguments for current retry count, the retry options, error and default computed value. The function must return a delay in milliseconds (0 return value cancels retry).

By default, it retries only on the specified methods, status codes, and on these network errors:

ETIMEDOUT: One of the timeout limits were reached.
ECONNRESET: Connection was forcibly closed by a peer.
EADDRINUSE: Could not bind to any free port.
ECONNREFUSED: Connection was refused by the server.
EPIPE: The remote side of the stream being written has been closed.
ENOTFOUND: Couldn't resolve the hostname to an IP address.
ENETUNREACH: No internet connection.
EAI_AGAIN: DNS lookup timed out.

followRedirect

Type: boolean
Default: true

Defines if redirect responses should be followed automatically.

Note that if a 303 is sent by the server in response to any request type (POST, DELETE, etc.), Got will automatically request the resource pointed to in the location header via GET. This is in accordance with the spec.

decompress

Type: boolean
Default: true

Decompress the response automatically. This will set the accept-encoding header to gzip, deflate, br on Node.js 11.7.0+ or gzip, deflate for older Node.js versions, unless you set it yourself.

Brotli (br) support requires Node.js 11.7.0 or later.

If this is disabled, a compressed response is returned as a Buffer. This may be useful if you want to handle decompression yourself or stream the raw compressed data.

cache

Type: object
Default: false

Cache adapter instance for storing cached response data.

dnsCache

Type: object
Default: false

Cache adapter instance for storing cached DNS data.

request

Type: Function
Default: http.request https.request (Depending on the protocol)

Custom request function. The main purpose of this is to support HTTP2 using a wrapper.

useElectronNet

Type: boolean
Default: false

When used in Electron, Got will use electron.net instead of the Node.js http module. According to the Electron docs, it should be fully compatible, but it's not entirely. See #443 and #461.

throwHttpErrors

Type: boolean
Default: true

Determines if a got.HTTPError is thrown for error responses (non-2xx status codes).

If this is disabled, requests that encounter an error status code will be resolved with the response instead of throwing. This may be useful if you are checking for resource availability and are expecting error responses.

agent

Same as the agent option for http.request, but with an extra feature:

If you require different agents for different protocols, you can pass a map of agents to the agent option. This is necessary because a request to one protocol might redirect to another. In such a scenario, Got will switch over to the right protocol agent for you.

const got = require('got');
const HttpAgent = require('agentkeepalive');
const {HttpsAgent} = HttpAgent;

got('https://sindresorhus.com', {
	agent: {
		http: new HttpAgent(),
		https: new HttpsAgent()
	}
});

hooks

Type: object<string, Function[]>

Hooks allow modifications during the request lifecycle. Hook functions may be async and are run serially.