Skip to main content

Getting Started with IPstack API

Introduction

Quickstart Guide

Step 1: 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 2: Make your first API call

IP Stack API 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 section.

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-api==1.0.0

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

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
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 ipstackapi.configuration import Environment
from ipstackapi.http.auth.custom_query_authentication import CustomQueryAuthenticationCredentials
from ipstackapi.ipstackapi_client import IpstackapiClient

client = IpstackapiClient(
    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-api 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-api 1.0.0
File Size Uploaded Provenance Actions
ip_stack_api-1.0.0.tar.gz 16.0 kB Without provenance Details for ip_stack_api-1.0.0.tar.gz

Built distribution (wheel)

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

Total release size: 46.8 kB

Release files / ip_stack_api-1.0.0.tar.gz

Download URL ip_stack_api-1.0.0.tar.gz
Size 16.0 kB
Tags Source
SHA-256 checksum
How to use checksums
298b70cb1e18f3eeb44c7416847243a9b04a15836f82d2b3a01c42b39441b08d
BLAKE2b-256 checksum
How to use checksums
94e9705316a0a32b3652651e9f5430bd635029060fc3826bd1e6c6c099712d18
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_api-1.0.0-py3-none-any.whl

Download URL ip_stack_api-1.0.0-py3-none-any.whl
Size 30.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2d95562fc554f805e5fd38c2ea1d62183b56e1012b71c45afb5b94e28e4fe8ce
BLAKE2b-256 checksum
How to use checksums
e899effd746f50c788303c425660e763f67e1f1b97a9c3c52caf17b5ba9e90f5
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-api 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