# visitorapi

> Detect website visitor IP, location, currencies, languages and device information

Latest version **2.0.2** (published 2026-07-21) · ISC license · 0 weekly downloads

## Install

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

## Health

**Score 45/100 (D)** — status: active.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2026-07-21 |
| First published | 2022-06-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | VisitorAPI |
| Maintainers | chaomingli |
| Keywords | ip, ip address, location, geolocation, currencies, languages, device, device model, os, operating system, browser |

## Links

- npm: https://www.npmjs.com/package/visitorapi
- Repository: https://github.com/visitorapi/visitorapi.js
- Homepage: https://www.visitorapi.com
- Issues: https://github.com/visitorapi/visitorapi.js/issues
- npm.io page: https://npm.io/package/visitorapi

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 2.0.2 (latest) — 2026-07-21
- 2.0.1 — 2026-07-08
- 2.0.0 — 2022-10-08
- 1.0.2 — 2022-06-13
- 1.0.1 — 2022-06-13
- 1.0.0 — 2022-06-12

## README

# VisitorAPI

## Features
- Detect IP addresses of website visitors
- Detect country, state and city of website visitors
- Detect currencies of website visitors
- Detect languages of website visitors
- Detect operating system and version of website visitors
- Detect browser and version of website visitors
- Detect device brand and model of website visitors

## Installing

using npm

```
npm install visitorapi
```

## Promise Example
Since version 2.0.0, VisitorAPI supports promise as well. See the example below.

```
import VisitorAPI from "visitorapi";


VisitorAPI("<my project id>").then(data => {
    console.log(data);
    setCountry(data.countryCode);
}).catch(error => {
    console.log(error);
});

```

## Callback Example

```
import VisitorAPI from "visitorapi";


VisitorAPI(
    "<my project id>",
    data => {
        console.log(data);
        setCountry(data.countryCode);
    },
    error => {
        console.log(error);
    }
);

```

You will need to create a project via the [VisitorAPI](https://www.visitorapi.com) interface and retrieve the project ID to replace `<my project id>` in the example code.

## Authentication

VisitorAPI doesn't require any API key or token. You will need to specify the domains that are allowed to call the API in the [Visitor API user interface](https://app.visitorapi.com), or the API will return a 403 error.

## Response Data

The response `data` is a JSON object with the following properties:

|    JSON Path   |                                                                      Description                                                                     |
|:--------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------:|
| ipAddress      | The IP address of the visitor.                                                                                                                       |
| countryCode    | Country from which the visitor is located in as an ISO 3166-1 alpha-2 country code.                                                                  |
| countryName    | The full name of the country which the visitor is located in.                                                                                        |
| currencies     | An array of the official currencies of the country which the visitor is located in.                                                                  |
| languages      | An array of the official languages of the country which the visitor is located in.                                                                   |
| region         | Name of the region, state or province which the visitor is located in. The complete list of valid region values is found in the ISO-3166-2 standard. |
| city           | Name of the city which the visitor is located in.                                                                                                    |
| cityLatLong    | Latitude and longitude of the city which the visitor is located in.                                                                                  |
| browser        | The browser name which the visitor uses.                                                                                                             |
| browserVersion | The browser version which the visitor uses.                                                                                                          |
| deviceBrand    | The brand of the device which the visitor uses. Only applicable to mobile devices.                                                                   |
| deviceModel    | The model of the device which the visitor uses. Only applicable to mobile devices.                                                                   |
| deviceFamily   | The family of the device which the visitor uses. Only applicable to mobile devices.                                                                  |
| os             | The operating system name of the device which the visitor uses.                                                                                      |
| osVersion      | The operating system version of the device which the visitor uses.                                                                                   |

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