Skip to main content

​
Prerequisites

Don’t have an API key yet? After signing up, go to Settings > General and click Generate API Key. Your key starts with tk-.

​
Choose Your Approach

SDK

TypeScript/Node.js and Python SDKs for type-safe development

REST API

Language-agnostic HTTP API for any platform

​
Installation

  • npm
  • yarn
  • pnpm
  • bun
  • pip
npm install @kadoa/node-sdk
You can view the Kadoa SDK source code on GitHub.

​
Quick Start

// 1. Initialize
import { KadoaClient } from '@kadoa/node-sdk';

const client = new KadoaClient({
  apiKey: 'your-api-key'
});

// 2. Extract data
const result = await client.extraction.run({
  urls: ['https://sandbox.kadoa.com/ecommerce'],
  name: 'My First Extraction'
});

console.log(result.data);
// Output: Array of products with auto-detected fields
That’s it! With the SDK, data is automatically extracted. With the API, you define the schema and then retrieve your structured data.

​
Define What to Extract

For more control, specify exactly what fields you want: 
const workflow = await client
  .extract({
    urls: ['https://sandbox.kadoa.com/ecommerce'],
    name: 'Product Monitor',
    extraction: builder => builder
      .entity('Product')
      .field('name', 'Product name', 'STRING', { example: 'MacBook Pro' })
      .field('price', 'Price in USD', 'MONEY')
      .field('inStock', 'Is available', 'BOOLEAN')
  })
  .create();

const result = await workflow.run();
const response = await result.fetchData({});
console.log(response.data);
// Output: [{ name: "Laptop", price: "$999", inStock: true }, ...]

​
Next Steps