> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olostep.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Olostep NodeJS SDK

> Offizielles NodeJS SDK zum Suchen, Extrahieren und Strukturieren von Daten aus dem Web

**NPM-Paket**: [olostep](https://www.npmjs.com/package/olostep)

## Erste Schritte

```bash theme={null}
npm install olostep
```

<CodeGroup>
  ```ts camelCase theme={null}
  import Olostep from 'olostep';

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

  // Minimalbeispiel für Scraping
  const result = await client.scrapes.create('https://example.com');
  console.log(result.id, result.html_content);
  ```

  ```ts snake_case theme={null}
  import Olostep from 'olostep';

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

  // Minimalbeispiel für Scraping
  const result = await client.scrapes.create('https://example.com');
  console.log(result.id, result.html_content);
  ```
</CodeGroup>

<Note>
  Das NodeJS SDK akzeptiert sowohl **camelCase** als auch **snake\_case** für alle Parameter. Verwende **snake\_case**, wenn du für KI-Agenten entwickelst, da es den nativen Feldnamen der API entspricht.
</Note>

## Verwendung

### Scraping

Scrape eine einzelne URL mit verschiedenen Optionen:

<CodeGroup>
  ```ts camelCase theme={null}
  import Olostep, {Format} from 'olostep';

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

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

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

  // Zugriff auf den Inhalt
  console.log(scrape.html_content);
  console.log(scrape.markdown_content);

  // Scrape nach ID abrufen
  const fetched = await client.scrapes.get(scrape.id);
  ```

  ```ts snake_case theme={null}
  import Olostep, {Format} from 'olostep';

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

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

  // Mit mehreren 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
  });

  // Zugriff auf den Inhalt
  console.log(scrape.html_content);
  console.log(scrape.markdown_content);

  // Scrape nach ID abrufen
  const fetched = await client.scrapes.get(scrape.id);
  ```
</CodeGroup>

### Batch-Verarbeitung

Verarbeite mehrere URLs in einem einzigen Batch:

<CodeGroup>
  ```ts camelCase theme={null}
  // Verwenden von URL-Strings (benutzerdefinierte IDs werden automatisch generiert)
  const batch = await client.batches.create([
    'https://example.com',
    'https://example.org',
    'https://example.net'
  ]);

  // Oder mit expliziten benutzerdefinierten IDs
  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} erstellt mit ${batch.total_urls} URLs`);

  // Auf Abschluss warten
  await batch.waitTillDone({
    checkEveryNSecs: 5,
    timeoutSeconds: 120
  });

  // Batch-Info abrufen
  const info = await batch.info();
  console.log(info);

  // Einzelne Ergebnisse streamen
  for await (const item of batch.items()) {
    console.log(item.custom_id);
  }
  ```

  ```ts snake_case theme={null}
  // Verwenden von URL-Strings (benutzerdefinierte IDs werden automatisch generiert)
  const batch = await client.batches.create([
    'https://example.com',
    'https://example.org',
    'https://example.net'
  ]);

  // Oder mit expliziten benutzerdefinierten IDs
  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} erstellt mit ${batch.total_urls} URLs`);

  // Auf Abschluss warten
  await batch.waitTillDone({
    check_every_n_secs: 5,
    timeout_seconds: 120
  });

  // Batch-Info abrufen
  const info = await batch.info();
  console.log(info);

  // Einzelne Ergebnisse streamen
  for await (const item of batch.items()) {
    console.log(item.custom_id);
  }
  ```
</CodeGroup>

### Crawling

Durchsuche eine gesamte Website:

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

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

  // Auf Abschluss warten
  await crawl.waitTillDone({
    checkEveryNSecs: 10,
    timeoutSeconds: 300
  });

  // Crawl-Info abrufen
  const info = await crawl.info();
  console.log(`Durchsucht ${info.pages_crawled} Seiten`);

  // Durchsuchte Seiten streamen
  for await (const page of crawl.pages()) {
    console.log(page.url, page.status_code);
  }
  ```

  ```ts snake_case theme={null}
  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} gestartet`);

  // Auf Abschluss warten
  await crawl.waitTillDone({
    check_every_n_secs: 10,
    timeout_seconds: 300
  });

  // Crawl-Info abrufen
  const info = await crawl.info();
  console.log(`Durchsucht ${info.pages_crawled} Seiten`);

  // Durchsuchte Seiten streamen
  for await (const page of crawl.pages()) {
    console.log(page.url, page.status_code);
  }
  ```
</CodeGroup>

### Site Mapping

Erstelle eine Sitemap von URLs einer Website:

<CodeGroup>
  ```ts camelCase theme={null}
  const map = await client.maps.create({
    url: 'https://example.com',
    topN: 100,
    includeSubdomain: true,
    searchQuery: 'blog posts'
  });

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

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

  // Map-Info abrufen
  const info = await map.info();
  ```

  ```ts snake_case theme={null}
  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} erstellt`);

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

  // Map-Info abrufen
  const info = await map.info();
  ```
</CodeGroup>

### KI-gesteuerte Antworten

Erhalte Antworten von Webseiten mithilfe von KI:

<CodeGroup>
  ```ts camelCase theme={null}
  import Olostep from 'olostep';

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

  // Einfache Aufgabe: übergebe einen String direkt
  const answer = await client.answers.create(
    'What is the main topic of https://example.com?'
  );
  console.log(answer.answer);
  console.log(answer.sources);

  // Mit strukturiertem JSON-Ausgabe
  const structured = await client.answers.create({
    task: 'Extract all product names and prices from https://example.com',
    jsonFormat: {
      products: [{name: '', price: ''}]
    }
  });
  console.log(structured.json_content);

  // Eine zuvor erstellte Antwort nach ID abrufen
  const fetched = await client.answers.get(answer.id);
  console.log(fetched.answer);
  ```

  ```ts snake_case theme={null}
  import Olostep from 'olostep';

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

  // Einfache Aufgabe: übergebe einen String direkt
  const answer = await client.answers.create(
    'What is the main topic of https://example.com?'
  );
  console.log(answer.answer);
  console.log(answer.sources);

  // Mit strukturiertem JSON-Ausgabe
  const structured = await client.answers.create({
    task: 'Extract all product names and prices from https://example.com',
    json_format: {
      products: [{name: '', price: ''}]
    }
  });
  console.log(structured.json_content);

  // Eine zuvor erstellte Antwort nach ID abrufen
  const fetched = await client.answers.get(answer.id);
  console.log(fetched.answer);
  ```
</CodeGroup>

### Inhalt abrufen

Rufe zuvor gescrapten Inhalt ab:

```ts theme={null}
// Inhalt in spezifischem Format abrufen
const content = await client.retrieve(retrieveId, Format.MARKDOWN);
console.log(content.markdown_content);

// Mehrere Formate
const content = await client.retrieve(retrieveId, [
  Format.HTML,
  Format.MARKDOWN
]);
```

### Erweiterte Optionen

#### Benutzerdefinierte Aktionen

Führe Browseraktionen vor dem Scraping aus:

```ts theme={null}
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'}
  ]
});
```

#### Geografischer Standort

Scrape aus verschiedenen Ländern mit vordefinierten Ländercodes oder einem beliebigen gültigen Ländercode-String:

<CodeGroup>
  ```ts camelCase theme={null}
  import Olostep, {Country} from 'olostep';

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

  // Verwenden von vordefinierten Enum-Werten (US, DE, FR, GB, SG)
  const scrape = await client.scrapes.create({
    url: 'https://example.com',
    country: Country.DE  // Deutschland
  });

  // Oder verwende einen beliebigen gültigen Ländercode als String
  const scrape2 = await client.scrapes.create({
    url: 'https://example.com',
    country: 'jp'  // Japan
  });
  ```

  ```ts snake_case theme={null}
  import Olostep, {Country} from 'olostep';

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

  // Verwenden von vordefinierten Enum-Werten (US, DE, FR, GB, SG)
  const scrape = await client.scrapes.create({
    url: 'https://example.com',
    country: Country.DE  // Deutschland
  });

  // Oder verwende einen beliebigen gültigen Ländercode als String
  const scrape2 = await client.scrapes.create({
    url: 'https://example.com',
    country: 'jp'  // Japan
  });
  ```
</CodeGroup>

#### Caching

Standardmäßig holt jede Scrape-Anfrage die Seite frisch ab (`max_age: 0`). Übergebe `maxAge`, um ein kürzliches Ergebnis mit denselben Parametern wiederzuverwenden und die Antwortzeit zu verbessern. Der Wert ist in **Sekunden**; das Maximum beträgt 7 Tage (`604800`). Siehe [Caching](/features/scrapes#caching) für Details.

<CodeGroup>
  ```ts camelCase theme={null}
  const scrape = await client.scrapes.create({
    url: 'https://example.com',
    formats: ['markdown'],
    maxAge: 86400 // Akzeptiere Ergebnisse bis zu 1 Tag alt
  });
  ```

  ```ts snake_case theme={null}
  const scrape = await client.scrapes.create({
    url: 'https://example.com',
    formats: ['markdown'],
    max_age: 86400 // Akzeptiere Ergebnisse bis zu 1 Tag alt
  });
  ```
</CodeGroup>

#### LLM-Extraktion

Extrahiere strukturierte Daten mithilfe von LLMs:

<CodeGroup>
  ```ts camelCase theme={null}
  const scrape = await client.scrapes.create({
    url: 'https://example.com',
    llmExtract: {
      schema: {
        title: 'string',
        price: 'number',
        description: 'string'
      },
      prompt: 'Extract product information from this page'
    }
  });
  ```

  ```ts snake_case theme={null}
  const scrape = await client.scrapes.create({
    url: 'https://example.com',
    llm_extract: {
      schema: {
        title: 'string',
        price: 'number',
        description: 'string'
      },
      prompt: 'Extract product information from this page'
    }
  });
  ```
</CodeGroup>

### Client-Konfiguration

<CodeGroup>
  ```ts camelCase theme={null}
  import Olostep from 'olostep';

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

  ```ts snake_case theme={null}
  import Olostep from 'olostep';

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

### Funktionshighlights

* Asynchroner Client mit vollständiger TypeScript-Unterstützung.
* Typsichere Eingaben mit TypeScript-Enums und -Interfaces (Formate, Länder, Aktionen usw.).
* Umfangreiche Ressourcennamensräume mit sowohl Kurzaufrufen (`client.scrapes.create()`) als auch expliziten Methoden (`client.scrapes.get()`).
* Gemeinsame Transportschicht mit Wiederholungen, Zeitüberschreitungen und JSON-Decodierung.
* Umfassende Fehlerhierarchie