apilayer-ipstack
v1.0.1
Published
IPstack API SDK
Downloads
18
Readme
ipstack SDK
A simple JavaScript SDK for interacting with the ipstack API to perform IP geolocation lookups (standard, bulk, and requester IP lookups) with support for optional query parameters.
Features
- Fetch detailed location data for single or multiple IP addresses.
- Lookup geolocation of the requester's IP address.
- Easily add optional parameters like language and fields for more customized responses.
Installation
Install the SDK via npm
:
npm install apilayer-ipstack
or via yarn
:
yarn add apilayer-ipstack
Usage
First, you need to create an account on ipstack and obtain your API key.
Initialization
This SDK supports both CommonJS (require) and ES Modules (import).
CommonJS (require
)
const Ipstack = require("ipstack-sdk");
// Initialize with your API key
const ipstack = new Ipstack("YOUR_API_KEY");
ES Modules (import
)
import Ipstack from "ipstack-sdk";
// Initialize with your API key
const ipstack = new Ipstack("YOUR_API_KEY");
Standard IP Lookup
Get geolocation data for a single IP address:
ipstack
.standard("134.201.250.155")
.then((data) => console.log(data))
.catch((error) => console.error(error));
With Optional Parameters:
You can pass optional parameters like language
and fields
to customize the data returned.
ipstack.standard("134.201.250.155", { language: "en", fields: "city,region_name" }).then((data) => console.log(data));
Bulk IP Lookup
Get geolocation data for multiple IP addresses:
ipstack.bulk("134.201.250.155,72.229.28.185").then((data) => console.log(data));
With Optional Parameters:
You can also pass optional parameters with bulk lookups.
ipstack
.bulk("134.201.250.155,72.229.28.185", { fields: "continent_name,country_name" })
.then((data) => console.log(data));
Requester's IP Lookup
Get the geolocation data for the requester's IP address:
ipstack.requestIP().then((data) => console.log(data));
With Optional Parameters:
You can pass optional parameters for the requester IP lookup as well.
ipstack.requestIP({ language: "es" }).then((data) => console.log(data));
API Endpoints
- Standard IP Lookup: Lookup geolocation data for a single IP address.
- Bulk IP Lookup: Fetch data for multiple IP addresses in a single request.
- Requester IP Lookup: Get geolocation data for the requester's IP address.
Note
For more detailed information about ipstack API, make sure to check out our Developer Documentation.
License
This package is licensed under the MIT License.