Copyright	(c) IP2Location 2021
License	MIT
Maintainer	sales@ip2location.com
Stability	experimental
Safe Haskell	None
Language	Haskell2010

IP2LocationWebService

Description

This Haskell package allows users to query an IP address to get geolocation info.

IP2Location Web Service API subscription at https://www.ip2location.com/web-service/ip2location

Synopsis

data WSResult = WSResult {
- response :: String
- country_code :: Maybe String
- country_name :: Maybe String
- region_name :: Maybe String
- city_name :: Maybe String
- latitude :: Maybe Float
- longitude :: Maybe Float
- zip_code :: Maybe String
- time_zone :: Maybe String
- isp :: Maybe String
- domain :: Maybe String
- net_speed :: Maybe String
- idd_code :: Maybe String
- area_code :: Maybe String
- weather_station_code :: Maybe String
- weather_station_name :: Maybe String
- mcc :: Maybe String
- mnc :: Maybe String
- mobile_brand :: Maybe String
- elevation :: Maybe Float
- usage_type :: Maybe String
- address_type :: Maybe String
- category :: Maybe String
- category_name :: Maybe String
- credits_consumed :: Maybe Float
}
data WSConfig
openWS :: String -> String -> Bool -> IO WSConfig
lookUp :: WSConfig -> String -> IO WSResult
getCredit :: WSConfig -> IO String

Documentation

data WSResult Source #

Contains the web service results.

Constructors

WSResult

Fields

response :: String
Response status or error
country_code :: Maybe String
Country code
country_name :: Maybe String
Country name
region_name :: Maybe String
Region name
city_name :: Maybe String
City name
latitude :: Maybe Float
Latitude
longitude :: Maybe Float
Longitude
zip_code :: Maybe String
ZIP code
time_zone :: Maybe String
Time zone
isp :: Maybe String
ISP name
domain :: Maybe String
Domain
net_speed :: Maybe String
Net speed
idd_code :: Maybe String
IDD code
area_code :: Maybe String
Area code
weather_station_code :: Maybe String
Weather station code
weather_station_name :: Maybe String
Weather station name
mcc :: Maybe String
MCC
mnc :: Maybe String
MNC
mobile_brand :: Maybe String
Mobile brand
elevation :: Maybe Float
Elevation
usage_type :: Maybe String
Usage type
address_type :: Maybe String
Address type
category :: Maybe String
IAB category code
category_name :: Maybe String
IAB category name
credits_consumed :: Maybe Float
Credits consumed

Instances

Instances details

Eq WSResult Source #
Instance details Defined in IP2LocationWebService Methods (==) :: WSResult -> WSResult -> Bool # (/=) :: WSResult -> WSResult -> Bool #
Show WSResult Source #
Instance details Defined in IP2LocationWebService Methods showsPrec :: Int -> WSResult -> ShowS # show :: WSResult -> String # showList :: [WSResult] -> ShowS #
ToJSON WSResult Source #
Instance details Defined in IP2LocationWebService Methods toJSON :: WSResult -> Value # toEncoding :: WSResult -> Encoding # toJSONList :: [WSResult] -> Value # toEncodingList :: [WSResult] -> Encoding #
FromJSON WSResult Source #
Instance details Defined in IP2LocationWebService Methods parseJSON :: Value -> Parser WSResult # parseJSONList :: Value -> Parser [WSResult] #

data WSConfig Source #

Contains the web service configuration.

Instances

Instances details

Show WSConfig Source #
Instance details Defined in IP2LocationWebService Methods showsPrec :: Int -> WSConfig -> ShowS # show :: WSConfig -> String # showList :: [WSConfig] -> ShowS #

openWS :: String -> String -> Bool -> IO WSConfig Source #

The openWS function initializes the web service configuration. It takes 3 arguments; the web service API key, the API package to call & whether to use SSL.

lookUp :: WSConfig -> String -> IO WSResult Source #

The lookUp function returns an WSResult containing geolocation data for an IP address It takes 2 arguments; the web service configuration from openWS function (WSConfig record), either IPv4 or IPv6 address (String)

getCredit :: WSConfig -> IO String Source #

The getCredit function returns an IO String containing web service credit balance for the API key. It takes 1 argument; the web service configuration from openWS function (WSConfig record).