Skip to content

WhoisFreaks/whoisfreaks-python

Repository files navigation

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

This Python package 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.PythonClientCodegen For more information, please visit https://whoisfreaks.com

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import whoisfreaks

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import whoisfreaks

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import whoisfreaks
from whoisfreaks.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.whoisfreaks.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whoisfreaks.Configuration(
    host = "https://api.whoisfreaks.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with whoisfreaks.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whoisfreaks.ASNWHOISApi(api_client)
    asn = 'as15169' # str | 
    format = json # str |  (optional) (default to json)

    try:
        # ASN WHOIS Lookup
        api_response = api_instance.asn_whois(asn, format=format)
        print("The response of ASNWHOISApi->asn_whois:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ASNWHOISApi->asn_whois: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
ASNWHOISApi asn_whois GET /v2.0/asn-whois ASN WHOIS Lookup
AccountApi account_usage GET /v1.0/whoisapi/usage Account Usage
AccountApi database_file_status GET /v3.3/status Database File Status (Public)
AccountApi rotate_api_key GET /v1.0/api-key/rotate Rotate API Key
DNSApi dns_bulk POST /v2.0/dns/bulk/live Bulk DNS Lookup
DNSApi dns_historical GET /v2.0/dns/historical Historical DNS Lookup
DNSApi dns_live GET /v2.0/dns/live Live DNS Lookup
DNSApi dns_reverse GET /v2.1/dns/reverse Reverse DNS Lookup
DatabasesASNWHOISApi db_asn_whois GET /v3.3/download/snapshot/asn/whois ASN WHOIS Snapshot
DatabasesASNWHOISApi db_asn_whois_status GET /v3.3/status/snapshot/asn/whois ASN WHOIS Snapshot Status
DatabasesDNSApi db_dns_daily GET /v3.2/download/dbupdate/daily/dns DNS Database Daily
DatabasesDNSApi db_dns_monthly GET /v3.2/download/dbupdate/monthly/dns DNS Database Monthly
DatabasesDNSApi db_dns_weekly GET /v3.2/download/dbupdate/weekly/dns DNS Database Weekly
DatabasesExpiringDroppedApi db_dropped GET /v3.1/download/domainer/dropped Dropped Domains
DatabasesExpiringDroppedApi db_dropped_backlinks GET /v3.3/download/domainer/dropped/backlinks Dropped With Backlinks
DatabasesExpiringDroppedApi db_dropped_json GET /v3.1/domains/dropped Dropped Domains (JSON)
DatabasesExpiringDroppedApi db_expired GET /v3.1/download/domainer/expired Expiring Domains
DatabasesExpiringDroppedApi db_expired_cleaned GET /v3.1/download/domainer/expired/cleaned Expiring Cleaned WHOIS
DatabasesIPGeolocationApi db_ip_city GET /v3.3/download/snapshot/ip/city IP to City Snapshot
DatabasesIPGeolocationApi db_ip_city_status GET /v3.3/status/snapshot/ip/city IP to City Snapshot Status
DatabasesIPGeolocationApi db_ip_country GET /v3.3/download/snapshot/ip/country IP to Country Snapshot
DatabasesIPGeolocationApi db_ip_country_status GET /v3.3/status/snapshot/ip/country IP to Country Snapshot Status
DatabasesIPSecurityApi db_ip_security GET /v3.3/download/snapshot/ip/security IP Security Snapshot
DatabasesIPSecurityApi db_ip_security_status GET /v3.3/status/snapshot/ip/security IP Security Snapshot Status
DatabasesIPWHOISApi db_ip_whois GET /v3.3/download/snapshot/ip/whois IP WHOIS Snapshot
DatabasesIPWHOISApi db_ip_whois_status GET /v3.3/status/snapshot/ip/whois IP WHOIS Snapshot Status
DatabasesNewlyRegisteredApi db_newly_cctld GET /v3.1/download/domainer/cctld Newly Registered ccTLD (CSV)
DatabasesNewlyRegisteredApi db_newly_cctld_cleaned GET /v3.1/download/domainer/cctld/cleaned Newly Registered ccTLD Cleaned WHOIS (CSV)
DatabasesNewlyRegisteredApi db_newly_cctld_json GET /v3.1/domains/newly/cctld Newly Registered ccTLD (JSON)
DatabasesNewlyRegisteredApi db_newly_dns GET /v3.1/download/domainer/newly/dns Newly Registered With DNS
DatabasesNewlyRegisteredApi db_newly_gtld GET /v3.1/download/domainer/gtld Newly Registered gTLD (CSV)
DatabasesNewlyRegisteredApi db_newly_gtld_cleaned GET /v3.1/download/domainer/gtld/cleaned Newly Registered gTLD Cleaned WHOIS (CSV)
DatabasesNewlyRegisteredApi db_newly_gtld_json GET /v3.1/domains/newly/gtld Newly Registered gTLD (JSON)
DatabasesSubdomainsApi db_subdomains_daily GET /v3.2/download/dbupdate/daily/subdomains Subdomains Daily
DatabasesSubdomainsApi db_subdomains_monthly GET /v3.2/download/dbupdate/monthly/subdomains Subdomains Monthly
DatabasesSubdomainsApi db_subdomains_weekly GET /v3.2/download/dbupdate/weekly/subdomains Subdomains Weekly
DatabasesWHOISApi db_whois_daily GET /v3.3/download/dbupdate/daily/domains/whois WHOIS Database Daily
DatabasesWHOISApi db_whois_monthly GET /v3.3/download/dbupdate/monthly/domains/whois WHOIS Database Monthly
DatabasesWHOISApi db_whois_weekly GET /v3.3/download/dbupdate/weekly/domains/whois WHOIS Database Weekly
DomainAvailabilityApi bulk_domain_availability_v2 POST /v2.0/domain/availability Bulk Domain Availability Check
DomainAvailabilityApi domain_availability_v2 GET /v2.0/domain/availability Domain Availability Check with Suggestions
DomainReputationApi domain_reputation GET /v1/domain/security Domain Reputation Lookup
GeolocationApi bulk_geolocation POST /v1.0/geolocation Bulk IP Geolocation
GeolocationApi geolocation GET /v1.0/geolocation IP Geolocation Lookup
IPReputationApi bulk_ip_reputation POST /v1.0/security Bulk IP Reputation
IPReputationApi ip_reputation GET /v1.0/security IP Reputation Lookup
IPWHOISApi ip_whois GET /v1.0/ip-whois IP WHOIS Lookup
SSLApi ssl_lookup 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 bulk_whois POST /v2.0/bulkwhois/live Bulk WHOIS Lookup
WHOISApi whois_history GET /v2.0/whois/history Historical WHOIS records for a domain
WHOISApi whois_live GET /v2.0/whois/live Live WHOIS Lookup
WHOISApi whois_reverse GET /v2.0/whois/reverse Reverse WHOIS lookup by keyword

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

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

Author

support@whoisfreaks.com

About

Official WhoisFreaks Python SDK for WHOIS, DNS, SSL, IP geolocation and reputation, domain availability, ASN, and domain intelligence APIs.

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors