Keyword Research

Usage

const res = await fetch('https://api.yepapi.com/v1/seo/keywords', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ keywords: ['nextjs seo', 'vibe coding'], location_code: 2840 }),
});
const { data } = await res.json();
console.log(data);

curl -X POST https://api.yepapi.com/v1/seo/keywords \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"keywords": ["nextjs seo", "vibe coding"], "location_code": 2840}'

Request Body

Keyword Validity

Each keyword must be non-empty, at most 80 characters and 10 words, and contain only letters, numbers, spaces, hyphens (-) and apostrophes ('). Keywords with other symbols (?, ,, (, ), @, etc.) are not accepted by the search-volume data source.

Rather than failing the whole request when one keyword is invalid, we drop the invalid keywords, return metrics for the valid ones, and list what was skipped (and why) in the skipped array of the response. Reasons are empty, too_long, too_many_words, and invalid_characters. If every keyword is invalid, keywords comes back empty with all entries in skipped. Duplicate keywords (case-insensitive) are collapsed.

Filtering & Sorting

Narrow and order results with filters, match, and sort. Filter on the same friendly field names returned in the response — volume, cpc, difficulty, competition, competitionLevel, intent, keyword, plus words and length (keyword length).

{
  "keywords": ["running shoes", "trail running shoes", "best running shoes"],
  "filters": [
    { "field": "volume", "op": ">=", "value": 500 },
    { "field": "competitionLevel", "op": "=", "value": "LOW" }
  ],
  "match": "all",
  "sort": ["volume:desc"]
}

For this endpoint, filters and sorting are applied to the returned list (exact search-volume lookups can't be filtered upstream), but the format and behavior are identical to the other keyword endpoints. See Keyword Filters for the full list of fields, operators (>, >=, <, <=, =, !=, in, nin, like, not_like), and limits (max 8 filters, 3 sort rules).

Response

{
  "ok": true,
  "data": {
    "keywords": [
      {
        "keyword": "nextjs seo",
        "volume": 390,
        "cpc": 0.0,
        "difficulty": 0,
        "competition": 0.01,
        "competitionLevel": "LOW",
        "intent": "unknown",
        "avgBacklinks": 0.0,
        "avgReferringDomains": 0.0,
        "serpFeatures": [],
        "totalResults": 0,
        "trend": [
          { "month": "2026-03", "volume": 390 },
          { "month": "2026-02", "volume": 140 },
          { "month": "2026-01", "volume": 170 }
        ]
      },
      {
        "keyword": "vibe coding",
        "volume": 0,
        "cpc": 0.0,
        "difficulty": 0,
        "competition": 0.0,
        "competitionLevel": "unknown",
        "intent": "unknown",
        "avgBacklinks": 0.0,
        "avgReferringDomains": 0.0,
        "serpFeatures": [],
        "totalResults": 0,
        "trend": []
      }
    ],
    "skipped": [
      { "keyword": "what is an api?", "reason": "invalid_characters" }
    ]
  }
}

Response Fields