GitLocker: The Coding Marketplace

Description:

registrantalert 1.0.0

Overview
The client library for
Registrant Alert API
in Python language.
The minimum Python version is 3.6.

Installation
pip install registrant-alert

Examples
Full API documentation available here

Create a new client
from registrantalert import *

client = Client('Your API key')

Make basic requests
# Get the number of domains.
terms = {
'include': ['blog']
}
result = client.preview(basic_terms=terms)
print(result.domains_count)

# Get raw API response
raw_result = client.raw_data(
basic_terms=terms,
response_format=Client.XML_FORMAT,
mode=Client.PREVIEW_MODE)

# Get a list of registered/dropped domains (up to 10,000)
result = client.purchase(
basic_terms=terms
)

Advanced usage
Extra request parameters
advanced_terms = [{
'field': Fields.registrant_contact_organization,
'term': 'Airbnb, Inc.',
'exactMatch': True
}]
since_date = datetime.date(2021, 8, 12)
result = client.purchase(
advanced_terms=advanced_terms,
since_date=since_date,
punycode=False)

Response model overview
Response:
- domains_count: int
- domains_list: [Domain]
- domain_name: str
- date: datetime.date
- action: str

Changelog
1.0.0 (2021-09-14)

First release