# SuprKeywords API

> Explore SuprKeywords API documentation. Integrate advanced keyword research and SEO tools, automate workflows, boost visibility, and maximize results.

## Docs

- [API Keys](https://docs.suprkeywords.com/api-reference/api-keys.md): Create and manage API keys for programmatic access. Requires the Agency plan.
- [Get data provider index stats](https://docs.suprkeywords.com/api-reference/data-provider-stats/get-data-provider-index-stats.md): Returns cached data provider index statistics (e.g. Google SERPs, keywords, live pages, backlinks). Updated daily by cron; on cache miss or error returns static fallback values. No authentication required.
- [API Reference](https://docs.suprkeywords.com/api-reference/introduction.md): SuprKeywords REST API — base URL, authentication, and endpoint overview
- [Create a keyword research job](https://docs.suprkeywords.com/api-reference/jobs/create-a-keyword-research-job.md): Create a new keyword research job. Requires authentication. Debits one run (credit) upfront and enforces domain limit. Triggers the pipeline (personas → seed keywords → enrichment → expansion → clustering).
- [Delete a job and all related data](https://docs.suprkeywords.com/api-reference/jobs/delete-a-job-and-all-related-data.md): Permanently delete a job and cascade to personas, keywords, keyword_sources, clusters, and cluster_keywords. Requires authentication and ownership.
- [Export job keywords as CSV](https://docs.suprkeywords.com/api-reference/jobs/export-job-keywords-as-csv.md): Returns all keywords and cluster assignments for the job as a CSV file. Requires access to the job (owner or demo). Use session or API key (Bearer). Response is text/csv with Content-Disposition attachment.
- [Get clusters for a job](https://docs.suprkeywords.com/api-reference/jobs/get-clusters-for-a-job.md): Returns semantic clusters (pillar + supporting keywords) for a job with optional search, keyword count filters, sorting, and pagination. Requires access to the job (owner or demo). Use session or API key (Bearer).
- [Get job results summary](https://docs.suprkeywords.com/api-reference/jobs/get-job-results-summary.md): Returns aggregate stats for the job (personas, references, keywords, clusters, opportunity value, averages, intent counts). For the results Summary tab.
- [Get job status and metadata](https://docs.suprkeywords.com/api-reference/jobs/get-job-status-and-metadata.md): Get a single job by ID. Allowed for the demo user when unauthenticated; otherwise requires authentication and ownership (or demo access).
- [Get keywords for a job](https://docs.suprkeywords.com/api-reference/jobs/get-keywords-for-a-job.md): Returns keywords for a job with optional search, intent/volume/difficulty filters, sorting, and pagination. Requires access to the job (owner or demo). Use session or API key (Bearer).
- [Get keywords in a cluster](https://docs.suprkeywords.com/api-reference/jobs/get-keywords-in-a-cluster.md): Returns keywords belonging to a specific cluster. Allowed for demo user when unauthenticated; otherwise requires access to the job (session or API key).
- [Get personas for a job](https://docs.suprkeywords.com/api-reference/jobs/get-personas-for-a-job.md): Returns the LLM-generated personas for the job. Allowed for demo user when unauthenticated; otherwise requires access to the job (session or API key).
- [Get site references for a job](https://docs.suprkeywords.com/api-reference/jobs/get-site-references-for-a-job.md): Returns site previews for primary domain and competitor domains (order: primary first, then competitors). Used by the References tab. Items may be null if not yet scraped. Requires access to the job (owner or demo). Use session or API key (Bearer).
- [List current user's jobs](https://docs.suprkeywords.com/api-reference/jobs/list-current-users-jobs.md): List the authenticated user's jobs with optional pagination and status filter. Requires authentication. Returns 401 when not authenticated.
- [List available languages](https://docs.suprkeywords.com/api-reference/locale/list-available-languages.md): Returns available languages (language_code, language_name) for job creation. No authentication required.
- [List available locations](https://docs.suprkeywords.com/api-reference/locale/list-available-locations.md): Returns available locations (location_code, location_name, country_iso_code) for job creation. No authentication required.
- [Get current user profile and balances](https://docs.suprkeywords.com/api-reference/users/get-current-user-profile-and-balances.md): Returns the authenticated user's profile and balances (credits_balance = runs remaining, domains_balance = distinct primary domains allowed). Used for header display and gating the New Job flow. Requires authentication (session or API key).
- [Introduction](https://docs.suprkeywords.com/index.md): SuprKeywords API documentation — keyword research jobs, personas, clusters, and exports
- [Quickstart](https://docs.suprkeywords.com/quickstart.md): Create a keyword research job and fetch results using the SuprKeywords API

## OpenAPI Specs

- [openapi](https://docs.suprkeywords.com/openapi.json)