Quickstart Guide

const API_KEY = process.env.SERPWATCH_API_KEY || "your_api_key_here";
const BASE_URL = "https://engine.v2.serpwatch.io";

// Helper function for API calls
async function apiRequest(endpoint, options = {}) {
  const response = await fetch(`${BASE_URL}${endpoint}`, {
    ...options,
    headers: {
      "Authorization": `Bearer ${API_KEY}`,
      "Content-Type": "application/json",
      ...options.headers
    }
  });
  return response.json();
}

// Test authentication
const user = await apiRequest("/api/v1/users/me");
console.log(user);

// Create a SERP crawl task
const task = await apiRequest("/api/v2/serp/crawl", {
  method: "POST",
  body: JSON.stringify({
    keyword: "best project management software",
    depth: 10,
    device: "desktop",
    location_name: "United States",
    iso_code: "US",
    language_code: "en"
  })
});

const taskId = task.id;
console.log(`Task created: ${taskId}`);
console.log(`Status: ${task.status}`);

// Poll for results with async/await
const sleep = (ms) => new Promise(resolve => setTimeout(resolve, ms));

async function waitForResults(taskId, maxAttempts = 30) {
  for (let i = 0; i < maxAttempts; i++) {
    const result = await apiRequest(`/api/v2/serp/crawl/${taskId}`);

    if (result.status === "success") {
      console.log("Task completed!");
      const organic = (result.result?.left || []).filter(r => r.type === "organic");
      console.log(`Found ${organic.length} organic results`);
      return result;
    } else if (result.status === "error") {
      throw new Error(`Task failed: ${result.error_message}`);
    }

    console.log(`Status: ${result.status} - waiting...`);
    await sleep(2000);
  }
  throw new Error("Timeout waiting for results");
}

const results = await waitForResults(taskId);