2.0.0 • Published 2 years ago

visitorapi v2.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

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 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, or the API will return a 403 error.

Response Data

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

JSON PathDescription
ipAddressThe IP address of the visitor.
countryCodeCountry from which the visitor is located in as an ISO 3166-1 alpha-2 country code.
countryNameThe full name of the country which the visitor is located in.
currenciesAn array of the official currencies of the country which the visitor is located in.
languagesAn array of the official languages of the country which the visitor is located in.
regionName 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.
cityName of the city which the visitor is located in.
cityLatLongLatitude and longitude of the city which the visitor is located in.
browserThe browser name which the visitor uses.
browserVersionThe browser version which the visitor uses.
deviceBrandThe brand of the device which the visitor uses. Only applicable to mobile devices.
deviceModelThe model of the device which the visitor uses. Only applicable to mobile devices.
deviceFamilyThe family of the device which the visitor uses. Only applicable to mobile devices.
osThe operating system name of the device which the visitor uses.
osVersionThe operating system version of the device which the visitor uses.