{"id":21740874,"url":"https://github.com/whois-api-llc/brand-alert-py","last_synced_at":"2025-03-21T01:15:33.591Z","repository":{"id":57416303,"uuid":"364277678","full_name":"whois-api-llc/brand-alert-py","owner":"whois-api-llc","description":"Brand Alert API client library for Python","archived":false,"fork":false,"pushed_at":"2023-05-23T01:12:33.000Z","size":11,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-27T20:22:40.834Z","etag":null,"topics":["brand-alert","brand-monitoring","domain-monitoring","python","whoisxmlapi"],"latest_commit_sha":null,"homepage":"https://brand-alert.whoisxmlapi.com/api","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/whois-api-llc.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-04T14:09:45.000Z","updated_at":"2024-11-06T13:37:29.000Z","dependencies_parsed_at":"2025-01-25T21:27:51.004Z","dependency_job_id":null,"html_url":"https://github.com/whois-api-llc/brand-alert-py","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whois-api-llc%2Fbrand-alert-py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whois-api-llc%2Fbrand-alert-py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whois-api-llc%2Fbrand-alert-py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whois-api-llc%2Fbrand-alert-py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/whois-api-llc","download_url":"https://codeload.github.com/whois-api-llc/brand-alert-py/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244717339,"owners_count":20498284,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["brand-alert","brand-monitoring","domain-monitoring","python","whoisxmlapi"],"created_at":"2024-11-26T06:15:44.583Z","updated_at":"2025-03-21T01:15:33.571Z","avatar_url":"https://github.com/whois-api-llc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. image:: https://img.shields.io/badge/License-MIT-green.svg\n    :alt: brand-alert-py license\n    :target: https://opensource.org/licenses/MIT\n\n.. image:: https://img.shields.io/pypi/v/brand-alert.svg\n    :alt: brand-alert-py release\n    :target: https://pypi.org/project/brand-alert\n\n.. image:: https://github.com/whois-api-llc/brand-alert-py/workflows/Build/badge.svg\n    :alt: brand-alert-py build\n    :target: https://github.com/whois-api-llc/brand-alert-py/actions\n\n========\nOverview\n========\n\nThe client library for\n`Brand Alert API \u003chttps://brand-alert.whoisxmlapi.com/\u003e`_\nin Python language.\n\nThe minimum Python version is 3.6.\n\nInstallation\n============\n\n.. code-block:: shell\n\n    pip install brand-alert\n\nExamples\n========\n\nFull API documentation available `here \u003chttps://brand-alert.whoisxmlapi.com/api/documentation/making-requests\u003e`_\n\nCreate a new client\n-------------------\n\n.. code-block:: python\n\n    from brandalert import *\n\n    client = Client('Your API key')\n\nMake basic requests\n-------------------\n\n.. code-block:: python\n\n    # Get the number of domains.\n    result = client.preview(['google'])\n    print(result.domains_count)\n\n    # Get raw API response\n    raw_result = client.raw_data(\n        ['google'],\n        response_format=Client.XML_FORMAT,\n        mode=Client.PREVIEW_MODE)\n\n    # Get list of recently registered/dropped domains (up to 10,000)\n    result = client.purchase(['google'])\n\nAdvanced usage\n-------------------\n\nExtra request parameters\n\n.. code-block:: python\n\n    today = datetime.date.today()\n    delta = datetime.timedelta(days=10)\n    result = client.purchase(\n        ['google'],\n        exclude_terms=['blog'],\n        since_date=today - delta,\n        with_typos=True,\n        punycode=False)\n\n    raw_result = client.raw_data(\n        ['google'],\n        exclude_terms=['blog'],\n        since_date=today - delta,\n        with_typos=True,\n        punycode=False,\n        mode=Client.PURCHASE_MODE,\n        response_format=Client.JSON_FORMAT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhois-api-llc%2Fbrand-alert-py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwhois-api-llc%2Fbrand-alert-py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhois-api-llc%2Fbrand-alert-py/lists"}