Keyword Extractor
Keyword Extractor is a simple tool for extracting keywords from a web page. It returns the keywords and the frequency of each keyword.
This API provides reliable and fast access to keyword extractor data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.
To use this API, you need an API key. You can get one by creating a free account and visiting your dashboard.
View API in DirectoryEndpoint
POST https://api.apiverve.com/v1/keywordextractorCode Examples
Here are examples of how to call this API in different programming languages:
curl -X POST \
"https://api.apiverve.com/v1/keywordextractor" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"url": "https://en.wikipedia.org/wiki/Email_address"
}'const response = await fetch('https://api.apiverve.com/v1/keywordextractor', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"url": "https://en.wikipedia.org/wiki/Email_address"
})
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
payload = {
"url": "https://en.wikipedia.org/wiki/Email_address"
}
response = requests.post('https://api.apiverve.com/v1/keywordextractor', headers=headers, json=payload)
data = response.json()
print(data)const https = require('https');
const url = require('url');
const options = {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
};
const postData = JSON.stringify({
"url": "https://en.wikipedia.org/wiki/Email_address"
});
const req = https.request('https://api.apiverve.com/v1/keywordextractor', options, (res) => {
let data = '';
res.on('data', (chunk) => data += chunk);
res.on('end', () => console.log(JSON.parse(data)));
});
req.write(postData);
req.end();<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/keywordextractor');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'X-API-Key: your_api_key_here',
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode({
'url': 'https://en.wikipedia.org/wiki/Email_address'
}));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>package main
import (
"fmt"
"io"
"net/http"
"bytes"
"encoding/json"
)
func main() {
payload := map[string]interface{}{
"url": "https://en.wikipedia.org/wiki/Email_address"
}
jsonPayload, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/keywordextractor", bytes.NewBuffer(jsonPayload))
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require 'net/http'
require 'json'
uri = URI('https://api.apiverve.com/v1/keywordextractor')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
payload = {
"url": "https://en.wikipedia.org/wiki/Email_address"
}
request = Net::HTTP::Post.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'
request.body = payload.to_json
response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))Authentication
This API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereParameters
The following parameters are available for this API endpoint:
| Parameter | Type | Required | Location | Description | Example |
|---|---|---|---|---|---|
| text | string | Yes | body | The text to extract keywords from | - |
Response
The API returns responses in JSON, XML, and YAML formats:
Example Responses
{
"status": "ok",
"error": null,
"data": {
"url": "https://en.wikipedia.org/wiki/Email_address",
"keywords": {
"email": 91,
"address": 61,
"mail": 53,
"domain": 34,
"addresses": 34,
"characters": 27,
"retrieved": 27,
"internet": 17,
"message": 15,
"validation": 12,
"mailbox": 12,
"errata": 12,
"allowed": 12,
"messages": 11,
"systems": 10,
"ietf": 10,
"names": 10,
"user": 10,
"protocol": 10,
"internationalized": 9,
"solid": 9,
"account": 8,
"addressing": 8,
"host": 8,
"simple": 8,
"transfer": 8,
"mailboxes": 8,
"character": 8,
"quoted": 8,
"additional": 7,
"syntax": 7,
"verification": 7,
"form": 7,
"format": 7,
"klensin": 7,
"july": 6,
"tools": 6,
"valid": 6,
"internationalization": 6,
"group": 6,
"system": 6,
"services": 6,
"case": 6,
"smtp": 6,
"ascii": 6,
"backslash": 6,
"servers": 6,
"server": 6,
"original": 6,
"archived": 6
}
}
}<Root>
<status>ok</status>
<error />
<data>
<url>https://en.wikipedia.org/wiki/Email_address</url>
<keywords>
<email>91</email>
<address>61</address>
<mail>53</mail>
<domain>34</domain>
<addresses>34</addresses>
<characters>27</characters>
<retrieved>27</retrieved>
<internet>17</internet>
<message>15</message>
<validation>12</validation>
<mailbox>12</mailbox>
<errata>12</errata>
<allowed>12</allowed>
<messages>11</messages>
<systems>10</systems>
<ietf>10</ietf>
<names>10</names>
<user>10</user>
<protocol>10</protocol>
<internationalized>9</internationalized>
<solid>9</solid>
<account>8</account>
<addressing>8</addressing>
<host>8</host>
<simple>8</simple>
<transfer>8</transfer>
<mailboxes>8</mailboxes>
<character>8</character>
<quoted>8</quoted>
<additional>7</additional>
<syntax>7</syntax>
<verification>7</verification>
<form>7</form>
<format>7</format>
<klensin>7</klensin>
<july>6</july>
<tools>6</tools>
<valid>6</valid>
<internationalization>6</internationalization>
<group>6</group>
<system>6</system>
<services>6</services>
<case>6</case>
<smtp>6</smtp>
<ascii>6</ascii>
<backslash>6</backslash>
<servers>6</servers>
<server>6</server>
<original>6</original>
<archived>6</archived>
</keywords>
</data>
</Root>status: ok
error:
data:
url: https://en.wikipedia.org/wiki/Email_address
keywords:
email: 91
address: 61
mail: 53
domain: 34
addresses: 34
characters: 27
retrieved: 27
internet: 17
message: 15
validation: 12
mailbox: 12
errata: 12
allowed: 12
messages: 11
systems: 10
ietf: 10
names: 10
user: 10
protocol: 10
internationalized: 9
solid: 9
account: 8
addressing: 8
host: 8
simple: 8
transfer: 8
mailboxes: 8
character: 8
quoted: 8
additional: 7
syntax: 7
verification: 7
form: 7
format: 7
klensin: 7
july: 6
tools: 6
valid: 6
internationalization: 6
group: 6
system: 6
services: 6
case: 6
smtp: 6
ascii: 6
backslash: 6
servers: 6
server: 6
original: 6
archived: 6Response Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
| status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
| error | string | null | Contains error message if status is "error", otherwise null | null |
| data | object | null | Contains the API response data if successful, otherwise null | {...} |
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value |
|---|---|---|
| url | string | "https://en.wikipedia.org/wiki/Email_address" |
| keywords | object | {...} |
| keywords.email | number | 91 |
| keywords.address | number | 61 |
| keywords.mail | number | 53 |
| keywords.domain | number | 34 |
| keywords.addresses | number | 34 |
| keywords.characters | number | 27 |
| keywords.retrieved | number | 27 |
| keywords.internet | number | 17 |
| keywords.message | number | 15 |
| keywords.validation | number | 12 |
| keywords.mailbox | number | 12 |
| keywords.errata | number | 12 |
| keywords.allowed | number | 12 |
| keywords.messages | number | 11 |
| keywords.systems | number | 10 |
| keywords.ietf | number | 10 |
| keywords.names | number | 10 |
| keywords.user | number | 10 |
Headers
Required and optional headers for API requests:
| Header Name | Required | Example Value | Description |
|---|---|---|---|
| X-API-Key | Yes | your_api_key_here | Your APIVerve API key. Found in your dashboard under API Keys. |
| Accept | No | application/json | Specify response format: application/json (default), application/xml, or application/yaml |
| User-Agent | No | MyApp/1.0 | Identifies your application for analytics and debugging purposes |
| X-Request-ID | No | req_123456789 | Custom request identifier for tracking and debugging requests |
| Cache-Control | No | no-cache | Control caching behavior for the request and response |
Client Libraries
To get started with minimal code, most of our APIs are available through client libraries and clients:
Error Codes
The API uses standard HTTP status codes to indicate success or failure:
| Status Code | Message | Description |
|---|---|---|
| 200 | OK | Request successful, data returned |
| 400 | Bad Request | Invalid request parameters or malformed request |
| 401 | Unauthorized | Missing or invalid API key |
| 403 | Forbidden | API key does not have permission for this endpoint |
| 429 | Too Many Requests | Rate limit exceeded, please slow down requests |
| 500 | Internal Server Error | Server error, please try again later |
Was this page helpful?
Help us improve our documentation




