Skip to main content

is a simple tool for extracting contact data from a website URL. It returns the contact emails, phone numbers, and places.

Project description

Contact Extractor API

is a simple tool for extracting contact data from a website URL. It returns the contact emails, phone numbers, and places.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Contact Extractor API


Installation

pip install apiverve-contactextractor

Configuration

Before using the contactextractor API client, you have to setup your account and obtain your API Key.
You can get it by signing up at https://apiverve.com


Usage

The Contact Extractor API documentation is found here: https://docs.apiverve.com/api/contactextractor.
You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_contactextractor.apiClient import ContactextractorAPIClient

# Initialize the client with your APIVerve API key
api = ContactextractorAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = {  "url": "https://en.wikipedia.org/wiki/Email_address" }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "url": "https://en.wikipedia.org/wiki/Email_address",
    "contactsFound": null,
    "emails": [
      "john.smith@example.com",
      "jsmith@example.com",
      "john.smith@example.org",
      "John..Doe@example.com",
      "johns@example.com",
      "JohnS@example.com",
      "tag@example.com",
      "joeuser@example.com",
      "simple@example.com",
      "very.common@example.com",
      "FirstName.LastName@EasierReading.org",
      "x@example.com",
      "long.email-address-with-hyphens@and.subdomains.example.com",
      "sorting@example.com",
      "user.name@example.com",
      "surname@example.com",
      "example@s.example",
      "username@example.org",
      "example.com@example.org",
      "user@example.com",
      "user-@example.org",
      "CHOCOLATE@example.com",
      "c@example.com",
      "l@example.com",
      "right@example.com",
      "allowed@example.com",
      "tag@domain.com",
      "extension@pobox.com"
    ],
    "phones": [],
    "places": {}
  }
}

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2024 APIVerve, and Evlar LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_contactextractor-1.1.2.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file apiverve_contactextractor-1.1.2.tar.gz.

File metadata

File hashes

Hashes for apiverve_contactextractor-1.1.2.tar.gz
Algorithm Hash digest
SHA256 07467c0d556457cb1b52dd9fa19ac01bce99f6870b5fdcf7cbfa8b66dae443f6
MD5 9b4821e1e42229c31d7ad64c2a66a8bf
BLAKE2b-256 134b3e784bca633c36ac9736d1d6776de51ced634e26e87ee5b443a42217029a

See more details on using hashes here.

File details

Details for the file apiverve_contactextractor-1.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_contactextractor-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0565d88a7448144fc9276b79298b8c321a3eb164e6cf4796adbbd37967f9518a
MD5 37c5a6c8be6f9c5c0052a16c48120dea
BLAKE2b-256 b55e0796ee3ac86cf581ed7fd5f75619d252251dd0315b5aed3d86fbe2d05192

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page