Swagger\Client\IPAddressApi

All URIs are relative to https://api.cloudmersive.com

Method	HTTP request	Description
iPAddressGeolocateStreetAddress	POST /validate/ip/geolocate/street-address	Geolocate an IP address to a street address
iPAddressIpIntelligence	POST /validate/ip/intelligence	Get intelligence on an IP address
iPAddressIsBot	POST /validate/ip/is-bot	Check if IP address is a Bot client
iPAddressIsThreat	POST /validate/ip/is-threat	Check if IP address is a known threat
iPAddressIsTorNode	POST /validate/ip/is-tor-node	Check if IP address is a Tor node server
iPAddressPost	POST /validate/ip/geolocate	Geolocate an IP address
iPAddressReverseDomainLookup	POST /validate/ip/reverse-domain-lookup	Perform a reverse domain name (DNS) lookup on an IP address

iPAddressGeolocateStreetAddress

\Swagger\Client\Model\GeolocateStreetAddressResponse iPAddressGeolocateStreetAddress($value)

Geolocate an IP address to a street address

Identify an IP address's street address. Useful for security and UX applications.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\IPAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$value = "value_example"; // string | IP address to geolocate, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.

try {
    $result = $apiInstance->iPAddressGeolocateStreetAddress($value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IPAddressApi->iPAddressGeolocateStreetAddress: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
value	string	IP address to geolocate, e.g. "55.55.55.55". The input is a string so be sure to enclose it in double-quotes.

Return type

\Swagger\Client\Model\GeolocateStreetAddressResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iPAddressIpIntelligence

\Swagger\Client\Model\IPIntelligenceResponse iPAddressIpIntelligence($value)

Get intelligence on an IP address

Identify key intelligence about an IP address, including if it is a known threat IP, known bot, Tor exit node, as well as the location of the IP address.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\IPAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$value = "value_example"; // string | IP address to process, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.

try {
    $result = $apiInstance->iPAddressIpIntelligence($value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IPAddressApi->iPAddressIpIntelligence: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
value	string	IP address to process, e.g. "55.55.55.55". The input is a string so be sure to enclose it in double-quotes.

Return type

\Swagger\Client\Model\IPIntelligenceResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iPAddressIsBot

\Swagger\Client\Model\BotCheckResponse iPAddressIsBot($value)

Check if IP address is a Bot client

Check if the input IP address is a Bot, robot, or otherwise a non-user entity. Leverages real-time signals to check against known high-probability bots..

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\IPAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$value = "value_example"; // string | IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.

try {
    $result = $apiInstance->iPAddressIsBot($value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IPAddressApi->iPAddressIsBot: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
value	string	IP address to check, e.g. "55.55.55.55". The input is a string so be sure to enclose it in double-quotes.

Return type

\Swagger\Client\Model\BotCheckResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iPAddressIsThreat

\Swagger\Client\Model\IPThreatResponse iPAddressIsThreat($value)

Check if IP address is a known threat

Check if the input IP address is a known threat IP address. Checks against known bad IPs, botnets, compromised servers, and other lists of threats.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\IPAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$value = "value_example"; // string | IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.

try {
    $result = $apiInstance->iPAddressIsThreat($value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IPAddressApi->iPAddressIsThreat: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
value	string	IP address to check, e.g. "55.55.55.55". The input is a string so be sure to enclose it in double-quotes.

Return type

\Swagger\Client\Model\IPThreatResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iPAddressIsTorNode

\Swagger\Client\Model\TorNodeResponse iPAddressIsTorNode($value)

Check if IP address is a Tor node server

Check if the input IP address is a Tor exit node server. Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\IPAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$value = "value_example"; // string | IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.

try {
    $result = $apiInstance->iPAddressIsTorNode($value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IPAddressApi->iPAddressIsTorNode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
value	string	IP address to check, e.g. "55.55.55.55". The input is a string so be sure to enclose it in double-quotes.

Return type

\Swagger\Client\Model\TorNodeResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iPAddressPost

\Swagger\Client\Model\GeolocateResponse iPAddressPost($value)

Geolocate an IP address

Identify an IP address Country, State/Provence, City, Zip/Postal Code, etc. Useful for security and UX applications.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\IPAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$value = "value_example"; // string | IP address to geolocate, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.

try {
    $result = $apiInstance->iPAddressPost($value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IPAddressApi->iPAddressPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
value	string	IP address to geolocate, e.g. "55.55.55.55". The input is a string so be sure to enclose it in double-quotes.

Return type

\Swagger\Client\Model\GeolocateResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iPAddressReverseDomainLookup

\Swagger\Client\Model\IPReverseDNSLookupResponse iPAddressReverseDomainLookup($value)

Perform a reverse domain name (DNS) lookup on an IP address

Gets the domain name, if any, associated with the IP address.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\IPAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$value = "value_example"; // string | IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.

try {
    $result = $apiInstance->iPAddressReverseDomainLookup($value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IPAddressApi->iPAddressReverseDomainLookup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
value	string	IP address to check, e.g. "55.55.55.55". The input is a string so be sure to enclose it in double-quotes.

Return type

\Swagger\Client\Model\IPReverseDNSLookupResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

IPAddressApi.md

Latest commit

History

IPAddressApi.md

File metadata and controls

Swagger\Client\IPAddressApi

iPAddressGeolocateStreetAddress

Example

Parameters

Return type

Authorization

HTTP request headers

iPAddressIpIntelligence

Example

Parameters

Return type

Authorization

HTTP request headers

iPAddressIsBot

Example

Parameters

Return type

Authorization

HTTP request headers

iPAddressIsThreat

Example

Parameters

Return type

Authorization

HTTP request headers

iPAddressIsTorNode

Example

Parameters

Return type

Authorization

HTTP request headers

iPAddressPost

Example

Parameters

Return type

Authorization

HTTP request headers

iPAddressReverseDomainLookup

Example

Parameters

Return type

Authorization

HTTP request headers