README

Complete WhoisFreaks API — WHOIS, DNS, SSL, Geolocation, Typosquatting, IP Intelligence, Domain Reputation, and bulk database downloads. ## Authentication All requests require an apiKey query parameter.

Resources

• Docs: https://whoisfreaks.com/documentation
• Billing: https://billing.whoisfreaks.com
• Support: support@whoisfreaks.com

For more information, please visit https://whoisfreaks.com.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/whoisfreaks/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



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


$apiInstance = new WhoisFreaks\Api\ASNWHOISApi(
    // 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
);
$apiKey = 'apiKey_example'; // string | Your WHOISFreaks API key
$asn = as15169; // string
$format = 'json'; // string

try {
    $result = $apiInstance->asnWhois($apiKey, $asn, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ASNWHOISApi->asnWhois: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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

Models

• AccountUsageResponse
• AccountUsageResponseApiCredits
• AccountUsageResponseApiSubscription
• AsnWhoisResponse
• AsnWhoisResponseAutNumsInner
• AsnWhoisResponseOrganization
• BulkDomainAvailabilityRequest
• BulkDomainAvailabilityV2Item
• BulkDomainAvailabilityV2Response
• BulkGeolocationRequest
• BulkWhois200Response
• BulkWhoisRequest
• Contact
• DatabaseFileStatus
• DatabaseFileStatusNewlyValue
• DnsBulk200Response
• DnsBulkRequest
• DnsRecord
• DnsResponse
• DomainAvailabilityV2Item
• DomainAvailabilityV2Response
• DomainReputationDgaFeatures
• DomainReputationDgaScore
• DomainReputationEvidenceSummary
• DomainReputationIndicators
• DomainReputationInput
• DomainReputationIntelligence
• DomainReputationPivotMatch
• DomainReputationRelatedIoc
• DomainReputationResponse
• DomainReputationRiskCategory
• DomainReputationSignal
• DomainReputationSignals
• DomainReputationTrustSignals
• ErrorResponse
• GeolocationAsn
• GeolocationLocation
• GeolocationResponse
• GeolocationResponseCurrency
• GeolocationResponseNetwork
• HistoricalDnsResponse
• IpReputationResponse
• IpReputationSecurity
• IpWhoisResponse
• IpWhoisResponseAbuseContactsInner
• IpWhoisResponseInetNumsInner
• IpWhoisResponseOrganization
• Registrar
• ReverseDnsResponse
• ReverseWhoisResponse
• SnapshotStatus
• SslCertificate
• SslResponse
• Subdomain
• SubdomainsResponse
• TyposquattingDomain
• TyposquattingResponse
• WhoisHistoricalOrReverse200Response
• WhoisHistoricalResponse
• WhoisResponse

Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: apiKey
• Location: URL query string

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

support@whoisfreaks.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
  • Package version: 0.7.0
  • Generator version: 7.11.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen