Got

Human-friendly and powerful HTTP request library for Node.js

HTTP client • Fetch • AJAX

sindresorhus/got got

README

^{Sindre's open source work is supported by the community.
Special thanks to:}

Strapi is the leading open-source headless CMS.

^{It’s 100% JavaScript, fully customizable, and developer-first.}

Paperwork that makes the data work.

_{Easy APIs for paperwork. PDF generation, e-signature and embeddable no-code webforms.

The easiest way to build paperwork automation into your product.}

Paperwork that makes the data work.

_{Easy APIs for paperwork. PDF generation, e-signature and embeddable no-code webforms.

The easiest way to build paperwork automation into your product.}

Human-friendly and powerful HTTP request library for Node.js

[![Downloads](https://img.shields.io/npm/dm/got.svg)](https://npmjs.com/got) [![Install size](https://packagephobia.com/badge?p=got)](https://packagephobia.com/result?p=got)

See how Got compares to other HTTP libraries

For browser usage, we recommend Ky by the same people.

Support questions should be asked here.

Install

```sh
npm install got
```

Warning: This package is native ESM and no longer provides a CommonJS export. If your project uses CommonJS, you'll have to convert to ESM or use the [dynamicimport()](https://v8.dev/features/dynamic-import) function. Please don't open issues for questions regarding CommonJS / ESM. You can also use Got v11 instead which is pretty stable. We will backport security fixes to v11 for the foreseeable future.

Take a peek

A quick start guide is available.

JSON mode

Got has a dedicated option for handling JSON payload.\

Furthermore, the promise exposes a `.json()` function that returns `Promise`.

```js
import got from 'got';
const {data} = await got.post('https://httpbin.org/anything', {
json: {
hello: 'world'
}
}).json();
console.log(data);
//=> {"hello": "world"}
```

For advanced JSON usage, check out the [parseJson](documentation/2-options.md#parsejson) and [stringifyJson](documentation/2-options.md#stringifyjson) options.

For more useful tips like this, visit the Tips page.

Highlights

- Used by 8K+ packages and 4M+ repos

- Actively maintained

- Trusted by many companies

Documentation

By default, Got will retry on failure. To disable this option, set [options.retry.limit](documentation/7-retry.md#retry) to 0.

Main API

- [x] Promise API

- [x] Options

- [x] Stream API

- [x] Pagination API

- [x] Advanced HTTPS API

- [x] HTTP/2 support

- [x] [Response class](documentation/3-streams.md#response-2)

Timeouts and retries

- [x] Advanced timeout handling

- [x] Retries on failure

- [x] Errors with metadata

Advanced creation

- [x] Hooks

- [x] Instances

- [x] Progress events & other events

- [x] Plugins

- [x] Compose

Cache, Proxy and UNIX sockets

- [x] RFC compliant caching

- [x] Proxy support

- [x] Unix Domain Sockets

Integration

- [x] TypeScript support

- [x] AWS

- [x] Testing

Migration guides

- Request migration guide

- [(Note that Request is unmaintained)](https://github.com/request/request/issues/3142)

- Axios

- Node.js

Got plugins

- [got4aws](https://github.com/SamVerschueren/got4aws) - Got convenience wrapper to interact with AWS v4 signed APIs

- [gh-got](https://github.com/sindresorhus/gh-got) - Got convenience wrapper to interact with the GitHub API

- [gl-got](https://github.com/singapore/gl-got) - Got convenience wrapper to interact with the GitLab API

- [gotql](https://github.com/khaosdoctor/gotql) - Got convenience wrapper to interact with GraphQL using JSON-parsed queries instead of strings

- [got-fetch](https://github.com/alexghr/got-fetch) - Got with a [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) interface

- [got-scraping](https://github.com/apify/got-scraping) - Got wrapper specifically designed for web scraping purposes

- [got-ssrf](https://github.com/JaneJeon/got-ssrf) - Got wrapper to protect server-side requests against SSRF attacks

Legacy

- travis-got - Got convenience wrapper to interact with the Travis API

- graphql-got - Got convenience wrapper to interact with GraphQL

Comparison

\|	[`request`][r0]	[`node-fetch`][n0]	[`ky`][k0]	[`axios`][a0]	[`superagent`][s0]
\|-----------------------\|:-------------------:\|:------------------:\|:--------------------:\|:------------------------:\|:------------------:\|:----------------------:\|
HTTP/2	:heavy_check_mark:¹	:x:	:x:	:x:	:x:
Browser	:x:	:x:	:heavy_check_mark:\*	:heavy_check_mark:	:heavy_check_mark:
Promise	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Stream	:heavy_check_mark:	:heavy_check_mark:	Node.js	:x:	:x:
Pagination	:heavy_check_mark:	:x:	:x:	:x:	:x:
Request	:heavy_check_mark:	:x:	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
RFC	:heavy_check_mark:	:x:	:x:	:x:	:x:
Cookies	:heavy_check_mark:	:heavy_check_mark:	:x:	:x:	:x:
Follows	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Retries	:heavy_check_mark:	:x:	:x:	:heavy_check_mark:	:x:
Progress	:heavy_check_mark:	:x:	:x:	:heavy_check_mark:\\\*	Browser
Handles	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Advanced	:heavy_check_mark:	:x:	:x:	:x:	:x:
Timings	:heavy_check_mark:	:heavy_check_mark:	:x:	:x:	:x:
Errors	:heavy_check_mark:	:x:	:x:	:heavy_check_mark:	:heavy_check_mark:
JSON	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Custom	:heavy_check_mark:	:heavy_check_mark:	:x:	:heavy_check_mark:	:heavy_check_mark:
Composable	:heavy_check_mark:	:x:	:x:	:x:	:x:
Hooks	:heavy_check_mark:	:x:	:x:	:heavy_check_mark:	:heavy_check_mark:
Issues	[![][gio]][g1]	[![][rio]][r1]	[![][nio]][n1]	[![][kio]][k1]	[![][aio]][a1]
Issues	[![][gic]][g2]	[![][ric]][r2]	[![][nic]][n2]	[![][kic]][k2]	[![][aic]][a2]
Downloads	[![][gd]][g3]	[![][rd]][r3]	[![][nd]][n3]	[![][kd]][k3]	[![][ad]][a3]
Coverage	TBD	[![][rc]][r4]	[![][nc]][n4]	[![][kc]][k4]	[![][ac]][a4]
Build	[![][gb]][g5]	[![][rb]][r5]	[![][nb]][n5]	[![][kb]][k5]	[![][ab]][a5]
Bugs	[![][gbg]][g6]	[![][rbg]][r6]	[![][nbg]][n6]	[![][kbg]][k6]	[![][abg]][a6]
Dependents	[![][gdp]][g7]	[![][rdp]][r7]	[![][ndp]][n7]	[![][kdp]][k7]	[![][adp]][a7]
Install	[![][gis]][g8]	[![][ris]][r8]	[![][nis]][n8]	[![][kis]][k8]	[![][ais]][a8]
GitHub	[![][gs]][g9]	[![][rs]][r9]	[![][ns]][n9]	[![][ks]][k9]	[![][as]][a9]
TypeScript	[![][gts]][g10]	[![][rts]][r10]	[![][nts]][n10]	[![][kts]][k10]	[![][ats]][a10]
Last	[![][glc]][g11]	[![][rlc]][r11]	[![][nlc]][n11]	[![][klc]][k11]	[![][alc]][a11]

\* It's almost API compatible with the browser fetch API.\

\\ Need to switch the protocol manually. Doesn't accept PUSH streams and doesn't reuse HTTP/2 sessions.\

\\\* Currently, only DownloadProgress event is supported, UploadProgress event is not supported.\

¹ Requires Node.js 15.10.0 or above.\

:sparkle: Almost-stable feature, but the API may change. Don't hesitate to try it out!\

:grey_question: Feature in early stage of development. Very experimental.

[k0]: https://github.com/sindresorhus/ky

[r0]: https://github.com/request/request

[n0]: https://github.com/node-fetch/node-fetch

[a0]: https://github.com/axios/axios

[s0]: https://github.com/visionmedia/superagent

[gio]: https://img.shields.io/github/issues-raw/sindresorhus/got?color=gray&label

[kio]: https://img.shields.io/github/issues-raw/sindresorhus/ky?color=gray&label

[rio]: https://img.shields.io/github/issues-raw/request/request?color=gray&label

[nio]: https://img.shields.io/github/issues-raw/bitinn/node-fetch?color=gray&label

[aio]: https://img.shields.io/github/issues-raw/axios/axios?color=gray&label

[sio]: https://img.shields.io/github/issues-raw/visionmedia/superagent?color=gray&label

[g1]: https://github.com/sindresorhus/got/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc

[k1]: https://github.com/sindresorhus/ky/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc

[r1]: https://github.com/request/request/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc

[n1]: https://github.com/bitinn/node-fetch/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc

[a1]: https://github.com/axios/axios/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc

[s1]: https://github.com/visionmedia/superagent/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc

[gic]: https://img.shields.io/github/issues-closed-raw/sindresorhus/got?color=blue&label

[kic]: https://img.shields.io/github/issues-closed-raw/sindresorhus/ky?color=blue&label

[ric]: https://img.shields.io/github/issues-closed-raw/request/request?color=blue&label

[nic]: https://img.shields.io/github/issues-closed-raw/bitinn/node-fetch?color=blue&label

[aic]: https://img.shields.io/github/issues-closed-raw/axios/axios?color=blue&label

[sic]: https://img.shields.io/github/issues-closed-raw/visionmedia/superagent?color=blue&label

[g2]: https://github.com/sindresorhus/got/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc

[k2]: https://github.com/sindresorhus/ky/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc

[r2]: https://github.com/request/request/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc

[n2]: https://github.com/bitinn/node-fetch/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc

[a2]: https://github.com/axios/axios/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc

[s2]: https://github.com/visionmedia/superagent/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc

[gd]: https://img.shields.io/npm/dm/got?color=darkgreen&label

[kd]: https://img.shields.io/npm/dm/ky?color=darkgreen&label

[rd]: https://img.shields.io/npm/dm/request?color=darkgreen&label

[nd]: https://img.shields.io/npm/dm/node-fetch?color=darkgreen&label

[ad]: https://img.shields.io/npm/dm/axios?color=darkgreen&label

[sd]: https://img.shields.io/npm/dm/superagent?color=darkgreen&label

[g3]: https://www.npmjs.com/package/got

[k3]: https://www.npmjs.com/package/ky

[r3]: https://www.npmjs.com/package/request

[n3]: https://www.npmjs.com/package/node-fetch

[a3]: https://www.npmjs.com/package/axios

[s3]: https://www.npmjs.com/package/superagent

[gc]: https://img.shields.io/coveralls/github/sindresorhus/got?color=0b9062&label

[kc]: https://img.shields.io/codecov/c/github/sindresorhus/ky?color=0b9062&label

[rc]: https://img.shields.io/coveralls/github/request/request?color=0b9062&label

[nc]: https://img.shields.io/coveralls/github/bitinn/node-fetch?color=0b9062&label

[ac]: https://img.shields.io/coveralls/github/mzabriskie/axios?color=0b9062&label

[sc]: https://img.shields.io/codecov/c/github/visionmedia/superagent?color=0b9062&label

[g4]: https://coveralls.io/github/sindresorhus/got

[k4]: https://codecov.io/gh/sindresorhus/ky

[r4]: https://coveralls.io/github/request/request

[n4]: https://coveralls.io/github/bitinn/node-fetch

[a4]: https://coveralls.io/github/mzabriskie/axios

[s4]: https://codecov.io/gh/visionmedia/superagent

[gb]: https://github.com/sindresorhus/got/actions/workflows/main.yml/badge.svg

[kb]: https://github.com/sindresorhus/ky/actions/workflows/main.yml/badge.svg

[rb]: https://img.shields.io/travis/request/request?label

[nb]: https://img.shields.io/travis/bitinn/node-fetch?label

[ab]: https://img.shields.io/travis/axios/axios?label

[sb]: https://img.shields.io/travis/visionmedia/superagent?label

[g5]: https://github.com/sindresorhus/got/actions/workflows/main.yml

[k5]: https://github.com/sindresorhus/ky/actions/workflows/main.yml

[r5]: https://travis-ci.org/github/request/request

[n5]: https://travis-ci.org/github/bitinn/node-fetch

[a5]: https://travis-ci.org/github/axios/axios

[s5]: https://travis-ci.org/github/visionmedia/superagent

[gbg]: https://img.shields.io/github/issues-raw/sindresorhus/got/bug?color=darkred&label

[kbg]: https://img.shields.io/github/issues-raw/sindresorhus/ky/bug?color=darkred&label

[rbg]: https://img.shields.io/github/issues-raw/request/request/Needs%20investigation?color=darkred&label

[nbg]: https://img.shields.io/github/issues-raw/bitinn/node-fetch/bug?color=darkred&label

[abg]: https://img.shields.io/github/issues-raw/axios/axios/type:confirmed%20bug?color=darkred&label

[sbg]: https://img.shields.io/github/issues-raw/visionmedia/superagent/Bug?color=darkred&label

[g6]: https://github.com/sindresorhus/got/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug

[k6]: https://github.com/sindresorhus/ky/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug

[r6]: https://github.com/request/request/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A"Needs+investigation"

[n6]: https://github.com/bitinn/node-fetch/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug

[a6]: https://github.com/axios/axios/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22type%3Aconfirmed+bug%22

[s6]: https://github.com/visionmedia/superagent/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3ABug

[gdp]: https://badgen.net/npm/dependents/got?color=orange&label

[kdp]: https://badgen.net/npm/dependents/ky?color=orange&label

[rdp]: https://badgen.net/npm/dependents/request?color=orange&label

[ndp]: https://badgen.net/npm/dependents/node-fetch?color=orange&label

[adp]: https://badgen.net/npm/dependents/axios?color=orange&label

[sdp]: https://badgen.net/npm/dependents/superagent?color=orange&label

[g7]: https://www.npmjs.com/package/got?activeTab=dependents

[k7]: https://www.npmjs.com/package/ky?activeTab=dependents

[r7]: https://www.npmjs.com/package/request?activeTab=dependents

[n7]: https://www.npmjs.com/package/node-fetch?activeTab=dependents

[a7]: https://www.npmjs.com/package/axios?activeTab=dependents

[s7]: https://www.npmjs.com/package/visionmedia?activeTab=dependents

[gis]: https://badgen.net/packagephobia/install/got?color=blue&label

[kis]: https://badgen.net/packagephobia/install/ky?color=blue&label

[ris]: https://badgen.net/packagephobia/install/request?color=blue&label

[nis]: https://badgen.net/packagephobia/install/node-fetch?color=blue&label

[ais]: https://badgen.net/packagephobia/install/axios?color=blue&label

[sis]: https://badgen.net/packagephobia/install/superagent?color=blue&label

[g8]: https://packagephobia.com/result?p=got

[k8]: https://packagephobia.com/result?p=ky

[r8]: https://packagephobia.com/result?p=request

[n8]: https://packagephobia.com/result?p=node-fetch

[a8]: https://packagephobia.com/result?p=axios

[s8]: https://packagephobia.com/result?p=superagent

[gs]: https://img.shields.io/github/stars/sindresorhus/got?color=white&label

[ks]: https://img.shields.io/github/stars/sindresorhus/ky?color=white&label

[rs]: https://img.shields.io/github/stars/request/request?color=white&label

[ns]: https://img.shields.io/github/stars/bitinn/node-fetch?color=white&label

[as]: https://img.shields.io/github/stars/axios/axios?color=white&label

[ss]: https://img.shields.io/github/stars/visionmedia/superagent?color=white&label

[g9]: https://github.com/sindresorhus/got

[k9]: https://github.com/sindresorhus/ky

[r9]: https://github.com/request/request

[n9]: https://github.com/node-fetch/node-fetch

[a9]: https://github.com/axios/axios

[s9]: https://github.com/visionmedia/superagent

[gts]: https://badgen.net/npm/types/got?label

[kts]: https://badgen.net/npm/types/ky?label

[rts]: https://badgen.net/npm/types/request?label

[nts]: https://badgen.net/npm/types/node-fetch?label

[ats]: https://badgen.net/npm/types/axios?label

[sts]: https://badgen.net/npm/types/superagent?label

[g10]: https://github.com/sindresorhus/got

[k10]: https://github.com/sindresorhus/ky

[r10]: https://github.com/request/request

[n10]: https://github.com/node-fetch/node-fetch

[a10]: https://github.com/axios/axios

[s10]: https://github.com/visionmedia/superagent

[glc]: https://img.shields.io/github/last-commit/sindresorhus/got?color=gray&label

[klc]: https://img.shields.io/github/last-commit/sindresorhus/ky?color=gray&label

[rlc]: https://img.shields.io/github/last-commit/request/request?color=gray&label

[nlc]: https://img.shields.io/github/last-commit/bitinn/node-fetch?color=gray&label

[alc]: https://img.shields.io/github/last-commit/axios/axios?color=gray&label

[slc]: https://img.shields.io/github/last-commit/visionmedia/superagent?color=gray&label

[g11]: https://github.com/sindresorhus/got/commits

[k11]: https://github.com/sindresorhus/ky/commits

[r11]: https://github.com/request/request/commits

[n11]: https://github.com/node-fetch/node-fetch/commits

[a11]: https://github.com/axios/axios/commits

[s11]: https://github.com/visionmedia/superagent/commits

[Click here][InstallSizeOfTheDependencies] to see the install size of the Got dependencies.

[InstallSizeOfTheDependencies]: https://packagephobia.com/result?p=@sindresorhus/is@4.0.1,@szmarczak/http-timer@4.0.5,@types/cacheable-request@6.0.1,@types/responselike@1.0.0,cacheable-lookup@6.0.0,cacheable-request@7.0.2,decompress-response@6.0.0,get-stream@6.0.1,http2-wrapper@2.0.5,lowercase-keys@2.0.0,p-cancelable@2.1.1,responselike@2.0.0

Maintainers

Sindre Sorhus | Szymon Marczak

Former

- Vsevolod Strukchinsky

- Alexander Tesfamichael

- Brandon Smith

- Luke Childs

- Giovanni Minotti

These amazing companies are using Got

Segment is a happy user of Got! Got powers the main backend API that our app talks to. It's used by our in-house RPC client that we use to communicate with all microservices.

— <a href="https://github.com/vadimdemedes">Vadim Demedes</a>

Antora, a static site generator for creating documentation sites, uses Got to download the UI bundle. In Antora, the UI bundle (aka theme) is maintained as a separate project. That project exports the UI as a zip file we call the UI bundle. The main site generator downloads that UI from a URL using Got and streams it to vinyl-zip to extract the files. Those files go on to be used to create the HTML pages and supporting assets.

— <a href="https://github.com/mojavelinux">Dan Allen</a>

GetVoIP is happily using Got in production. One of the unique capabilities of Got is the ability to handle Unix sockets which enables us to build a full control interfaces for our docker stack.

— <a href="https://github.com/danielkalen">Daniel Kalen</a>

We're using Got inside of Exoframe to handle all the communication between CLI and server. Exoframe is a self-hosted tool that allows simple one-command deployments using Docker.

— <a href="https://github.com/yamalight">Tim Ermilov</a>

Karaoke Mugen uses Got to fetch content updates from its online server.

— <a href="https://github.com/AxelTerizaki">Axel Terizaki</a>

Renovate uses Got, gh-got and gl-got to send millions of queries per day to GitHub, GitLab, npmjs, PyPi, Packagist, Docker Hub, Terraform, CircleCI, and more.

— <a href="https://github.com/rarkins">Rhys Arkins</a>

Resistbot uses Got to communicate from the API frontend where all correspondence ingresses to the officials lookup database in back.

— <a href="https://github.com/chris-erickson">Chris Erickson</a>

Natural Cycles is using Got to communicate with all kinds of 3rd-party REST APIs (over 9000!).

— <a href="https://github.com/kirillgroshkov">Kirill Groshkov</a>

Microlink is a cloud browser as an API service that uses Got widely as the main HTTP client, serving ~22M requests a month, every time a network call needs to be performed.

— <a href="https://github.com/Kikobeats">Kiko Beats</a>

We’re using Got at Radity. Thanks for such an amazing work!

— <a href="https://github.com/MirzayevFarid">Mirzayev Farid</a>

Got has been a crucial component of Apify's scraping for years. We use it to extract data from billions of web pages every month, and we really appreciate the powerful API and extensibility, which allowed us to build our own specialized HTTP client on top of Got. The support has always been stellar too.

— <a href="https://github.com/mnmkng">Ondra Urban</a>

For enterprise

Available as part of the Tidelift Subscription.

The maintainers of got and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

Got