# outscraper

> The library provides convenient access to the Outscraper API. Allows using Outscraper's services from your code. See https://outscraper.com for details.

Latest version **2.2.5** (published 2026-09-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install outscraper
pnpm add outscraper
yarn add outscraper
bun add outscraper
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 2.2.5 |
| Published | 2026-09-24 |
| First published | 2022-07-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 76.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Outscraper |
| Maintainers | outscraper-api |
| Keywords | outscraper, google maps, google maps api, google maps scraper, google maps reviews, google maps reviews api, google maps scraper, scraper, webscraper, serpapi, google, serp api |

## Links

- npm: https://www.npmjs.com/package/outscraper
- Repository: https://github.com/outscraper/outscraper-node
- Homepage: https://github.com/outscraper/outscraper-node#readme
- Issues: https://github.com/outscraper/outscraper-node/issues
- npm.io page: https://npm.io/package/outscraper

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 2.2.5 (latest) — 2026-09-24
- 2.2.2 — 2026-02-23
- 2.2.1 — 2026-01-29
- 2.2.0 — 2026-01-09
- 2.1.8 — 2025-07-23
- 2.1.7 — 2025-05-27
- 2.0.6 — 2025-04-07
- 2.0.4 — 2024-05-08
- 2.0.2 — 2024-01-03
- 2.0.1 — 2023-02-17
- 2.0.0 — 2022-10-10
- 1.1.0 — 2022-07-23
- 1.0.5 — 2022-07-23
- 1.0.4 — 2022-07-22
- 1.0.3 — 2022-07-22
- … 1 more at https://npm.io/package/outscraper/versions

## README

# Outscraper Node Library

The library provides convenient access to the [Outscraper API](https://app.outscraper.com/api-docs) from applications written in server-side JavaScript. Allows using [Outscraper's services](https://outscraper.com/services/) from your code.

![screencast](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExNWVjMGIxNjlmZGMwYjAwMzc5M2QxZjI5ZmIzNzc0ZWQxYWQ2M2Q2ZiZjdD1n/2Z85rUMT0D9e8qslj8/giphy.gif)

## Installation

Install the package with:
```bash
npm install outscraper --save
# Or
yarn add outscraper
```

[Link to the NPM package page](https://www.npmjs.com/package/outscraper)

## Initialization
```js
const Outscraper = require('outscraper');
// Or using ES modules:
import Outscraper from 'outscraper';

let client = new Outscraper('SECRET_API_KEY');

```
[Link to the account page to create the API key](https://app.outscraper.com/account/api)

## Usage

```js
// Search for businesses in specific locations:
client.googleMapsSearch(['restaurants brooklyn usa'], limit=20, language='en', region='us').then(response => {
    console.log(response);
});

// Or using ES modules and async/await:
(async () => {
  const response = await client.googleMapsSearch(['restaurants brooklyn usa'], limit=20, language='en', region='us');
  console.log(response);
})();

// Get data of the specific place by id
client.googleMapsSearch(['rChIJrc9T9fpYwokRdvjYRHT8nI4'], language='en').then(response => {
    console.log(response);
});

// Get reviews of the specific place by id
client.googleMapsReviews(['rChIJrc9T9fpYwokRdvjYRHT8nI4'], reviewsLimit=20, language='en').then(response => {
    console.log(response);
});

// Get reviews of the specific place by id using async mode
client.googleMapsReviews(
    ['rChIJrc9T9fpYwokRdvjYRHT8nI4'],
    reviewsLimit=20,
    limit=1,
    sort='most_relevant',
    skip=0,
    start=null,
    cutoff=null,
    cutoffRating=null,
    ignoreEmpty=false,
    language='en',
    region=null,
    reviewsQuery=null,
    lastPaginationId=null,
    asyncRequest=true // Enable async mode
).then(response => {
    console.log('Request ID:', response.requestId);
    // You can use the requestId to check the status of the request later
    client.getRequestArchive(response.requestId).then(status => {
        console.log('Request Status:', status);
    });
});

// Search contacts from website
client.emailsAndContacts(['outscraper.com']).then(response => {
    console.log(response);
});
```

[More examples](https://github.com/outscraper/outscraper-node/tree/master/examples)

## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/outscraper/outscraper-node.

---
_Source: https://npm.io/package/outscraper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._