DocsIntegrationsPlaygroundPricing
Get API Key
SUPACRAWL
Ctrl K
StatusSupportDashboard
DocumentationIntegrationsAPI Reference
SUPACRAWL
Getting Started

Authentication

SupaCrawlX uses API keys to authenticate every request. Send your key in the x-api-key header — any request that arrives without a valid key is rejected with a 401.

Authenticating requests

from supacrawlx import Client
client = Client("sk_live_your_api_key_here")

Getting your API key

1

Create a free account — 100 credits/month included

2

Open the Dashboard → API Keys page

3

Click Create New Key and give it a name

4

Copy the key immediately — it is only shown once

Security note

Treat your key like a password. Keep it server-side — never ship it in browser code, mobile apps, or public repositories — load it from an environment variable, and rotate it from the dashboard the moment you suspect it has leaked.

Error responses

401UNAUTHORIZEDMissing or invalid API key
403PLAN_REQUIREDFeature not available on your current plan
402INSUFFICIENT_CREDITSNot enough credits remaining