Dashboard

Quickstart

Get up and running with Scrayle in under 5 minutes. This guide covers API key setup, SDK installation, and your first scraping request.

1. Create an Account

Sign up at app.scrayle.com. You can use email/password or OAuth (Google, GitHub).

2. Get Your API Key

Navigate to the API Keys page in your dashboard. Click Create API Key, give it a name, and copy the key.

⚠️Keep your key safe

API keys grant full access to your account. Never commit them to version control or share them publicly.

3. Install the SDK

npm install @scrayle/sdk

Or with other package managers:

pnpm add @scrayle/sdk
yarn add @scrayle/sdk

4. Set Your API Key

Create a .env file in your project root:

SCRAYLE_API_KEY=your_api_key_here

The SDK automatically reads SCRAYLE_API_KEY from your environment.

5. Your First Scrape

Scrape a webpage and get it back as Markdown:

import { ScrayleClient } from '@scrayle/sdk';

const client = new ScrayleClient();

const result = await client.scrapingCrawl.scrapeUrl(
  'https://example.com',
  { formats: ['markdown'] }
);

console.log(result.data?.markdown);

6. Launch a Cloud Browser

Connect Playwright to a cloud browser with built-in stealth:

import { chromium } from 'playwright-core';
import { Playwright } from '@scrayle/sdk';

const { browserWSEndpoint } = await Playwright.connect({
  proxyCountry: 'US',
});

const browser = await chromium.connectOverCDP(browserWSEndpoint);
const page = await browser.newPage();
await page.goto('https://example.com');
console.log(await page.title());
await browser.close();

7. Solve a CAPTCHA

const solution = await client.captcha.captchaSolver({
  type: 'RecaptchaV2TaskProxyless',
  websiteURL: 'https://example.com',
  websiteKey: '6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-',
});

console.log(solution.solution?.gRecaptchaResponse);

Next Steps