Olostep NodeJS SDK - Olostep Docs

NPM Package: olostep

Aan de slag

npm install olostep

import Olostep from 'olostep';

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

// Minimal scrape voorbeeld
const result = await client.scrapes.create('https://example.com');
console.log(result.id, result.html_content);

import Olostep from 'olostep';

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

// Minimal scrape voorbeeld
const result = await client.scrapes.create('https://example.com');
console.log(result.id, result.html_content);

De NodeJS SDK accepteert zowel camelCase als snake_case voor alle parameters. Gebruik snake_case als je bouwt voor AI-agenten, het komt overeen met de native veldnamen van de API.

Gebruik

Scraping

Scrape een enkele URL met verschillende opties:

import Olostep, {Format} from 'olostep';

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

// Eenvoudige scrape
const scrape = await client.scrapes.create('https://example.com');

// Met meerdere formaten
const scrape = await client.scrapes.create({
  url: 'https://example.com',
  formats: [Format.HTML, Format.MARKDOWN, Format.TEXT],
  waitBeforeScraping: 1000,
  removeImages: true
});

// Toegang tot de inhoud
console.log(scrape.html_content);
console.log(scrape.markdown_content);

// Scrape ophalen via ID
const fetched = await client.scrapes.get(scrape.id);

import Olostep, {Format} from 'olostep';

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

// Eenvoudige scrape
const scrape = await client.scrapes.create('https://example.com');

// Met meerdere formaten
const scrape = await client.scrapes.create({
  url: 'https://example.com',
  formats: [Format.HTML, Format.MARKDOWN, Format.TEXT],
  wait_before_scraping: 1000,
  remove_images: true
});

// Toegang tot de inhoud
console.log(scrape.html_content);
console.log(scrape.markdown_content);

// Scrape ophalen via ID
const fetched = await client.scrapes.get(scrape.id);

Batchverwerking

Verwerk meerdere URL’s in één batch:

// Gebruik van URL-strings (aangepaste ID's automatisch gegenereerd)
const batch = await client.batches.create([
  'https://example.com',
  'https://example.org',
  'https://example.net'
]);

// Of met expliciete aangepaste ID's
const batch = await client.batches.create([
  {url: 'https://example.com', customId: 'site-1'},
  {url: 'https://example.org', customId: 'site-2'}
]);

console.log(`Batch ${batch.id} gemaakt met ${batch.total_urls} URL's`);

// Wacht op voltooiing
await batch.waitTillDone({
  checkEveryNSecs: 5,
  timeoutSeconds: 120
});

// Batchinformatie ophalen
const info = await batch.info();
console.log(info);

// Individuele resultaten streamen
for await (const item of batch.items()) {
  console.log(item.custom_id);
}

// Gebruik van URL-strings (aangepaste ID's automatisch gegenereerd)
const batch = await client.batches.create([
  'https://example.com',
  'https://example.org',
  'https://example.net'
]);

// Of met expliciete aangepaste ID's
const batch = await client.batches.create([
  {url: 'https://example.com', custom_id: 'site-1'},
  {url: 'https://example.org', custom_id: 'site-2'}
]);

console.log(`Batch ${batch.id} gemaakt met ${batch.total_urls} URL's`);

// Wacht op voltooiing
await batch.waitTillDone({
  check_every_n_secs: 5,
  timeout_seconds: 120
});

// Batchinformatie ophalen
const info = await batch.info();
console.log(info);

// Individuele resultaten streamen
for await (const item of batch.items()) {
  console.log(item.custom_id);
}

Crawlen

Crawl een hele website:

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

console.log(`Crawl ${crawl.id} gestart`);

// Wacht op voltooiing
await crawl.waitTillDone({
  checkEveryNSecs: 10,
  timeoutSeconds: 300
});

// Crawl-informatie ophalen
const info = await crawl.info();
console.log(`Gecrawld ${info.pages_crawled} pagina's`);

// Gecrawlde pagina's streamen
for await (const page of crawl.pages()) {
  console.log(page.url, page.status_code);
}

const crawl = await client.crawls.create({
  url: 'https://example.com',
  max_pages: 100,
  max_depth: 3,
  include_urls: ['*/blog/*'],
  exclude_urls: ['*/admin/*']
});

console.log(`Crawl ${crawl.id} gestart`);

// Wacht op voltooiing
await crawl.waitTillDone({
  check_every_n_secs: 10,
  timeout_seconds: 300
});

// Crawl-informatie ophalen
const info = await crawl.info();
console.log(`Gecrawld ${info.pages_crawled} pagina's`);

// Gecrawlde pagina's streamen
for await (const page of crawl.pages()) {
  console.log(page.url, page.status_code);
}

Site Mapping

Genereer een sitemap van URL’s van een website:

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

console.log(`Map ${map.id} gemaakt`);

// URL's streamen
for await (const url of map.urls()) {
  console.log(url);
}

// Mapinformatie ophalen
const info = await map.info();

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

console.log(`Map ${map.id} gemaakt`);

// URL's streamen
for await (const url of map.urls()) {
  console.log(url);
}

// Mapinformatie ophalen
const info = await map.info();

AI-gestuurde Antwoorden

Krijg antwoorden van webpagina’s met behulp van AI:

import Olostep from 'olostep';

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

// Eenvoudige taak: geef een string direct door
const answer = await client.answers.create(
  'Wat is het hoofdonderwerp van https://example.com?'
);
console.log(answer.answer);
console.log(answer.sources);

// Met gestructureerde JSON-uitvoer
const structured = await client.answers.create({
  task: 'Haal alle productnamen en prijzen van https://example.com',
  jsonFormat: {
    products: [{name: '', price: ''}]
  }
});
console.log(structured.json_content);

// Eerder gemaakt antwoord ophalen via ID
const fetched = await client.answers.get(answer.id);
console.log(fetched.answer);

import Olostep from 'olostep';

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

// Eenvoudige taak: geef een string direct door
const answer = await client.answers.create(
  'Wat is het hoofdonderwerp van https://example.com?'
);
console.log(answer.answer);
console.log(answer.sources);

// Met gestructureerde JSON-uitvoer
const structured = await client.answers.create({
  task: 'Haal alle productnamen en prijzen van https://example.com',
  json_format: {
    products: [{name: '', price: ''}]
  }
});
console.log(structured.json_content);

// Eerder gemaakt antwoord ophalen via ID
const fetched = await client.answers.get(answer.id);
console.log(fetched.answer);

Inhoud Terughalen

Haal eerder gescrapete inhoud op:

// Inhoud ophalen in specifiek(e) formaat(en)
const content = await client.retrieve(retrieveId, Format.MARKDOWN);
console.log(content.markdown_content);

// Meerdere formaten
const content = await client.retrieve(retrieveId, [
  Format.HTML,
  Format.MARKDOWN
]);

Geavanceerde Opties

Aangepaste Acties

Voer browseracties uit voordat je gaat scrapen:

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'}
  ]
});

Geografische Locatie

Scrape vanuit verschillende landen met behulp van vooraf gedefinieerde landcodes of een geldige landcode als string:

import Olostep, {Country} from 'olostep';

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

// Gebruik van vooraf gedefinieerde enumwaarden (US, DE, FR, GB, SG)
const scrape = await client.scrapes.create({
  url: 'https://example.com',
  country: Country.DE  // Duitsland
});

// Of gebruik een geldige landcode als string
const scrape2 = await client.scrapes.create({
  url: 'https://example.com',
  country: 'jp'  // Japan
});

import Olostep, {Country} from 'olostep';

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

// Gebruik van vooraf gedefinieerde enumwaarden (US, DE, FR, GB, SG)
const scrape = await client.scrapes.create({
  url: 'https://example.com',
  country: Country.DE  // Duitsland
});

// Of gebruik een geldige landcode als string
const scrape2 = await client.scrapes.create({
  url: 'https://example.com',
  country: 'jp'  // Japan
});

Caching

Standaard haalt elke scrape-aanvraag de pagina vers op (max_age: 0). Geef maxAge door om een recent resultaat met dezelfde parameters te hergebruiken en de responstijd te verbeteren. De waarde is in seconden; het maximum is 7 dagen (604800). Zie Caching voor details.

const scrape = await client.scrapes.create({
  url: 'https://example.com',
  formats: ['markdown'],
  maxAge: 86400 // Accepteer resultaten tot 1 dag oud
});

const scrape = await client.scrapes.create({
  url: 'https://example.com',
  formats: ['markdown'],
  max_age: 86400 // Accepteer resultaten tot 1 dag oud
});

Opslag

Standaard wordt een scrape-resultaat ongeveer 7 dagen bewaard. Geef storage.expires_in door als 10d, 30d, 60d, 90d, 180d, 365d, of never om het langer te bewaren. Zie Opslag voor details.

const scrape = await client.scrapes.create({
  url: 'https://example.com',
  formats: ['markdown'],
  storage: { expires_in: '90d' }
});

const scrape = await client.scrapes.create({
  url: 'https://example.com',
  formats: ['markdown'],
  storage: { expires_in: '90d' }
});

LLM Extractie

Haal gestructureerde gegevens op met behulp van LLM’s:

const scrape = await client.scrapes.create({
  url: 'https://example.com',
  llmExtract: {
    schema: {
      title: 'string',
      price: 'number',
      description: 'string'
    },
    prompt: 'Haal productinformatie van deze pagina'
  }
});

const scrape = await client.scrapes.create({
  url: 'https://example.com',
  llm_extract: {
    schema: {
      title: 'string',
      price: 'number',
      description: 'string'
    },
    prompt: 'Haal productinformatie van deze pagina'
  }
});

Clientconfiguratie

import Olostep from 'olostep';

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

import Olostep from 'olostep';

const client = new Olostep({
  api_key: 'your_api_key',
  api_base_url: 'https://api.olostep.com/v1',  // optioneel
  timeout_ms: 150000,  // 150 seconden (optioneel)
  retry: {
    max_retries: 3,
    initial_delay_ms: 1000
  },
  user_agent: 'MyApp/1.0'  // optioneel
});

Kenmerken

Async-first client met volledige TypeScript-ondersteuning.
Type-veilige invoer met behulp van TypeScript-enums en -interfaces (Formats, Countries, Actions, etc.).
Rijke resource-namespaces met zowel verkorte aanroepen (client.scrapes.create()) als expliciete methoden (client.scrapes.get()).
Gedeelde transportlaag met retries, time-outs en JSON-decodering.
Uitgebreide foutenhiërarchie

​Aan de slag

​Gebruik

​Scraping

​Batchverwerking

​Crawlen

​Site Mapping

​AI-gestuurde Antwoorden

​Inhoud Terughalen

​Geavanceerde Opties

​Aangepaste Acties

​Geografische Locatie

​Caching

​Opslag

​LLM Extractie

​Clientconfiguratie

​Kenmerken

Aan de slag

Gebruik

Scraping

Batchverwerking

Crawlen

Site Mapping

AI-gestuurde Antwoorden

Inhoud Terughalen

Geavanceerde Opties

Aangepaste Acties

Geografische Locatie

Caching

Opslag

LLM Extractie

Clientconfiguratie

Kenmerken