REST API

Overview

Licensed workspaces can create API keys from Dashboard → Developers. Send:

```http

Authorization: Bearer YOUR_API_KEY

```

Default rate limit: 60 requests/minute per key. Read scope is included by default; enable write scope to start scans.

Base URL: your app origin (e.g. https://bunnyscan.com).

Endpoints

| Method | Path | Description |

| --- | --- | --- |

| GET | /api/v1/me | Organization, marketplace, key scopes |

| GET | /api/v1/storefront-scans?limit=25 | Recent storefront scans |

| GET | /api/v1/storefront-scans/:scanId | Scan detail with Rec/Tank/Overlap and seller strength |

| POST | /api/v1/storefront-scans | Start light scan (write scope) |

| GET | /api/v1/wholesale-scans?limit=25 | Recent wholesale file scans |

| GET | /api/v1/asin/:asin | Cached ASIN snapshot (extension read) |

| POST | /api/v1/asin/:asin/quick-check | Live profit + ungating check (write; one analysis) |

| POST | /api/v1/shortlist | Add ASIN to workspace shortlist (write) |

Chrome extension (Phase 2)

Install BunnyScan from the Chrome Web Store. In the dashboard, connect Amazon and Keepa in Settings, then click Connect extension — no API key to paste. Browse amazon.com/dp/… and the overlay calls the endpoints above.

Start a light scan

```bash

curl -sS -X POST "$BASE/api/v1/storefront-scans" \

-H "Authorization: Bearer $API_KEY" \

-H "Content-Type: application/json" \

-d '{"seller_id":"A1PA39Q5CORE5","marketplace_code":"US"}'

```

Poll GET /api/v1/storefront-scans/:scanId until status is completed. Sort rows by recommended score before deep analyzing in the UI.

Recipe: weekly seller list

1. Store seller IDs in a spreadsheet or Airtable.
2. Cron (GitHub Actions, cron-job.org, Make) calls POST /api/v1/storefront-scans for each seller.
3. When complete, fetch scan detail and push top Rec rows to Slack via webhook or Zapier.

Recipe: scan completed webhook

Configure Integrations → Webhooks for storefront.scan.completed. Your endpoint receives scan id and organization id — fetch detail via API and notify your team.

Recipe: automation tokens (read-only poll)

For Zapier/Make/n8n without full API keys, use Integrations → Automation tokens and POST /api/integrations/automation/events with types like latest_storefront_scans. See Dashboard → Docs → Automation for payload examples.

Ungate and team features

Ungate tracking and VA assignment are available in the dashboard. The REST API today focuses on scan read/write; use webhooks for scan completion automation.