whoisfreaks

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
);
$asn = as15169; // string
$format = 'json'; // string

try {
    $result = $apiInstance->asnWhois($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

Class	Method	HTTP request	Description
ASNWHOISApi	asnWhois	GET /v2.0/asn-whois	ASN WHOIS Lookup
AccountApi	accountUsage	GET /v1.0/whoisapi/usage	Account Usage
AccountApi	databaseFileStatus	GET /v3.4/status	Database File Status (Public)
AccountApi	rotateApiKey	GET /v1.0/api-key/rotate	Rotate API Key
DNSApi	dnsBulk	POST /v2.0/dns/bulk/live	Bulk DNS Lookup
DNSApi	dnsHistorical	GET /v2.0/dns/historical	Historical DNS Lookup
DNSApi	dnsLive	GET /v2.0/dns/live	Live DNS Lookup
DNSApi	dnsReverse	GET /v2.1/dns/reverse	Reverse DNS Lookup
DatabasesASNWHOISApi	dbAsnWhois	GET /v3.3/download/snapshot/asn/whois	ASN WHOIS Snapshot
DatabasesASNWHOISApi	dbAsnWhoisStatus	GET /v3.3/status/snapshot/asn/whois	ASN WHOIS Snapshot Status
DatabasesDNSApi	dbDnsDaily	GET /v3.2/download/dbupdate/daily/dns	DNS Database Daily
DatabasesDNSApi	dbDnsMonthly	GET /v3.2/download/dbupdate/monthly/dns	DNS Database Monthly
DatabasesDNSApi	dbDnsWeekly	GET /v3.2/download/dbupdate/weekly/dns	DNS Database Weekly
DatabasesExpiringDroppedApi	dbDropped	GET /v3.1/download/domainer/dropped	Dropped Domains
DatabasesExpiringDroppedApi	dbDroppedBacklinks	GET /v3.3/download/domainer/dropped/backlinks	Dropped With Backlinks
DatabasesExpiringDroppedApi	dbDroppedJson	GET /v3.1/domains/dropped	Dropped Domains (JSON)
DatabasesExpiringDroppedApi	dbExpired	GET /v3.1/download/domainer/expired	Expiring Domains
DatabasesExpiringDroppedApi	dbExpiredCleaned	GET /v3.1/download/domainer/expired/cleaned	Expiring Cleaned WHOIS
DatabasesIPGeolocationApi	dbIpCity	GET /v3.3/download/snapshot/ip/city	IP to City Snapshot
DatabasesIPGeolocationApi	dbIpCityStatus	GET /v3.3/status/snapshot/ip/city	IP to City Snapshot Status
DatabasesIPGeolocationApi	dbIpCountry	GET /v3.3/download/snapshot/ip/country	IP to Country Snapshot
DatabasesIPGeolocationApi	dbIpCountryStatus	GET /v3.3/status/snapshot/ip/country	IP to Country Snapshot Status
DatabasesIPSecurityApi	dbIpSecurity	GET /v3.3/download/snapshot/ip/security	IP Security Snapshot
DatabasesIPSecurityApi	dbIpSecurityStatus	GET /v3.3/status/snapshot/ip/security	IP Security Snapshot Status
DatabasesIPWHOISApi	dbIpWhois	GET /v3.3/download/snapshot/ip/whois	IP WHOIS Snapshot
DatabasesIPWHOISApi	dbIpWhoisStatus	GET /v3.3/status/snapshot/ip/whois	IP WHOIS Snapshot Status
DatabasesNewlyRegisteredApi	dbNewlyCctld	GET /v3.1/download/domainer/cctld	Newly Registered ccTLD (CSV)
DatabasesNewlyRegisteredApi	dbNewlyCctldCleaned	GET /v3.1/download/domainer/cctld/cleaned	Newly Registered ccTLD Cleaned WHOIS (CSV)
DatabasesNewlyRegisteredApi	dbNewlyCctldJson	GET /v3.1/domains/newly/cctld	Newly Registered ccTLD (JSON)
DatabasesNewlyRegisteredApi	dbNewlyDns	GET /v3.1/download/domainer/newly/dns	Newly Registered With DNS
DatabasesNewlyRegisteredApi	dbNewlyGtld	GET /v3.1/download/domainer/gtld	Newly Registered gTLD (CSV)
DatabasesNewlyRegisteredApi	dbNewlyGtldCleaned	GET /v3.1/download/domainer/gtld/cleaned	Newly Registered gTLD Cleaned WHOIS (CSV)
DatabasesNewlyRegisteredApi	dbNewlyGtldJson	GET /v3.1/domains/newly/gtld	Newly Registered gTLD (JSON)
DatabasesSubdomainsApi	dbSubdomainsDaily	GET /v3.2/download/dbupdate/daily/subdomains	Subdomains Daily
DatabasesSubdomainsApi	dbSubdomainsMonthly	GET /v3.2/download/dbupdate/monthly/subdomains	Subdomains Monthly
DatabasesSubdomainsApi	dbSubdomainsWeekly	GET /v3.2/download/dbupdate/weekly/subdomains	Subdomains Weekly
DatabasesThreatFeedApi	downloadThreatFeedMalware	GET /v3.4/download/threat-feed/malware	Download the daily malware threat feed (CSV)
DatabasesThreatFeedApi	downloadThreatFeedMalwareSample	GET /v3.4/download/threat-feed/malware/sample	Download a sample of the malware threat feed (CSV)
DatabasesThreatFeedApi	downloadThreatFeedPhishing	GET /v3.4/download/threat-feed/phishing	Download the daily phishing threat feed (CSV)
DatabasesThreatFeedApi	downloadThreatFeedPhishingSample	GET /v3.4/download/threat-feed/phishing/sample	Download a sample of the phishing threat feed (CSV)
DatabasesThreatFeedApi	downloadThreatFeedSpam	GET /v3.4/download/threat-feed/spam	Download the daily spam threat feed (CSV)
DatabasesThreatFeedApi	downloadThreatFeedSpamSample	GET /v3.4/download/threat-feed/spam/sample	Download a sample of the spam threat feed (CSV)
DatabasesWHOISApi	dbWhoisDaily	GET /v3.3/download/dbupdate/daily/domains/whois	WHOIS Database Daily
DatabasesWHOISApi	dbWhoisMonthly	GET /v3.3/download/dbupdate/monthly/domains/whois	WHOIS Database Monthly
DatabasesWHOISApi	dbWhoisWeekly	GET /v3.3/download/dbupdate/weekly/domains/whois	WHOIS Database Weekly
DomainAvailabilityApi	bulkDomainAvailabilityV2	POST /v2.0/domain/availability	Bulk Domain Availability Check
DomainAvailabilityApi	domainAvailabilityV2	GET /v2.0/domain/availability	Domain Availability Check with Suggestions
DomainReputationApi	domainReputation	GET /v1/domain/security	Domain Reputation Lookup
GeolocationApi	bulkGeolocation	POST /v1.0/geolocation	Bulk IP Geolocation
GeolocationApi	geolocation	GET /v1.0/geolocation	IP Geolocation Lookup
IPReputationApi	bulkIpReputation	POST /v1.0/security	Bulk IP Reputation
IPReputationApi	ipReputation	GET /v1.0/security	IP Reputation Lookup
IPWHOISApi	ipWhois	GET /v1.0/ip-whois	IP WHOIS Lookup
SSLApi	sslLookup	GET /v1.0/ssl/live	SSL Certificate Lookup
SubdomainsApi	subdomains	GET /v1.0/subdomains	Subdomains Lookup
TyposquattingApi	typosquatting	GET /v3.0/domain/typos	Typosquatting Lookup
WHOISApi	bulkWhois	POST /v2.0/bulkwhois/live	Bulk WHOIS Lookup
WHOISApi	whoisHistory	GET /v2.0/whois/history	Historical WHOIS records for a domain
WHOISApi	whoisLive	GET /v2.0/whois/live	Live WHOIS Lookup
WHOISApi	whoisReverse	GET /v2.0/whois/reverse	Reverse WHOIS lookup by keyword

Models

• AccountUsageResponse
• ApiCredits
• ApiSubscription
• AsnInfo
• AsnPeer
• AsnWhoisResponse
• BulkDnsResponse
• BulkDomainAvailabilityRequest
• BulkDomainAvailabilityResponse
• BulkGeolocationRequest
• BulkWhoisItem
• BulkWhoisRequest
• BulkWhoisResponse
• CountryMetadata
• Currency
• DatabaseFileStatus
• DatabaseUpdates
• DateRangeStatus
• DgaFeatures
• DgaScore
• DnsBulkRequest
• DnsRecord
• DnsResponse
• DomainAvailabilityItem
• DomainAvailabilityResponse
• DomainReputationInput
• DomainReputationResponse
• EligibilityInfo
• ErrorResponse
• EvidenceSummary
• GeoAsn
• GeoCompany
• GeoNetwork
• GeolocationResponse
• HistoricalDnsResponse
• InetNum
• IpLocation
• IpReputationResponse
• IpSecurity
• IpSecurityAsn
• IpSecurityNetwork
• IpWhoisResponse
• Irt
• NewlyStatus
• PersonalInformation
• PivotMatch
• RegistrarInformation
• RegistryData
• RelatedIoc
• ReputationIndicators
• ReputationIntelligence
• ReputationSignal
• ReputationSignals
• ResellerContact
• ReverseDnsResponse
• ReverseWhoisResponse
• RiskCategory
• Route
• SnapshotStatus
• SslAlternateNames
• SslAuthorityInfo
• SslCertificate
• SslCertificatePolicy
• SslExtensionsInfo
• SslPublicKeyInfo
• SslResponse
• SslUnitInfo
• Subdomain
• SubdomainsResponse
• ThreatFeedStatus
• ThreatSource
• TrustSignals
• TyposquattingDomain
• TyposquattingResponse
• UpdateFrequencies
• WhoisHistoricalItem
• WhoisHistoricalResponse
• WhoisOrganization
• WhoisPerson
• WhoisResponse
• WhoisRole

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.21.0
  • Generator version: 7.11.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen