Skip to main content

Keyword Extractor is a simple tool for extracting keywords from a web page. It returns the keywords and the frequency of each keyword.

Project description

Keyword Extractor API

Keyword Extractor is a simple tool for extracting keywords from a web page. It returns the keywords and the frequency of each keyword.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Keyword Extractor API


Installation

pip install apiverve-keywordextractor

Configuration

Before using the keywordextractor 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 Keyword Extractor API documentation is found here: https://docs.apiverve.com/api/keywordextractor.
You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_keywordextractor.apiClient import KeywordextractorAPIClient

# Initialize the client with your APIVerve API key
api = KeywordextractorAPIClient("[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",
    "keywords": {
      "email": 90,
      "address": 60,
      "mail": 53,
      "domain": 34,
      "addresses": 34,
      "characters": 27,
      "retrieved": 27,
      "internet": 17,
      "message": 16,
      "validation": 12,
      "mailbox": 12,
      "errata": 12,
      "allowed": 12,
      "messages": 11,
      "systems": 10,
      "names": 10,
      "user": 10,
      "protocol": 10,
      "july": 9,
      "solid": 9,
      "ietf": 9,
      "internationalized": 9,
      "articles": 8,
      "account": 8,
      "host": 8,
      "simple": 8,
      "transfer": 8,
      "mailboxes": 8,
      "character": 8,
      "quoted": 8,
      "additional": 7,
      "syntax": 7,
      "verification": 7,
      "addressing": 7,
      "form": 7,
      "format": 7,
      "technical": 6,
      "tools": 6,
      "valid": 6,
      "internationalization": 6,
      "group": 6,
      "system": 6,
      "services": 6,
      "case": 6,
      "smtp": 6,
      "klensin": 6,
      "ascii": 6,
      "backslash": 6,
      "servers": 6,
      "server": 6
    }
  },
  "code": 200
}

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_keywordextractor-1.1.5.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file apiverve_keywordextractor-1.1.5.tar.gz.

File metadata

File hashes

Hashes for apiverve_keywordextractor-1.1.5.tar.gz
Algorithm Hash digest
SHA256 cf06137cab4015bd39056240d643f62ba8eb555f4a4ab7ea1532bea12eefe0e6
MD5 97df56c4cfe787ceef4bded46a0e71be
BLAKE2b-256 674ab6fb99db150e78600651fa661a35855b4d22e7d6a03efa5d097eb6fbba88

See more details on using hashes here.

File details

Details for the file apiverve_keywordextractor-1.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_keywordextractor-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 bb5d3e5df3e8fd5ea8a441aa317c1d2dd7bf4ca161fcbe78a8199117310d5ca1
MD5 7d94b65f022eb0e5ba1f644b70db80af
BLAKE2b-256 755cedbec8eee9ca04ad9c9c91c2762b658cd47f0659b8478ed17331f6db0ade

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