whoisfreaks

WhoisFreaks API

• API version: 1.0.0
  • Generator version: 7.11.0

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

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.whoisfreaks</groupId>
  <artifactId>whoisfreaks</artifactId>
  <version>0.20.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'whoisfreaks' jar has been published to maven central.
    mavenLocal()       // Needed if the 'whoisfreaks' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.whoisfreaks:whoisfreaks:0.20.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/whoisfreaks-0.20.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.whoisfreaks.client.ApiClient;
import com.whoisfreaks.client.ApiException;
import com.whoisfreaks.client.Configuration;
import com.whoisfreaks.client.auth.*;
import com.whoisfreaks.client.model.*;
import com.whoisfreaks.client.api.AccountApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.whoisfreaks.com");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    AccountApi apiInstance = new AccountApi(defaultClient);
    try {
      AccountUsageResponse result = apiInstance.accountUsage();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountApi#accountUsage");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccountApi	accountUsage	GET /v1.0/whoisapi/usage	Account Usage
AccountApi	databaseFileStatus	GET /v3.3/status	Database File Status (Public)
AccountApi	rotateApiKey	GET /v1.0/api-key/rotate	Rotate API Key
AsnWhoisApi	asnWhois	GET /v2.0/asn-whois	ASN WHOIS 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
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
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
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

Documentation for 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
• ThreatSource
• TrustSignals
• TyposquattingDomain
• TyposquattingResponse
• UpdateFrequencies
• WhoisHistoricalItem
• WhoisHistoricalResponse
• WhoisOrganization
• WhoisPerson
• WhoisResponse
• WhoisRole

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@whoisfreaks.com