DataForSEO Keywords Data API

Provenance

This is an experimental project to test how OpenCode, plugged into frontier LLMs (OpenAI GPT-5.2), can help generate high-fidelity agent skill files for API integrations.

When to Apply

• "get search volume", "keyword research", "keyword metrics"
• "CPC", "competition", "ad traffic", "paid search planning"
• "Google Trends", "seasonality", "rising queries"
• "clickstream", "market sizing", "global search volume"

Integration Contract (Language-Agnostic)

See references/REFERENCE.md for the shared DataForSEO integration contract (auth, status handling, task lifecycle, sandbox, and .ai responses).

Group Notes

• Many keyword endpoints support both Live and Task-based flows; task-based is often used for bulk/scheduled jobs.

Steps

1. Identify the exact endpoint(s) in the official docs for this use case.
2. Choose execution mode:
   • Live (single request) for interactive queries
   • Task-based (post + poll/webhook) for scheduled or high-volume jobs
3. Build the HTTP request:
   • Base URL: https://api.dataforseo.com/
   • Auth: HTTP Basic (Authorization: Basic base64(login:password)) from https://docs.dataforseo.com/v3/auth/
   • JSON body exactly as specified in the endpoint docs
4. Execute and validate the response:
   • Check top-level status_code and each tasks[] item status
   • Treat any status_code != 20000 as a failure; surface status_message
5. For task-based endpoints:
   • Store tasks[].id
   • Poll tasks_ready then fetch results with task_get (or use postback_url/pingback_url if supported)
6. Return results:
   • Provide a normalized summary for the user
   • Include the raw response payload for debugging

Inputs Checklist

• Credentials: DataForSEO API login + password (HTTP Basic Auth)
• Target: keyword(s) / domain(s) / URL(s) / query string (depends on endpoint)
• Targeting (if applicable): location + language, device, depth/limit
• Time window (if applicable): date range, trend period, historical flags
• Output preference: regular vs advanced vs html (if the endpoint supports it)

Example (cURL)

curl -u "${DATAFORSEO_LOGIN}:${DATAFORSEO_PASSWORD}"   -H "Content-Type: application/json"   -X POST "https://api.dataforseo.com/v3/<group>/<path>/live"   -d '[
    {
      "<param>": "<value>"
    }
  ]'

Notes:

• Replace <group>/<path> with the exact endpoint path from the official docs.
• For task-based flows, use the corresponding task_post, tasks_ready, and task_get endpoints.

Docs Map (Official)

• Overview: https://docs.dataforseo.com/v3/keywords_data/overview/

Representative endpoints:

• Google Ads Search Volume (Live): https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/live/
• Google Ads Search Volume (Task POST): https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/task_post/
• Google Trends Explore (Live): https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/live/
• Clickstream Data Overview: https://docs.dataforseo.com/v3/keywords_data/clickstream_data/overview/

Business & Product Use Cases

• Power a keyword research product (seed -> expand -> prioritize -> export).
• Support paid search planning (market size, seasonality, geo targeting).
• Build topic clustering for content strategy (group by demand and intent).
• Forecast traffic potential for new pages/features (SEO business cases).
• Identify new markets by comparing geo/language demand patterns.
• Provide client-facing keyword reports for agencies and consultants.

Examples (User Prompts)

• "If you don't have the skill installed, install dataforseo-keywords-data-api and then continue."
• "Install the Keywords Data skill and get search volume for this list of keywords in Canada (EN)."
• "Generate keyword ideas from this seed topic and cluster them with a priority score."
• "Show seasonality for 'tax filing software' and recommend publishing months."
• "Use clickstream data to estimate market size for these topics globally vs the US."
• "Build a simple keyword research workflow: seed -> expand -> filter -> export."