Getting Started with the Jumpple Crawler REST API

What can the REST API do?

The REST API exposes the same crawl engine as the dashboard. You can start a crawl, poll its status, read results from the report types, retrieve the SEO Master audit and download a PDF report. API access is available once a paid subscription is active.

The main endpoints

These are the endpoints you will use most.

• POST /api/crawls/start starts a crawl for a URL, with optional depth, JavaScript rendering and include or exclude rules.
• GET /api/crawls/{id}/status returns progress, the number of URLs crawled and credits used.
• GET /api/crawls/{id}/results returns paginated rows for a report type.
• GET /api/crawls/{id}/seo-master returns the 115-point audit with an overall score and category breakdowns.
• GET /api/crawls/{id}/report/pdf generates a PDF report.
• GET /api/projects lists the projects in your account.

A typical flow

Send a start request and keep the crawl ID from the response. Poll the status endpoint every few seconds until the status is complete, then request results or the SEO Master audit using the same ID. Poll with a sensible delay, because a large crawl takes minutes and each poll costs a request.

Authentication and limits

Requests are authenticated with an API key that you create in your account. Keep it on the server side, never in browser code or a public repository, and rotate it if it is exposed. The API documentation page lists each endpoint with an example response.

Use the audit in your own tools

Because the audit returns a score and a status per check, you can feed it into a dashboard, open a ticket when a check fails after a release or keep a history of scores for each client site.

Related articles

• Inside the SEO Master 115-Point Audit: What We Check and Why

  A breakdown of every category in our SEO Master audit - from technical SEO and structured data to AI search readiness and E-E-A-T signals.

• JavaScript Rendering: How Jumpple Crawler Sees Your SPA

  How our cloud crawler renders client-side frameworks like React, Vue and Next.js before extracting SEO data - and how to debug rendering issues.

• Save, Open & Compare Crawls to Catch SEO Regressions Early

  Set up recurring crawls and use crawl comparison to spot new 404s, removed canonicals and content drops before they hurt rankings.