@orsf/sdk
v0.1.1
Published
Official TypeScript SDK for ORSF — Slovak company data API (1.25M+ companies, IČO autofill, search, connection graphs).
Maintainers
Readme
@orsf/sdk
Official TypeScript SDK for ORSF — Open Register of Slovak Companies. 1.25M+ Slovak companies + sole traders, aggregated from 14 state registers (RPO, ORSR, RÚZ, FS DPH and more).
Types are generated directly from the live OpenAPI spec (https://api.orsf.sk/v1/openapi.json) — always in sync with the API, no hand-maintained type definitions.
Install
npm install @orsf/sdkUsage
import { createOrsfClient } from '@orsf/sdk';
const orsf = createOrsfClient({ token: process.env.ORSF_API_TOKEN });
// IČO autofill — minimal payload, built for forms/invoices/KYC
const company = await orsf.lookup('55609830');
console.log(company.name, company.address, company.icDph);
// Batch lookup — up to 100 IČOs per request
const { results } = await orsf.lookupBatch(['55609830', '31333532']);
// Full company record (identity, address, financials, activities)
const detail = await orsf.company('55609830');
// Fulltext search
const { results: hits } = await orsf.search('poistovna', { limit: 10 });
// Pricing/quota table
const { tiers } = await orsf.tiers();No token = anonymous access (public endpoints, rate-limited). Pass a Bearer token from your ORSF profile for higher quotas and to unlock full addresses for sole traders.
Regenerating types
npm run generate # pulls fresh types from https://api.orsf.sk/v1/openapi.json
npm run buildLinks
- API docs: https://orsf.sk/api
- Pricing: https://orsf.sk/pricing
- License: CC-BY 4.0 (data), MIT (this SDK)
