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": 89,
      "address": 59,
      "mail": 53,
      "domain": 34,
      "addresses": 34,
      "characters": 27,
      "retrieved": 27,
      "internet": 17,
      "message": 16,
      "validation": 12,
      "mailbox": 12,
      "errata": 12,
      "allowed": 12,
      "messages": 11,
      "july": 10,
      "systems": 10,
      "names": 10,
      "user": 10,
      "protocol": 10,
      "ietf": 9,
      "internationalized": 9,
      "articles": 8,
      "account": 8,
      "solid": 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
    }
  }
}

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.2.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for apiverve_keywordextractor-1.1.2.tar.gz
Algorithm Hash digest
SHA256 a07b35b7e44f38b8a3683387d1710ca1a9236ea10d49d8cfbfc911ddb73c9b94
MD5 7bd2d05d690e41404155c70c8693042c
BLAKE2b-256 cee7e06b663b640163894fdb19620ece324c2d06d490195469c5e92f338300bc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_keywordextractor-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 02e58f84184a88786cf70a04ecfddc27bf914982d2f2f5eec5f8da5e756e437d
MD5 fadd78f765ea71965957783f1b47ef0f
BLAKE2b-256 9c739fa33a279307582725a07be9a7ac60196c706cb88776eb204b27f69d2c29

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