Keyword ExtractorKeyword Extractor API

OnlineCredit Usage:5 per callRefreshed 1 month ago
avg: 2144ms|p50: 1887ms|p75: 2316ms|p90: 2830ms|p99: 3859ms

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

URL
https://api.apiverve.com/v1/keywordextractor

Example

How to call the Keyword Extractor API in different programming languages.

cURL Request
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"
}'
JavaScript (Fetch API)
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);
Python (Requests)
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)
Go (net/http)
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))
}
Example 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
      }
    ]
  }
}

Authentication

The Keyword Extractor API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive 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

ParameterTypeRequiredDescriptionDefaultExample
textstringrequired
The text to extract keywords from
-Machine learning is a subset of artificial intelligence that enables systems to learn from data. Deep learning uses neural networks to process complex patterns in data.

Option 2: Extract Keywords from URL

ParameterTypeRequiredDescriptionDefaultExample
urlstringrequired
URL of a web page to extract keywords from
-https://en.wikipedia.org/wiki/Artificial_intelligence

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 Response
200 OK
<?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>
YAML Response
200 OK
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
CSV Response
200 OK
keyvalue
urlhttps://en.wikipedia.org/wiki/Email_address
keywordCount50
topKeywordemail
totalOccurrences672
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:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains 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:

FieldTypeSample ValueDescription
urlstring"https://en.wikipedia.org/wiki/Email_address"
-
keywordCountnumber50
-
topKeywordstring"email"
The most frequently occurring keyword
totalOccurrencesnumber672
Total sum of all keyword frequencies
keywordsobject{...}
-
â”” emailnumber94
-
â”” addressnumber61
-
â”” mailnumber52
-
â”” domainnumber34
-
â”” addressesnumber34
-
â”” charactersnumber27
-
â”” retrievednumber27
-
â”” internetnumber17
-
â”” messagenumber15
-
â”” validationnumber12
-
[ ] Array items:array[5]Array of objects
Top 5 keywords with counts and percentages
â”” keywordstring"email"
-
â”” countnumber94
-
â”” percentagenumber14
-

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.

Test Keyword Extractor in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  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?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for Keyword Extractor and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
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?
Yes! The Keyword Extractor API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
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.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?