← Back to docsView Jobs →Manage Webhooks →
Quickstart
Get up and running with ScrapeKit in 5 minutes.
1
Create your account
Sign up for a free ScrapeKit account. No credit card required for the Starter plan (50 credits/month).
Create Account →2
Get your API key
After signing up, you'll receive an API key starting with sk_live_. Save it securely — you'll need it for all API requests. You can also find it in Dashboard → API Keys.
View API Keys →3
Make your first request
Use the API to scrape a real estate market. The response includes a job_id that you can use to check the status.
cURL
curl -X POST https://scrapekit.dev/api/v1/scrape/homes-search \
-H "X-API-Key: sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"location": "Phoenix, AZ"}'Python
import requests
response = requests.post(
"https://scrapekit.dev/api/v1/scrape/homes-search",
headers={"X-API-Key": "sk_live_your_key"},
json={"location": "Phoenix, AZ"},
)
print(response.json())
# {"job_id": "abc-123", "status": "queued", ...}4
View your results
Jobs typically complete in 3-30 seconds. Check the status by polling the jobs endpoint, or view results in the dashboard.
cURL
curl -H "X-API-Key: sk_live_your_key" \ https://scrapekit.dev/api/v1/scrape/status/abc-123
Python
import time
import requests
headers = {"X-API-Key": "sk_live_your_key"}
# Poll until complete
while True:
r = requests.get(
"https://scrapekit.dev/api/v1/scrape/status/abc-123",
headers=headers,
)
data = r.json()
if data["status"] in ("completed", "failed"):
print(data)
break
time.sleep(3)5
Set up webhooks (optional)
Instead of polling, configure a webhook to receive results automatically when jobs complete. Webhooks include HMAC signatures for verification.
cURL
curl -X POST https://scrapekit.dev/api/v1/webhooks \
-H "X-API-Key: sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{
"url": "https://your-app.com/webhook",
"events": ["job.completed", "job.failed"]
}'Python
import requests
response = requests.post(
"https://scrapekit.dev/api/v1/webhooks",
headers={"X-API-Key": "sk_live_your_key"},
json={
"url": "https://your-app.com/webhook",
"events": ["job.completed", "job.failed"],
},
)
print(response.json())Need more details?