Skip to content

REST API overview

Authenticate with an sf_live_ key and manage projects, search terms and runs over HTTPS.

The API is available on Scale plans and above. Create a key in Settings → API keys; the full key is shown once.

curl https://www.serpfull.com/api/v1/projects \
  -H "Authorization: Bearer sf_live_…"

Endpoints

  • GET /api/v1/projects
  • GET /api/v1/projects/{id}
  • GET|POST /api/v1/projects/{id}/terms
  • POST /api/v1/terms
  • GET|PATCH|DELETE /api/v1/terms/{id}
  • GET /api/v1/runs
  • GET /api/v1/projects/{id}/competitors
  • GET /api/v1/projects/{id}/competitors/rankings
  • GET /api/v1/projects/{id}/exchange
  • GET /api/v1/projects/{id}/exchange/partners
  • GET /api/v1/projects/{id}/seo
  • GET /api/v1/seo/pages/{id}
  • GET|POST /api/v1/seo/pages/{id}/audits
  • GET /api/v1/seo/audits/{id}

See API reference for fields and examples, and API errors and rate limits for status codes.

Updated