Cloud API Platform

The Jumpple desktop crawler engine, behind a clean REST API

Every crawl, SEO Master audit and report that runs in the Jumpple Crawler dashboard is also available over a documented REST API — start crawls, poll status, pull results and download branded PDF reports programmatically.

Start Free Crawl View Pricing

start-crawl.sh

curl -X POST https://api.jumpple.com/v1/crawls/start \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "prj_4471",
    "url": "https://example.com",
    "renderJavascript": true
  }'

Endpoints

A focused set of REST endpoints for crawls, projects and reports

All endpoints are authenticated with a bearer API key and return JSON. PDF generation returns a binary file stream.

POST/api/crawls/start

Start a crawl

Start a new crawl for a project URL with optional depth, JavaScript rendering and include/exclude rules.

Response

{
  "crawlId": "crwl_8f2a1c",
  "projectId": "prj_4471",
  "status": "queued",
  "url": "https://example.com",
  "createdAt": "2026-06-10T09:42:00Z"
}

GET/api/crawls/{id}/status

Get crawl status

Poll the status of a running or completed crawl, including progress and credits used.

Response

{
  "crawlId": "crwl_8f2a1c",
  "status": "running",
  "progress": 0.62,
  "urlsCrawled": 3104,
  "creditsUsed": 3104
}

GET/api/crawls/{id}/results

Get crawl results

Paginated results across all 35 report types — internal URLs, response codes, content, links and more.

Response

{
  "crawlId": "crwl_8f2a1c",
  "report": "internal-urls",
  "page": 1,
  "perPage": 100,
  "total": 3104,
  "data": [ { "url": "https://example.com/", "statusCode": 200 } ]
}

GET/api/crawls/{id}/seo-master

Get SEO Master audit

Retrieve the full 115-point SEO Master audit, overall score and category breakdowns for a crawl.

Response

{
  "crawlId": "crwl_8f2a1c",
  "overallScore": 82,
  "statusCounts": { "Pass": 71, "Needs Work": 28, "Missing": 11, "Critical": 5 },
  "checks": [ { "no": 1, "feature": "Title tag present", "status": "Pass", "score": 100 } ]
}

GET/api/crawls/{id}/report/pdf

Download PDF report

Generate and download a branded PDF report for a crawl or SEO Master audit.

Response

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="jumpple-seo-master-report.pdf"

<binary PDF stream>

GET/api/projects

List projects

List every project in your account, with domain, status and crawl credit usage.

Response

{
  "data": [
    { "projectId": "prj_4471", "domain": "example.com", "status": "active", "creditsUsed": 18450 }
  ]
}

GET/api/projects/{id}/history

Get project crawl history

Crawl history for a project — used to power saved/open crawls and comparison views.

Response

{
  "projectId": "prj_4471",
  "history": [
    { "crawlId": "crwl_8f2a1c", "startedAt": "2026-06-10T09:42:00Z", "overallScore": 82 },
    { "crawlId": "crwl_7d119b", "startedAt": "2026-06-03T09:40:00Z", "overallScore": 79 }
  ]
}

GET/api/users/{id}/credits

Get crawl credit balance

Check the remaining crawl credit balance and renewal date for the current billing cycle.

Response

{
  "userId": "usr_2291",
  "plan": "Starter",
  "creditsUsed": 18450,
  "creditsTotal": 50000,
  "renewsAt": "2026-07-01T00:00:00Z"
}

GET/api/reports/{id}/charts

Get report chart data

Chart-ready data for pie, donut, gauge, radial and bubble visualizations for a report.

Response

{
  "reportId": "rpt_19a3",
  "charts": {
    "issueSeverityDonut": [ { "name": "Errors", "value": 42 } ],
    "scoreGauge": { "score": 82 }
  }
}

GET/api/integrations/status

Get integration status

Connection status for Google Analytics, Search Console, PageSpeed Insights, backlink and AI integrations.

Response

{
  "integrations": [
    { "id": "ga4", "name": "Google Analytics 4", "connected": true },
    { "id": "gsc", "name": "Google Search Console", "connected": true },
    { "id": "ahrefs", "name": "Ahrefs", "connected": false }
  ]
}

Integrations

Connect the analytics, backlink and AI tools you already use

Integration status is available per-project from the dashboard and via the /api/integrations/status endpoint.

Analytics & Search

Connected

Google Analytics (Universal)

Merge legacy Universal Analytics sessions and conversions with crawl data for historical comparisons.

GA4

Connected

Google Analytics 4

Pull sessions, users, conversions and engagement metrics into the Analytics report for every URL.

GSC

Connected

Google Search Console

Map impressions, clicks, CTR and average position from Search Console to crawled URLs.

Performance

PSI

Connected

PageSpeed Insights

Pull Core Web Vitals and PageSpeed scores for mobile and desktop into the PageSpeed report.

Backlinks & Authority

Available

Majestic

Bring Trust Flow, Citation Flow and backlink counts into the Link Metrics report.

Available

Ahrefs

Merge Domain Rating, URL Rating and referring domains with your crawl data.

Available

Moz

Add Domain Authority and Page Authority scores to the Link Metrics report.

AI & Generative Search

Connected

OpenAI

Generate AI-suggested titles, meta descriptions and content fixes for the SEO Master audit.

Available

Google Gemini

Use Gemini models for AI-readiness scoring and generative-search content suggestions.

Available

Anthropic Claude

Use Claude models for AI-assisted audit summaries and fix suggestions.

Available

Ollama (Local Models)

Run AI-assisted audits against self-hosted open-source models for full data privacy.

API Access

API access is tied to your plan and billing status

The API uses the same crawl credits as your dashboard. Access by plan:

Free

No API access on the Free plan.

No Access

Starter

API access unlocks once your first paid subscription payment is processed.

After Payment

Custom

Full API access included from day one.

Included

Lifetime (LTD)

Not included by default — available as a separate add-on.

Add-on Only

Important: On the Starter plan, API access does not activate during the 14-day free trial. It becomes available as soon as your first subscription payment is processed.

Start crawling smarter — your first 300 credits are on us

No credit card required for the Free plan. Upgrade anytime to unlock saved crawls, PDF exports and the cloud API.

Start Free Crawl View Pricing