whoisfreaks-js

v0.20.0

Published

17 hours ago

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/doc

0High
0Medium
0Low

wf-official

whoisfreaks

WhoisFreaks - JavaScript client for 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: [email protected]

This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 0.20.0
Generator version: 7.11.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://whoisfreaks.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install whoisfreaks --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your whoisfreaks from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var WhoisFreaks = require('whoisfreaks');

var defaultClient = WhoisFreaks.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['apiKey'] = "Token"

var api = new WhoisFreaks.ASNWHOISApi()
var asn = "as15169"; // {String} 
var opts = {
  'format': "'json'" // {String} 
};
api.asnWhois(asn, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

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

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

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme