Skip to content

quickstart.md

Latest commit

 

History

History
168 lines (124 loc) · 3.48 KB

quickstart.md

File metadata and controls

168 lines (124 loc) · 3.48 KB
Raw

Quickstart

This quickstart shows the fastest path to authenticate, render a page, and capture a screenshot with the AnyCrawler public API.

The code examples assume you vendor the single-file SDK into your project and keep the default filename.

Base URL

Use https://api.anycrawler.com in production.

Step 1: Get an API Key

Create or copy an API key from the AnyCrawler console:

  • Register or sign in: https://app.anycrawler.com/login
  • Create or copy API keys: https://app.anycrawler.com/api-keys

All public endpoints accept:

  • Authorization: Bearer <apiKey>
  • x-api-key: <apiKey>

The shared SDKs use the Bearer form by default.

Step 2: Render a Page with /v1/crawl/page

TypeScript

import { AnyCrawlerClient } from "./shared/sdks/typescript/anycrawler";

const client = new AnyCrawlerClient({
  apiKey: process.env.ANYCRAWLER_API_KEY!,
});

const { data, meta } = await client.crawlPage({
  url: "https://example.com",
  method: "render",
  include_metadata: true,
});

console.log(data.results?.markdown);
console.log(meta.requestId);

JavaScript

const { AnyCrawlerClient } = require("./shared/sdks/javascript/anycrawler.js");

const client = new AnyCrawlerClient({
  apiKey: process.env.ANYCRAWLER_API_KEY,
});

client
  .crawlPage({
    url: "https://example.com",
    method: "render",
    include_metadata: true,
  })
  .then(({ data, meta }) => {
    console.log(data.results?.markdown);
    console.log(meta.requestId);
  });

Python

from anycrawler import AnyCrawlerClient
import os

client = AnyCrawlerClient(api_key=os.environ["ANYCRAWLER_API_KEY"])
response = client.crawl_page(
    {
        "url": "https://example.com",
        "method": "render",
        "include_metadata": True,
    }
)

print(response["data"]["results"]["markdown"])
print(response["meta"]["requestId"])

curl

ANYCRAWLER_API_KEY="sk-your-key" \
TARGET_URL="https://example.com" \
CRAWL_METHOD="render" \
INCLUDE_METADATA="true" \
./shared/sdks/curl/crawl-page.sh

Step 3: Capture a Screenshot with /v1/crawl/screenshot

TypeScript

import { AnyCrawlerClient } from "./shared/sdks/typescript/anycrawler";

const client = new AnyCrawlerClient({
  apiKey: process.env.ANYCRAWLER_API_KEY!,
});

const { data, meta } = await client.crawlScreenshot({
  url: "https://example.com",
  full_page: false,
});

console.log(data.results?.snapshot_url);
console.log(meta.creditsReserved);

JavaScript

const { AnyCrawlerClient } = require("./shared/sdks/javascript/anycrawler.js");

const client = new AnyCrawlerClient({
  apiKey: process.env.ANYCRAWLER_API_KEY,
});

client
  .crawlScreenshot({
    url: "https://example.com",
    full_page: false,
  })
  .then(({ data, meta }) => {
    console.log(data.results?.snapshot_url);
    console.log(meta.creditsReserved);
  });

Python

from anycrawler import AnyCrawlerClient
import os

client = AnyCrawlerClient(api_key=os.environ["ANYCRAWLER_API_KEY"])
response = client.crawl_screenshot(
    {
        "url": "https://example.com",
        "full_page": False,
    }
)

print(response["data"]["results"]["snapshot_url"])
print(response["meta"]["creditsReserved"])

curl

ANYCRAWLER_API_KEY="sk-your-key" \
TARGET_URL="https://example.com" \
FULL_PAGE="false" \
./shared/sdks/curl/crawl-screenshot.sh

Next Reading