Skip to main content

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.

List of APIs

SDK Infrastructure

HTTP

Utilities

Metadata

Release files for ip-stack-sdk 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ip-stack-sdk 1.0.0
File Size Uploaded Provenance Actions
ip_stack_sdk-1.0.0.tar.gz 20.5 kB Without provenance Details for ip_stack_sdk-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ip-stack-sdk 1.0.0
File Interpreter ABI Platform Actions
ip_stack_sdk-1.0.0-py3-none-any.whl Python 3 none any Details for ip_stack_sdk-1.0.0-py3-none-any.whl

Total release size: 84.9 kB

Release files / ip_stack_sdk-1.0.0.tar.gz

Download URL ip_stack_sdk-1.0.0.tar.gz
Size 20.5 kB
Tags Source
SHA-256 checksum
How to use checksums
0b9fafe74cf3899e68966d6b926ce23c7717c79bdb2bf1f7d619915dd1bb70cb
BLAKE2b-256 checksum
How to use checksums
36372a7684ab1e4d17c3ce36da2662ae1c24fde5cb3238525d0d914adc10af40
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Release files / ip_stack_sdk-1.0.0-py3-none-any.whl

Download URL ip_stack_sdk-1.0.0-py3-none-any.whl
Size 64.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
55bbd2ce12e607cff09551c29b45eaca6fa0dfd586e8612c7d60218d7805fef3
BLAKE2b-256 checksum
How to use checksums
b6186c294b25556794d15b146384848d98212fddf0b20e16ac9ddf9575c5d717
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Security for ip-stack-sdk 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page