Olostep NodeJS SDK

npm install olostep

import Olostep from 'olostep';

const client = new Olostep({apiKey: process.env.OLOSTEP_API_KEY});

// 最小化抓取示例
const result = await client.scrapes.create('https://example.com');
console.log(result.id, result.html_content);

import Olostep, {Format} from 'olostep';

const client = new Olostep({apiKey: 'your_api_key'});

// 简单抓取
const scrape = await client.scrapes.create('https://example.com');

// 使用多种格式
const scrape = await client.scrapes.create({
  url: 'https://example.com',
  formats: [Format.HTML, Format.MARKDOWN, Format.TEXT],
  waitBeforeScraping: 1000,
  removeImages: true
});

// 访问内容
console.log(scrape.html_content);
console.log(scrape.markdown_content);

// 通过 ID 获取抓取内容
const fetched = await client.scrapes.get(scrape.id);

// 使用 URL 字符串（自动生成自定义 ID）
const batch = await client.batches.create([
  'https://example.com',
  'https://example.org',
  'https://example.net'
]);

// 或使用显式自定义 ID
const batch = await client.batches.create([
  {url: 'https://example.com', customId: 'site-1'},
  {url: 'https://example.org', customId: 'site-2'}
]);

console.log(`批次 ${batch.id} 已创建，包含 ${batch.total_urls} 个 URL`);

// 等待完成
await batch.waitTillDone({
  checkEveryNSecs: 5,
  timeoutSeconds: 120
});

// 获取批次信息
const info = await batch.info();
console.log(info);

// 流式处理单个结果
for await (const item of batch.items()) {
  console.log(item.customId);
}

const crawl = await client.crawls.create({
  url: 'https://example.com',
  maxPages: 100,
  maxDepth: 3,
  includeUrls: ['*/blog/*'],
  excludeUrls: ['*/admin/*']
});

console.log(`爬取 ${crawl.id} 已开始`);

// 等待完成
await crawl.waitTillDone({
  checkEveryNSecs: 10,
  timeoutSeconds: 300
});

// 获取爬取信息
const info = await crawl.info();
console.log(`已爬取 ${info.pages_crawled} 个页面`);

// 流式处理爬取的页面
for await (const page of crawl.pages()) {
  console.log(page.url, page.status_code);
}

const map = await client.maps.create({
  url: 'https://example.com',
  topN: 100,
  includeSubdomain: true,
  searchQuery: 'blog posts'
});

console.log(`地图 ${map.id} 已创建`);

// 流式处理 URL
for await (const url of map.urls()) {
  console.log(url);
}

// 获取地图信息
const info = await map.info();

// 获取特定格式的内容
const content = await client.retrieve(retrieveId, Format.MARKDOWN);
console.log(content.markdown_content);

// 多种格式
const content = await client.retrieve(retrieveId, [
  Format.HTML,
  Format.MARKDOWN
]);

const scrape = await client.scrapes.create({
  url: 'https://example.com',
  actions: [
    {type: 'wait', milliseconds: 2000},
    {type: 'click', selector: '#load-more'},
    {type: 'scroll', distance: 1000},
    {type: 'fill_input', selector: '#search', value: 'query'}
  ]
});

import Olostep, {Country} from 'olostep';

const client = new Olostep({apiKey: 'your_api_key'});

// 使用预定义的枚举值（US, DE, FR, GB, SG）
const scrape = await client.scrapes.create({
  url: 'https://example.com',
  country: Country.DE  // 德国
});

// 或使用任何有效的国家代码作为字符串
const scrape2 = await client.scrapes.create({
  url: 'https://example.com',
  country: 'jp'  // 日本
});

const scrape = await client.scrapes.create({
  url: 'https://example.com',
  llmExtract: {
    schema: {
      title: 'string',
      price: 'number',
      description: 'string'
    },
    // 可选地提供提示以指导提取
    prompt: '从此页面提取产品信息'
  }
});

import Olostep from 'olostep';

const client = new Olostep({
  apiKey: 'your_api_key',
  apiBaseUrl: 'https://api.olostep.com/v1',  // 可选
  timeoutMs: 150000,  // 150 秒（可选）
  retry: {
    maxRetries: 3,
    initialDelayMs: 1000
  },
  userAgent: 'MyApp/1.0'  // 可选
});