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

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package IpstackSDK --version 1.0.0

You can also view the package at: https://www.nuget.org/packages/IpstackSDK/1.0.0

Test the SDK

The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.

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	TimeSpan	Http client timeout. Default: TimeSpan.FromSeconds(100)
HttpClientConfiguration	Action<HttpClientConfiguration.Builder>	Action delegate that configures the HTTP client by using the HttpClientConfiguration.Builder for customizing API call settings. Default: new HttpClient()
CustomQueryAuthenticationCredentials	CustomQueryAuthenticationCredentials	The Credentials Setter for Custom Query Parameter

The API client can be initialized as follows:

using IPstack.Standard; using IPstack.Standard.Authentication; IPstackClient client = new IPstackClient.Builder() .CustomQueryAuthenticationCredentials( new CustomQueryAuthenticationModel.Builder( "access_key" ) .Build()) .Environment(IPstack.Standard.Environment.Production) .Build();

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

• HttpClientConfiguration
• HttpClientConfigurationBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiHelper