Keyword Extractor API
Overview
To use Keyword Extractor, you need an API key. You can get one by creating a free account and visiting your dashboard.
POST Endpoint
https://api.apiverve.com/v1/keywordextractorExample
How to call the Keyword Extractor 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)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))
}{
"status": "ok",
"error": null,
"data": {
"url": "https://en.wikipedia.org/wiki/Email_address",
"keywordCount": 50,
"topKeyword": "email",
"totalOccurrences": 672,
"keywords": {
"email": 94,
"address": 61,
"mail": 52,
"domain": 34,
"addresses": 34,
"characters": 27,
"retrieved": 27,
"internet": 17,
"message": 15,
"validation": 12
},
"topKeywords": [
{
"keyword": "email",
"count": 94,
"percentage": 14
},
{
"keyword": "address",
"count": 61,
"percentage": 9.1
},
{
"keyword": "mail",
"count": 52,
"percentage": 7.7
},
{
"keyword": "domain",
"count": 34,
"percentage": 5.1
},
{
"keyword": "addresses",
"count": 34,
"percentage": 5.1
}
]
}
}Authentication
The Keyword Extractor API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereInteractive API Playground
Test the Keyword Extractor API directly in your browser with live requests and responses.
Parameters
The Keyword Extractor API supports multiple query options. Use one of the following:
Option 1: Extract Keywords from Text
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
text | string | required | The text to extract keywords from | - |
Option 2: Extract Keywords from URL
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
url | string | required | URL of a web page to extract keywords from | - |
Response
The Keyword Extractor API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.
Other Response Formats
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>ok</status>
<error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<data>
<url>https://en.wikipedia.org/wiki/Email_address</url>
<keywordCount>50</keywordCount>
<topKeyword>email</topKeyword>
<totalOccurrences>672</totalOccurrences>
<keywords>
<email>94</email>
<address>61</address>
<mail>52</mail>
<domain>34</domain>
<addresses>34</addresses>
<characters>27</characters>
<retrieved>27</retrieved>
<internet>17</internet>
<message>15</message>
<validation>12</validation>
</keywords>
<topKeywords>
<topKeyword>
<keyword>email</keyword>
<count>94</count>
<percentage>14</percentage>
</topKeyword>
<topKeyword>
<keyword>address</keyword>
<count>61</count>
<percentage>9.1</percentage>
</topKeyword>
<topKeyword>
<keyword>mail</keyword>
<count>52</count>
<percentage>7.7</percentage>
</topKeyword>
<topKeyword>
<keyword>domain</keyword>
<count>34</count>
<percentage>5.1</percentage>
</topKeyword>
<topKeyword>
<keyword>addresses</keyword>
<count>34</count>
<percentage>5.1</percentage>
</topKeyword>
</topKeywords>
</data>
</response>
status: ok
error: null
data:
url: https://en.wikipedia.org/wiki/Email_address
keywordCount: 50
topKeyword: email
totalOccurrences: 672
keywords:
email: 94
address: 61
mail: 52
domain: 34
addresses: 34
characters: 27
retrieved: 27
internet: 17
message: 15
validation: 12
topKeywords:
- keyword: email
count: 94
percentage: 14
- keyword: address
count: 61
percentage: 9.1
- keyword: mail
count: 52
percentage: 7.7
- keyword: domain
count: 34
percentage: 5.1
- keyword: addresses
count: 34
percentage: 5.1
| key | value |
|---|---|
| url | https://en.wikipedia.org/wiki/Email_address |
| keywordCount | 50 |
| topKeyword | |
| totalOccurrences | 672 |
| keywords | {email:94,address:61,mail:52,domain:34,addresses:34,characters:27,retrieved:27,internet:17,message:15,validation:12} |
| topKeywords | [{keyword:email,count:94,percentage:14},{keyword:address,count:61,percentage:9.1},{keyword:mail,count:52,percentage:7.7},{keyword:domain,count:34,percentage:5.1},{keyword:addresses,count:34,percentage:5.1}] |
Response 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 | {...} |
Learn more about response formats →
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value | Description |
|---|---|---|---|
url | string | - | |
keywordCount | number | - | |
topKeyword | string | The most frequently occurring keyword | |
totalOccurrences | number | Total sum of all keyword frequencies | |
keywords | object | - | |
â”” email | number | - | |
â”” address | number | - | |
â”” mail | number | - | |
â”” domain | number | - | |
â”” addresses | number | - | |
â”” characters | number | - | |
â”” retrieved | number | - | |
â”” internet | number | - | |
â”” message | number | - | |
â”” validation | number | - | |
| [ ] Array items: | array[5] | Top 5 keywords with counts and percentages | |
â”” keyword | string | - | |
â”” count | number | - | |
â”” percentage | number | - |
Headers
Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →
GraphQL AccessALPHA
Access Keyword Extractor through GraphQL to combine it with other API calls in a single request. Query only the keyword extractor data you need with precise field selection, and orchestrate complex data fetching workflows.
Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.
POST https://api.apiverve.com/v1/graphqlquery {
keywordextractor(
input: {
url: "https://en.wikipedia.org/wiki/Email_address"
}
) {
url
keywordCount
topKeyword
totalOccurrences
keywords {
email
address
mail
domain
addresses
characters
retrieved
internet
message
validation
}
topKeywords
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The Keyword Extractor API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →
Rate Limiting
Keyword Extractor requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →
Error Codes
The Keyword Extractor API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →
SDKs for Keyword Extractor
Official Keyword Extractor packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
Keyword Extractor works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →
Frequently Asked Questions
How do I get an API key for Keyword Extractor?
How many credits does Keyword Extractor cost?
Each successful Keyword Extractor API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful keyword extractor lookups.
Can I use Keyword Extractor in production?
The free plan is for testing and development only. For production use of Keyword Extractor, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.
Can I use Keyword Extractor from a browser?
What happens if I exceed my Keyword Extractor credit limit?
When you reach your monthly credit limit, Keyword Extractor API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.








