Getting Started with IPstack

Introduction

Quickstart Guide

Step 1: Fork the collection

To get started quickly, you need to fork the IP Stack Postman Collection. Simply click the button below to fork it.

Step 2: Get your API Access Key

1. Go to the IP Stack website and choose the right subscription plan for your particular project.
2. Get your personal API Access Key on the Dashboard to authenticate with the API. Keep it safe! You can reset it at any time in your Account Dashboard.

Step 3: Make your first API call

IP Stack Postman collection contains all the three endpoint supported by IP Stack API.

1. Standard IP Lookup
2. Bulk IP Lookup
3. Requester Lookup

We recommend you to start with the Standard IP Lookup endpoint as it's primary endpoint. It is used to look up single IPv4 or IPv6 addresses. To call this endpoint, simply attach any IPv4 or IPv6 address to the API's base URL.

Check out all the widely used API calls with the necessary parameters in the Standard IP Lookup folder.

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Test the SDK

To validate the functionality of this SDK, you can execute all tests located in the test directory. This SDK utilizes Jest as both the testing framework and test runner.

To run the tests, navigate to the root directory of the SDK and execute the following command:

npm run test

Or you can also run tests with coverage report:

npm run test:coverage

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

| Parameter | Type | Description | | --- | --- | --- | | environment | Environment | The API environment. Default: Environment.Production | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | customQueryAuthenticationCredentials | CustomQueryAuthenticationCredentials | The credential object for customQueryAuthentication |

The API client can be initialized as follows:

import { Client, Environment } from 'ip-stack-sdk';

const client = new Client({
  customQueryAuthenticationCredentials: {
    'access_key': 'access_key'
  },
  timeout: 0,
  environment: Environment.Production,
});

Authorization

This API uses the following authentication schemes.

• apiKey (Custom Query Parameter)

List of APIs

• Standard IP Lookup
• Bulk IP Lookup
• Requester IP Lookup

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError