ip-stack-sdk 1.0.0

IPstack API is a comprehensive IP geolocation service that provides detailed location information for IPv4 and IPv6 addresses, including country, city, coordinates, timezone, currency, and ISP data. The API offers three main endpoints: Standard IP Lookup for single addresses, Bulk IP Lookup for multiple addresses, and Requester IP Lookup to detect the requesting IP address, with support for multiple languages and output formats

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

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install ip-stack-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/ip-stack-sdk/1.0.0

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt
pytest

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
http_client_instance	HttpClient	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 60
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ['GET', 'PUT']
custom_query_authentication_credentials	CustomQueryAuthenticationCredentials	The credential object for Custom Query Parameter

The API client can be initialized as follows:

from ipstack.configuration import Environment
from ipstack.http.auth.custom_query_authentication import CustomQueryAuthenticationCredentials
from ipstack.ipstack_client import IpstackClient

client = IpstackClient(
    custom_query_authentication_credentials=CustomQueryAuthenticationCredentials(
        access_key='access_key'
    ),
    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

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime