All guides

Getting started

From a new account to your first request.

Verify your email, save your API key, and understand the response before connecting a larger workflow.

4 min read

1. Create and verify your account

Register with an email address you can access. Open the verification email and follow its one-time link within 15 minutes. If it expires, request a new link from the verification page. A new link replaces the previous one.

2. Save your API key securely

Open API Keys in your dashboard. Keep the key in your server environment as SCRAPLY_API_KEY. Send it in the X-API-Key header. Never put it in a public repository, a URL query string, or a browser bundle.

3. Start in the playground

Try https://example.com in the playground and inspect the output. The current MVP simulates external target access, so this validates your integration rather than live target availability.

  • Choose a simple public URL.
  • Start with a standard request before adding rendering or extraction.
  • Check the status, attempts, and credit usage in your dashboard logs.

4. Connect your application

Use the cURL, Python, JavaScript, or Go examples in the documentation. URL-encode the target and configure your own backend base URL. The local default is https://www.scraply.net. If you receive HTTP 202, poll the returned job ID through GET /v1/jobs/:id until the job finishes; do not submit the same scrape repeatedly.

KEEP BUILDING

Put it into practice.

Open the integration toolkit