https://github.com/ip2location/ip2proxy-laravel

IP2Proxy Laravel extension enables the user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits.
https://github.com/ip2location/ip2proxy-laravel

ip2proxy ip2proxy-database ip2proxy-laravel laravel laravel-extension laravel-framework laravel-package proxy-database tor-exits vpn-anonymizer web-proxy

Last synced: 12 days ago
JSON representation

IP2Proxy Laravel extension enables the user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits.

• Host: GitHub
• URL: https://github.com/ip2location/ip2proxy-laravel
• Owner: ip2location
• License: mit
• Created: 2017-10-03T06:46:55.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-08T06:16:25.000Z (about 1 month ago)
• Last Synced: 2024-10-22T09:57:29.873Z (22 days ago)
• Topics: ip2proxy, ip2proxy-database, ip2proxy-laravel, laravel, laravel-extension, laravel-framework, laravel-package, proxy-database, tor-exits, vpn-anonymizer, web-proxy
• Language: PHP
• Size: 20.5 KB
• Stars: 10
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: license.txt

Awesome Lists containing this project

README

        
# IP2Proxy Laravel Extension

[![Latest Stable Version](https://img.shields.io/packagist/v/ip2location/ip2proxy-laravel.svg)](https://packagist.org/packages/ip2location/ip2proxy-laravel)

[![Total Downloads](https://img.shields.io/packagist/dt/ip2location/ip2proxy-laravel.svg?style=flat-square)](https://packagist.org/packages/ip2location/ip2proxy-laravel)

IP2Proxy Laravel extension enables the user to query an IP address if it was being used as VPN servers, open proxies, web proxies, Tor exit nodes, search engine robots, data center ranges, residential proxies, consumer privacy networks, and enterprise private networks.

*Note: This extension works in Laravel 6, Laravel 7, Laravel 8 and Laravel 9, Laravel 10 and Laravel 11.*

## INSTALLATION

Run the command: `composer require ip2location/ip2proxy-laravel` to download the package into the Laravel platform.

## USAGE

IP2Proxy Laravel extension is able to query the IP address proxy information from either BIN database or web service. This section will explain how to use this extension to query from BIN database and web service.

### BIN DATABASE

1. Download IP2Proxy BIN database

    - IP2Proxy free LITE database at https://lite.ip2location.com

    - IP2Proxy commercial database at https://www.ip2location.com/proxy-database

2. To use IP2Proxy databases, create a folder named as `ip2proxy` in the `database` directory.

3. Unzip and copy the BIN file into `database/ip2proxy/` folder. 

4. Rename the BIN file to IP2PROXY.BIN.

5. Create a **TestController** in Laravel using the below command line

```

php artisan make:controller TestController

```

6. Open the **app/Http/Controllers/TestController.php** in any text editor.

7. To use IP2Proxy databases, add the below lines into the controller file

```php

IP Address: ' . $records['ipAddress'] . '';

        echo '
IP Number: ' . $records['ipNumber'] . '
';

        echo '
IP Version: ' . $records['ipVersion'] . '
';

        echo '
Country Code: ' . $records['countryCode'] . '
';

        echo '
Country: ' . $records['countryName'] . '
';

        echo '
State: ' . $records['regionName'] . '
';

        echo '
City: ' . $records['cityName'] . '
';

        echo '
Proxy Type: ' . $records['proxyType'] . '
';

        echo '
Is Proxy: ' . $records['isProxy'] . '
';

        echo '
ISP: ' . $records['isp'] . '
';

        echo '
Domain: ' . $records['domain'] . '
';

        echo '
Usage Type: ' . $records['usageType'] . '
';

        echo '
ASN: ' . $records['asn'] . '
';

        echo '
AS: ' . $records['as'] . '
';

        echo '
Last Seen: ' . $records['lastSeen'] . '
';

        echo '
Threat: ' . $records['threat'] . '
';

        echo '
Provider: ' . $records['provider'] . '
';

    }

}

```

8. Add the following line into the *routes/web.php* file.

```

Route::get('test', 'App\Http\Controllers\TestController@lookup');

```

9. Enter the URL /test and run. You should see the information of **1.2.3.4** IP address.


### WEB SERVICE

1. To use IP2Location.io or IP2Proxy Web Service, create a new file called "site_vars.php" in `config` directory.

2. In the site_vars.php, save the following contents for IP2Location.io:

```

 'your_api_key', // Required. Your IP2Location.io API key.

    'IP2LocationioLanguage' => 'en', // Optional. Refer to https://www.ip2location.io/ip2location-documentation for available languages.

];

```

Or save the following contents for IP2Proxy:

```php

 'your_api_key', // Required. Your IP2Proxy API key.

    'IP2ProxyPackage' => 'PX1', // Required. Choose the package you would like to use.

    'IP2ProxyUsessl' => false, // Optional. Use https or http.

];

```

3. Create a **TestController** in Laravel using the below command line

```

php artisan make:controller TestController

```

4. Open the **app/Http/Controllers/TestController.php** in any text editor.

5. To use IP2Proxy Web Service, add the below lines into the controller file.

```php

';

        print_r($records);

        echo '';

    }

}

```

6. Add the following line into the *routes/web.php* file.

```

Route::get('test', 'App\Http\Controllers\TestController@lookup');

```

7. Enter the URL /test and run. You should see the information of **1.2.3.4** IP address.

## DEPENDENCIES (IP2PROXY BIN DATA FILE)

This library requires IP2Proxy BIN data file to function. You may download the BIN data file at

* IP2Proxy LITE BIN Data (Free): https://lite.ip2location.com

* IP2Proxy Commercial BIN Data (Comprehensive): https://www.ip2location.com/proxy-database

## SUPPORT

Email: [email protected]

Website: https://www.ip2location.com