https://github.com/whois-api-llc/brand-alert-py
Brand Alert API client library for Python
https://github.com/whois-api-llc/brand-alert-py
brand-alert brand-monitoring domain-monitoring python whoisxmlapi
Last synced: about 1 year ago
JSON representation
Brand Alert API client library for Python
- Host: GitHub
- URL: https://github.com/whois-api-llc/brand-alert-py
- Owner: whois-api-llc
- License: mit
- Created: 2021-05-04T14:09:45.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-23T01:12:33.000Z (about 3 years ago)
- Last Synced: 2025-02-27T20:22:40.834Z (over 1 year ago)
- Topics: brand-alert, brand-monitoring, domain-monitoring, python, whoisxmlapi
- Language: Python
- Homepage: https://brand-alert.whoisxmlapi.com/api
- Size: 10.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
.. image:: https://img.shields.io/badge/License-MIT-green.svg
:alt: brand-alert-py license
:target: https://opensource.org/licenses/MIT
.. image:: https://img.shields.io/pypi/v/brand-alert.svg
:alt: brand-alert-py release
:target: https://pypi.org/project/brand-alert
.. image:: https://github.com/whois-api-llc/brand-alert-py/workflows/Build/badge.svg
:alt: brand-alert-py build
:target: https://github.com/whois-api-llc/brand-alert-py/actions
========
Overview
========
The client library for
`Brand Alert API `_
in Python language.
The minimum Python version is 3.6.
Installation
============
.. code-block:: shell
pip install brand-alert
Examples
========
Full API documentation available `here `_
Create a new client
-------------------
.. code-block:: python
from brandalert import *
client = Client('Your API key')
Make basic requests
-------------------
.. code-block:: python
# Get the number of domains.
result = client.preview(['google'])
print(result.domains_count)
# Get raw API response
raw_result = client.raw_data(
['google'],
response_format=Client.XML_FORMAT,
mode=Client.PREVIEW_MODE)
# Get list of recently registered/dropped domains (up to 10,000)
result = client.purchase(['google'])
Advanced usage
-------------------
Extra request parameters
.. code-block:: python
today = datetime.date.today()
delta = datetime.timedelta(days=10)
result = client.purchase(
['google'],
exclude_terms=['blog'],
since_date=today - delta,
with_typos=True,
punycode=False)
raw_result = client.raw_data(
['google'],
exclude_terms=['blog'],
since_date=today - delta,
with_typos=True,
punycode=False,
mode=Client.PURCHASE_MODE,
response_format=Client.JSON_FORMAT)