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

IP2ProxyWebService

Description

This Haskell package allows users to query an IP address to determine if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits.

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

Synopsis

data WSResult = WSResult {
- response :: String
- countryCode :: Maybe String
- countryName :: Maybe String
- regionName :: Maybe String
- cityName :: Maybe String
- isp :: Maybe String
- domain :: Maybe String
- usageType :: Maybe String
- asn :: Maybe String
- as :: Maybe String
- lastSeen :: Maybe String
- proxyType :: Maybe String
- threat :: Maybe String
- isProxy :: Maybe String
- provider :: Maybe String
}
data WSConfig
openWS :: String -> String -> Bool -> IO WSConfig
lookUp :: WSConfig -> String -> IO WSResult
getCredit :: WSConfig -> IO WSResult

Documentation

data WSResult Source #

Contains the web service results.

Constructors

WSResult

Fields

response :: String
Response status or error
countryCode :: Maybe String
Country code
countryName :: Maybe String
Country name
regionName :: Maybe String
Region name
cityName :: Maybe String
City name
isp :: Maybe String
ISP name
domain :: Maybe String
Domain
usageType :: Maybe String
Usage type
asn :: Maybe String
Autonomous System Number
as :: Maybe String
Autonomous System
lastSeen :: Maybe String
Proxy last seen in days
proxyType :: Maybe String
Proxy type
threat :: Maybe String
Threat type
isProxy :: Maybe String
Whether is a proxy
provider :: Maybe String
VPN provider name

Instances

Instances details

Eq WSResult Source #
Instance details Defined in IP2ProxyWebService Methods (==) :: WSResult -> WSResult -> Bool # (/=) :: WSResult -> WSResult -> Bool #
Show WSResult Source #
Instance details Defined in IP2ProxyWebService Methods showsPrec :: Int -> WSResult -> ShowS # show :: WSResult -> String # showList :: [WSResult] -> ShowS #
ToJSON WSResult Source #
Instance details Defined in IP2ProxyWebService Methods toJSON :: WSResult -> Value # toEncoding :: WSResult -> Encoding # toJSONList :: [WSResult] -> Value # toEncodingList :: [WSResult] -> Encoding #
FromJSON WSResult Source #
Instance details Defined in IP2ProxyWebService 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 IP2ProxyWebService 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 proxy 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 WSResult Source #

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