Added functions that allow the opening of the BIN file once and querying multiple times.

Author: ip2location-com

ChangeLog.md

@@ -1,5 +1,9 @@
 # Revision history for ip2proxy
 
+## 3.4.0  -- 2026-01-12
+
+* Added functions that allow the opening of the BIN file once and querying multiple times.
+
 ## 3.3.0  -- 2025-02-18
 
 * Added support for fraud score.

IP2Proxy.hs

@@ -2,7 +2,7 @@
 {-|
 Module      : IP2ProxyWebService
 Description : IP2Proxy Haskell package
-Copyright   : (c) IP2Location, 2018 - 2025
+Copyright   : (c) IP2Location, 2018 - 2026
 License     : MIT
 Maintainer  : sales@ip2location.com
 Stability   : experimental

IP2ProxyWebService.hs

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2026 IP2Location.com
+Copyright (c) 2018 - 2026 IP2Location.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

LICENSE

@@ -1,10 +1,12 @@
 # IP2Proxy Haskell API
 
 ## IP2Proxy Class
-```{py:function} open(binpath)
+```{py:function} openBS(contents)
 Load the IP2Proxy BIN database for lookup.
 
-:param str binpath: (Required) The file path links to IP2Proxy BIN databases.
+:param Data.ByteString.Lazy.ByteString contents: (Required) The IP2Proxy BIN database file content.
+:return: Returns the meta data in Record
+:rtype: Record
 ```
 
 ```{py:function} getPackageVersion()
@@ -28,9 +30,11 @@ Return the database's compilation date as a string of the form 'YYYY-MM-DD'.
 :rtype: string
 ```
 
-```{py:function} getAll(ipAddress)
+```{py:function} getAllBS(contents, meta, ipAddress)
 Retrieve geolocation information for an IP address.
 
+:param Data.ByteString.Lazy.ByteString contents: (Required) The IP2Proxy BIN database file content.
+:param Meta meta: (Required) The BIN file meta data.
 :param string ipAddress: (Required) The IP address (IPv4 or IPv6).
 :return: Returns the geolocation information in array. Refer below table for the fields avaliable in the array
 :rtype: array

docs/source/code.md

@@ -4,11 +4,11 @@
 # -- Project information
 
 project = 'IP2Proxy Haskell'
-copyright = '2025, IP2Location'
+copyright = '2026, IP2Location'
 author = 'IP2Location'
 
-release = '0.1.0'
-version = '0.1.0'
+release = '3.4.0'
+version = '3.4.0'
 
 # -- General configuration
 

docs/source/conf.py

@@ -24,18 +24,20 @@ You can query the geolocation information from the IP2Proxy BIN database as belo
 
 ```haskell
 import IP2Proxy
+import qualified Data.ByteString.Lazy as BS
 
 main :: IO ()
 main = do
     let myfile = "./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL-PROVIDER-FRAUDSCORE.BIN"
     let ip = "197.85.191.64"
-    meta <- open myfile
+    contents <- BS.readFile myfile -- load BIN once
+    meta <- openBS contents
 
     putStrLn $ "module_version: " ++ getModuleVersion
     putStrLn $ "package_version: " ++ (getPackageVersion meta)
     putStrLn $ "database_version: " ++ (getDatabaseVersion meta)
 
-    result <- getAll myfile meta ip
+    result <- getAllBS contents meta ip
     putStrLn $ "country_short: " ++ (show (country_short result))
     putStrLn $ "country_long: " ++ (show (country_long result))
     putStrLn $ "region: " ++ (show (region result))
@@ -52,34 +54,34 @@ main = do
     putStrLn $ "fraud_score: " ++ (show (fraud_score result))
     putStrLn $ "is_proxy: " ++ (show (is_proxy result))
 
-    result <- getCountryShort myfile meta ip
+    result <- getCountryShortBS contents meta ip
     putStrLn $ "country_short: " ++ result
-    result <- getCountryLong myfile meta ip
+    result <- getCountryLongBS contents meta ip
     putStrLn $ "country_long: " ++ result
-    result <- getRegion myfile meta ip
+    result <- getRegionBS contents meta ip
     putStrLn $ "region: " ++ result
-    result <- getCity myfile meta ip
+    result <- getCityBS contents meta ip
     putStrLn $ "city: " ++ result
-    result <- getISP myfile meta ip
+    result <- getISPBS contents meta ip
     putStrLn $ "isp: " ++ result
-    result <- getProxyType myfile meta ip
+    result <- getProxyTypeBS contents meta ip
     putStrLn $ "proxy_type: " ++ result
-    result <- getDomain myfile meta ip
+    result <- getDomainBS contents meta ip
     putStrLn $ "domain: " ++ result
-    result <- getUsageType myfile meta ip
+    result <- getUsageTypeBS contents meta ip
     putStrLn $ "usage_type: " ++ result
-    result <- getASN myfile meta ip
+    result <- getASNBS contents meta ip
     putStrLn $ "asn: " ++ result
-    result <- getAS myfile meta ip
+    result <- getASBS contents meta ip
     putStrLn $ "as: " ++ result
-    result <- getLastSeen myfile meta ip
+    result <- getLastSeenBS contents meta ip
     putStrLn $ "last_seen: " ++ result
-    result <- getThreat myfile meta ip
+    result <- getThreatBS contents meta ip
     putStrLn $ "threat: " ++ result
-    result <- getProvider myfile meta ip
+    result <- getProviderBS contents meta ip
     putStrLn $ "provider: " ++ result
-    result <- getFraudScore myfile meta ip
+    result <- getFraudScoreBS contents meta ip
     putStrLn $ "fraud_score: " ++ result
-    result <- isProxy myfile meta ip
+    result <- isProxyBS contents meta ip
     putStrLn $ "is_proxy: " ++ result
 ```

docs/source/quickstart.md

@@ -10,7 +10,7 @@ name:                ip2proxy
 -- PVP summary:      +-+------- breaking API changes
 --                   | | +----- non-breaking API additions
 --                   | | | +--- code changes with no API change
-version:             3.3.0
+version:             3.4.0
 
 -- A short (one-line) description of the package.
 synopsis:            IP2Proxy Haskell package for proxy detection.

ip2proxy.cabal

@@ -1,16 +1,18 @@
 import IP2Proxy
+import qualified Data.ByteString.Lazy as BS
 
 main :: IO ()
 main = do
     let myfile = "./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL-PROVIDER-FRAUDSCORE.BIN"
     let ip = "197.85.191.64"
-    meta <- open myfile
+    contents <- BS.readFile myfile -- load BIN once
+    meta <- openBS contents
 
     putStrLn $ "module_version: " ++ getModuleVersion
     putStrLn $ "package_version: " ++ (getPackageVersion meta)
     putStrLn $ "database_version: " ++ (getDatabaseVersion meta)
 
-    result <- getAll myfile meta ip
+    result <- getAllBS contents meta ip
     putStrLn $ "country_short: " ++ (show (country_short result))
     putStrLn $ "country_long: " ++ (show (country_long result))
     putStrLn $ "region: " ++ (show (region result))
@@ -27,33 +29,33 @@ main = do
     putStrLn $ "fraud_score: " ++ (show (fraud_score result))
     putStrLn $ "is_proxy: " ++ (show (is_proxy result))
 
-    result <- getCountryShort myfile meta ip
+    result <- getCountryShortBS contents meta ip
     putStrLn $ "country_short: " ++ result
-    result <- getCountryLong myfile meta ip
+    result <- getCountryLongBS contents meta ip
     putStrLn $ "country_long: " ++ result
-    result <- getRegion myfile meta ip
+    result <- getRegionBS contents meta ip
     putStrLn $ "region: " ++ result
-    result <- getCity myfile meta ip
+    result <- getCityBS contents meta ip
     putStrLn $ "city: " ++ result
-    result <- getISP myfile meta ip
+    result <- getISPBS contents meta ip
     putStrLn $ "isp: " ++ result
-    result <- getProxyType myfile meta ip
+    result <- getProxyTypeBS contents meta ip
     putStrLn $ "proxy_type: " ++ result
-    result <- getDomain myfile meta ip
+    result <- getDomainBS contents meta ip
     putStrLn $ "domain: " ++ result
-    result <- getUsageType myfile meta ip
+    result <- getUsageTypeBS contents meta ip
     putStrLn $ "usage_type: " ++ result
-    result <- getASN myfile meta ip
+    result <- getASNBS contents meta ip
     putStrLn $ "asn: " ++ result
-    result <- getAS myfile meta ip
+    result <- getASBS contents meta ip
     putStrLn $ "as: " ++ result
-    result <- getLastSeen myfile meta ip
+    result <- getLastSeenBS contents meta ip
     putStrLn $ "last_seen: " ++ result
-    result <- getThreat myfile meta ip
+    result <- getThreatBS contents meta ip
     putStrLn $ "threat: " ++ result
-    result <- getProvider myfile meta ip
+    result <- getProviderBS contents meta ip
     putStrLn $ "provider: " ++ result
-    result <- getFraudScore myfile meta ip
+    result <- getFraudScoreBS contents meta ip
     putStrLn $ "fraud_score: " ++ result
-    result <- isProxy myfile meta ip
+    result <- isProxyBS contents meta ip
     putStrLn $ "is_proxy: " ++ result