Screpy REST API

Use Screpy data in your own products, workflows, and automations. The REST API gives paid member accounts access to projects, crawls, technical SEO findings, Core Web Vitals, uptime, and account usage.

What you can build

Project workflows

List, create, update, and manage the projects available to your account.

Crawl analysis

Read crawl status, summaries, pages, links, images, and on-page findings.

SEO opportunities

Use Quick Wins and comparisons to identify the next work worth doing.

Site health

Bring Core Web Vitals and uptime into your own reporting or automation.

Eligibility and access

The REST API is available to Screpy paid member accounts. Every request checks your current account eligibility, feature allowances, and access to the requested project.

Use only accessible projects

API keys can access projects you own and projects shared with your account. Start with GET /projects to discover the project UID you need for project-specific requests.

Basic usage

curl --request GET 'https://api.screpy.com/v1/projects' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Use the returned project UID with project-specific endpoints. A crawl UID is available from that project's crawl list.

API keys

Create a REST API key in Settings → Connected Apps. Send it as a bearer token with every request. MCP OAuth credentials do not authenticate this API. See Authentication for the full setup.

Usage and limits

Use account usage to inspect your current plan limits, usage, and feature allowances before building a workflow that starts crawls or processes large result sets.