@hydrafetch/node-sdk 0.4.0 → 0.6.0

package/README.md

@@ -25,7 +25,7 @@ const page = await hf.scrape('https://example.com/article');
 console.log(page.markdown);
 ```
 
-Create a key at [app.hydrafetch.com](https://app.hydrafetch.com). The constructor reads `HYDRAFETCH_API_KEY` when no key is passed.
+Copy your key from [app.hydrafetch.com](https://app.hydrafetch.com). The constructor reads `HYDRAFETCH_API_KEY` when no key is passed.
 
 ## Scraping
 
@@ -166,6 +166,31 @@ const { results } = await hf.search('post-quantum TLS adoption', {
 results.forEach((r) => console.log(r.title, r.url, r.data?.markdown));
 ```
 
+## Jobs
+
+Search open jobs collected from company career sites and hiring platforms, by the words in the job title:
+
+```ts
+const jobs = await hf.searchJobs('data engineer', {
+  location: 'Berlin',
+  postedWithinDays: 14,
+  limit: 20,
+});
+
+jobs.forEach((j) => console.log(j.title, j.company, j.location, j.url));
+```
+
+See what changed in a company's hiring since a date: what is open now, what opened and what closed, by department, seniority and location, with the jobs themselves:
+
+```ts
+const [acme] = await hf.hiringChanges('acme.com', '2026-10-01');
+
+console.log(acme.totals); // { open: 42, opened: 6, closed: 3 }
+acme.opened.forEach((j) => console.log(j.title, j.seniority, j.firstSeenAt));
+```
+
+A search costs 1 credit per 10 jobs returned, and an empty one is free. Hiring changes cost 1 credit per company we have jobs for; companies we do not track yet come back empty and are free.
+
 ## Brand data
 
 ```ts
@@ -177,6 +202,24 @@ await hf.styleguide('https://stripe.com/pricing', { maxAge: 0 }); // one page, r
 
 For logos in a browser use [`@hydrafetch/client-sdk`](https://github.com/Hydrafetch/client-sdk) or [`@hydrafetch/react`](https://github.com/Hydrafetch/react-sdk) with a publishable key. Those bill against logo pulls rather than credits.
 
+## Rating results
+
+Tell us when a result was wrong, so it gets looked at. It is free, and rating the same request again replaces the earlier rating.
+
+```ts
+const page = await hf.scrape('https://stripe.com/pricing');
+await hf.rateResult({
+  requestId: hf.lastRequestId,
+  rating: 'bad',
+  reasons: ['missing_content'],
+  note: 'The enterprise tier is missing',
+});
+
+await hf.rateResult({ url: 'https://stripe.com/pricing', rating: 'good' }); // by URL, last 24 hours
+```
+
+Reasons are `missing_content`, `wrong_content`, `blocked`, `slow`, `formatting` and `other`.
+
 ## Error handling
 
 All failures throw `HydrafetchError`, carrying the API's error code, HTTP status and request id.
@@ -233,6 +276,8 @@ const hf = new Hydrafetch({
 | `markdown(url, options?)` | `string` | 1 |
 | `map(url, options?)` | `MapResult` | 1 |
 | `search(query, options?)` | `SearchResult` | 1 + 1 per scraped result |
+| `searchJobs(query, options?)` | `OpenJob[]` | 1 per 10 jobs |
+| `hiringChanges(domains, since, options?)` | `CompanyHiringChanges[]` | 1 per company with jobs |
 | `extract(urls, options?)` | `ExtractResult<T>` | 5 per URL |
 | `brand(domain)` | `BrandResult` | 5 |
 | `logo(domain, options?)` | `LogoResult` | 1 |
@@ -245,6 +290,7 @@ const hf = new Hydrafetch({
 | `startCrawl(url, options?)` | `string` | 1 per page |
 | `startBatch(urls, options?)` | `string` | 1 per page |
 | `crawlStatus(id)`, `batchStatus(id)` | `JobResult` | free |
+| `rateResult(input)` | `RateResultResponse` | free |
 
 Failed requests are not billed. Pricing does not vary with page difficulty, so there is no render, stealth or proxy option to set.
 

package/dist/index.cjs

@@ -129,6 +129,10 @@ var Hydrafetch = class {
   timeoutMs;
   maxRetries;
   fetchImpl;
+  latestRequestId;
+  get lastRequestId() {
+    return this.latestRequestId;
+  }
   constructor(options = {}) {
     const opts = typeof options === "string" ? { apiKey: options } : options;
     const env = globalThis.process?.env;
@@ -136,7 +140,7 @@ var Hydrafetch = class {
     if (!apiKey) {
       throw new HydrafetchError({
         code: "MISSING_API_KEY",
-        message: "No API key. Pass one to the constructor or set HYDRAFETCH_API_KEY. Create a key at https://app.hydrafetch.com.",
+        message: "No API key. Pass one to the constructor or set HYDRAFETCH_API_KEY. Copy your key from https://app.hydrafetch.com.",
         status: 401
       });
     }
@@ -174,6 +178,7 @@ var Hydrafetch = class {
           body: body === void 0 ? void 0 : JSON.stringify(body),
           signal: controller.signal
         });
+        this.latestRequestId = res.headers.get("x-request-id") ?? this.latestRequestId;
         const text = await res.text();
         let parsed;
         try {
@@ -221,12 +226,25 @@ var Hydrafetch = class {
     const page = await this.scrape(url, { ...options, formats: ["markdown"] });
     return page.markdown;
   }
+  rateResult(input) {
+    return this.request("POST", "/v1/web/feedback", input);
+  }
   map(url, options = {}) {
     return this.request("POST", "/v1/web/map", { url, ...options });
   }
   search(query, options = {}) {
     return this.request("POST", "/v1/web/search", { query, ...options });
   }
+  searchJobs(query, options = {}) {
+    return this.request("POST", "/v1/web/index/jobs/search", { query, ...options });
+  }
+  hiringChanges(domains, since, options = {}) {
+    return this.request("POST", "/v1/web/index/jobs/changes", {
+      domains: Array.isArray(domains) ? domains : [domains],
+      since: since instanceof Date ? since.toISOString() : since,
+      ...options
+    });
+  }
   async extract(urls, options = {}) {
     const { schema, ...rest } = options;
     return this.request("POST", "/v1/web/extract", {

package/dist/index.d.cts

@@ -238,6 +238,91 @@ interface WaitOptions {
     pollIntervalMs?: number;
     onProgress?: (job: JobResult) => void;
 }
+type ResultRating = 'good' | 'bad';
+type ResultFeedbackReason = 'missing_content' | 'wrong_content' | 'blocked' | 'slow' | 'formatting' | 'other';
+interface RateResultInput {
+    requestId?: string;
+    url?: string;
+    rating: ResultRating;
+    reasons?: ResultFeedbackReason[];
+    note?: string;
+}
+interface RateResultResponse {
+    id: string;
+    requestId: string;
+    rating: ResultRating;
+}
+interface SearchJobsOptions {
+    /** A city, region or country to match, like "Berlin". */
+    location?: string;
+    /** Only jobs marked remote. */
+    remoteOnly?: boolean;
+    /** Only jobs posted in the last N days (1 to 365). */
+    postedWithinDays?: number;
+    /** Max jobs to return, 1 to 100 (default 10). Each 10 jobs returned cost 1 credit. */
+    limit?: number;
+    /** Include each job's description text when we hold it. */
+    includeDescriptions?: boolean;
+}
+interface JobPay {
+    min: number | null;
+    max: number | null;
+    currency: string | null;
+    interval: string | null;
+}
+interface OpenJob {
+    title: string;
+    company: string | null;
+    /** The company's website. */
+    domain: string;
+    /** The hiring platform the job is posted on. */
+    board: string;
+    department: string | null;
+    location: string | null;
+    remote: boolean | null;
+    employmentType: string | null;
+    postedAt: string | null;
+    /** When the job was first seen open. */
+    firstSeenAt: string;
+    url: string | null;
+    applyUrl: string | null;
+    pay: JobPay | null;
+    description?: string | null;
+}
+interface HiringChangesOptions {
+    /** Include each opened and closed job's description text when we hold it. */
+    includeDescriptions?: boolean;
+}
+interface HiringCounts {
+    open: number;
+    opened: number;
+    closed: number;
+}
+interface HiringChangePosting {
+    title: string;
+    department: string | null;
+    location: string | null;
+    seniority: string;
+    board: string;
+    url: string | null;
+    postedAt: string | null;
+    firstSeenAt: string;
+    closedAt: string | null;
+    description?: string | null;
+}
+interface CompanyHiringChanges {
+    domain: string;
+    company: string | null;
+    lastReadAt: string | null;
+    since: string;
+    totals: HiringCounts;
+    byDepartment: Record<string, HiringCounts>;
+    bySeniority: Record<string, HiringCounts>;
+    byLocation: Record<string, HiringCounts>;
+    opened: HiringChangePosting[];
+    closed: HiringChangePosting[];
+    truncated: boolean;
+}
 
 interface HydrafetchOptions {
     apiKey?: string;
@@ -252,12 +337,17 @@ declare class Hydrafetch {
     private readonly timeoutMs;
     private readonly maxRetries;
     private readonly fetchImpl;
+    private latestRequestId;
+    get lastRequestId(): string | undefined;
     constructor(options?: HydrafetchOptions | string);
     private request;
     scrape<const F extends readonly Format[] = ['markdown']>(url: string, options?: ScrapeOptions<F>): Promise<ScrapeResult<F[number]>>;
     markdown(url: string, options?: Omit<ScrapeOptions, 'formats'>): Promise<string>;
+    rateResult(input: RateResultInput): Promise<RateResultResponse>;
     map(url: string, options?: MapOptions): Promise<MapResult>;
     search(query: string, options?: SearchOptions): Promise<SearchResult>;
+    searchJobs(query: string, options?: SearchJobsOptions): Promise<OpenJob[]>;
+    hiringChanges(domains: string | string[], since: string | Date, options?: HiringChangesOptions): Promise<CompanyHiringChanges[]>;
     extract<T = unknown>(urls: string | string[], options?: ExtractOptions): Promise<ExtractResult<T>>;
     brand(domain: string): Promise<BrandResult>;
     logo(domain: string, options?: BrandOptions): Promise<LogoResult>;
@@ -297,4 +387,4 @@ declare class HydrafetchTimeoutError extends HydrafetchError {
     constructor(message: string);
 }
 
-export { type BatchOptions, type BrandOptions, type BrandResult, type CrawlOptions, type ExtractItem, type ExtractOptions, type ExtractResult, type ExtractSchema, type Format, Hydrafetch, HydrafetchError, type HydrafetchOptions, HydrafetchTimeoutError, type ImagesResult, type JobPage, type JobResult, type JobStatus, type Location, type LogoResult, type MapOptions, type MapResult, type PageImage, type PageMetadata, type ScrapeBase, type ScrapeContent, type ScrapeOptions, type ScrapeResult, type ScreenshotOptions, type ScreenshotResult, type SearchOptions, type SearchResult, type SearchResultItem, type StyleguideOptions, type StyleguideResult, type Usage, type WaitOptions, type ZodLike };
+export { type BatchOptions, type BrandOptions, type BrandResult, type CompanyHiringChanges, type CrawlOptions, type ExtractItem, type ExtractOptions, type ExtractResult, type ExtractSchema, type Format, type HiringChangePosting, type HiringChangesOptions, type HiringCounts, Hydrafetch, HydrafetchError, type HydrafetchOptions, HydrafetchTimeoutError, type ImagesResult, type JobPage, type JobPay, type JobResult, type JobStatus, type Location, type LogoResult, type MapOptions, type MapResult, type OpenJob, type PageImage, type PageMetadata, type RateResultInput, type RateResultResponse, type ResultFeedbackReason, type ResultRating, type ScrapeBase, type ScrapeContent, type ScrapeOptions, type ScrapeResult, type ScreenshotOptions, type ScreenshotResult, type SearchJobsOptions, type SearchOptions, type SearchResult, type SearchResultItem, type StyleguideOptions, type StyleguideResult, type Usage, type WaitOptions, type ZodLike };

package/dist/index.d.ts

@@ -238,6 +238,91 @@ interface WaitOptions {
     pollIntervalMs?: number;
     onProgress?: (job: JobResult) => void;
 }
+type ResultRating = 'good' | 'bad';
+type ResultFeedbackReason = 'missing_content' | 'wrong_content' | 'blocked' | 'slow' | 'formatting' | 'other';
+interface RateResultInput {
+    requestId?: string;
+    url?: string;
+    rating: ResultRating;
+    reasons?: ResultFeedbackReason[];
+    note?: string;
+}
+interface RateResultResponse {
+    id: string;
+    requestId: string;
+    rating: ResultRating;
+}
+interface SearchJobsOptions {
+    /** A city, region or country to match, like "Berlin". */
+    location?: string;
+    /** Only jobs marked remote. */
+    remoteOnly?: boolean;
+    /** Only jobs posted in the last N days (1 to 365). */
+    postedWithinDays?: number;
+    /** Max jobs to return, 1 to 100 (default 10). Each 10 jobs returned cost 1 credit. */
+    limit?: number;
+    /** Include each job's description text when we hold it. */
+    includeDescriptions?: boolean;
+}
+interface JobPay {
+    min: number | null;
+    max: number | null;
+    currency: string | null;
+    interval: string | null;
+}
+interface OpenJob {
+    title: string;
+    company: string | null;
+    /** The company's website. */
+    domain: string;
+    /** The hiring platform the job is posted on. */
+    board: string;
+    department: string | null;
+    location: string | null;
+    remote: boolean | null;
+    employmentType: string | null;
+    postedAt: string | null;
+    /** When the job was first seen open. */
+    firstSeenAt: string;
+    url: string | null;
+    applyUrl: string | null;
+    pay: JobPay | null;
+    description?: string | null;
+}
+interface HiringChangesOptions {
+    /** Include each opened and closed job's description text when we hold it. */
+    includeDescriptions?: boolean;
+}
+interface HiringCounts {
+    open: number;
+    opened: number;
+    closed: number;
+}
+interface HiringChangePosting {
+    title: string;
+    department: string | null;
+    location: string | null;
+    seniority: string;
+    board: string;
+    url: string | null;
+    postedAt: string | null;
+    firstSeenAt: string;
+    closedAt: string | null;
+    description?: string | null;
+}
+interface CompanyHiringChanges {
+    domain: string;
+    company: string | null;
+    lastReadAt: string | null;
+    since: string;
+    totals: HiringCounts;
+    byDepartment: Record<string, HiringCounts>;
+    bySeniority: Record<string, HiringCounts>;
+    byLocation: Record<string, HiringCounts>;
+    opened: HiringChangePosting[];
+    closed: HiringChangePosting[];
+    truncated: boolean;
+}
 
 interface HydrafetchOptions {
     apiKey?: string;
@@ -252,12 +337,17 @@ declare class Hydrafetch {
     private readonly timeoutMs;
     private readonly maxRetries;
     private readonly fetchImpl;
+    private latestRequestId;
+    get lastRequestId(): string | undefined;
     constructor(options?: HydrafetchOptions | string);
     private request;
     scrape<const F extends readonly Format[] = ['markdown']>(url: string, options?: ScrapeOptions<F>): Promise<ScrapeResult<F[number]>>;
     markdown(url: string, options?: Omit<ScrapeOptions, 'formats'>): Promise<string>;
+    rateResult(input: RateResultInput): Promise<RateResultResponse>;
     map(url: string, options?: MapOptions): Promise<MapResult>;
     search(query: string, options?: SearchOptions): Promise<SearchResult>;
+    searchJobs(query: string, options?: SearchJobsOptions): Promise<OpenJob[]>;
+    hiringChanges(domains: string | string[], since: string | Date, options?: HiringChangesOptions): Promise<CompanyHiringChanges[]>;
     extract<T = unknown>(urls: string | string[], options?: ExtractOptions): Promise<ExtractResult<T>>;
     brand(domain: string): Promise<BrandResult>;
     logo(domain: string, options?: BrandOptions): Promise<LogoResult>;
@@ -297,4 +387,4 @@ declare class HydrafetchTimeoutError extends HydrafetchError {
     constructor(message: string);
 }
 
-export { type BatchOptions, type BrandOptions, type BrandResult, type CrawlOptions, type ExtractItem, type ExtractOptions, type ExtractResult, type ExtractSchema, type Format, Hydrafetch, HydrafetchError, type HydrafetchOptions, HydrafetchTimeoutError, type ImagesResult, type JobPage, type JobResult, type JobStatus, type Location, type LogoResult, type MapOptions, type MapResult, type PageImage, type PageMetadata, type ScrapeBase, type ScrapeContent, type ScrapeOptions, type ScrapeResult, type ScreenshotOptions, type ScreenshotResult, type SearchOptions, type SearchResult, type SearchResultItem, type StyleguideOptions, type StyleguideResult, type Usage, type WaitOptions, type ZodLike };
+export { type BatchOptions, type BrandOptions, type BrandResult, type CompanyHiringChanges, type CrawlOptions, type ExtractItem, type ExtractOptions, type ExtractResult, type ExtractSchema, type Format, type HiringChangePosting, type HiringChangesOptions, type HiringCounts, Hydrafetch, HydrafetchError, type HydrafetchOptions, HydrafetchTimeoutError, type ImagesResult, type JobPage, type JobPay, type JobResult, type JobStatus, type Location, type LogoResult, type MapOptions, type MapResult, type OpenJob, type PageImage, type PageMetadata, type RateResultInput, type RateResultResponse, type ResultFeedbackReason, type ResultRating, type ScrapeBase, type ScrapeContent, type ScrapeOptions, type ScrapeResult, type ScreenshotOptions, type ScreenshotResult, type SearchJobsOptions, type SearchOptions, type SearchResult, type SearchResultItem, type StyleguideOptions, type StyleguideResult, type Usage, type WaitOptions, type ZodLike };

package/dist/index.js

@@ -101,6 +101,10 @@ var Hydrafetch = class {
   timeoutMs;
   maxRetries;
   fetchImpl;
+  latestRequestId;
+  get lastRequestId() {
+    return this.latestRequestId;
+  }
   constructor(options = {}) {
     const opts = typeof options === "string" ? { apiKey: options } : options;
     const env = globalThis.process?.env;
@@ -108,7 +112,7 @@ var Hydrafetch = class {
     if (!apiKey) {
       throw new HydrafetchError({
         code: "MISSING_API_KEY",
-        message: "No API key. Pass one to the constructor or set HYDRAFETCH_API_KEY. Create a key at https://app.hydrafetch.com.",
+        message: "No API key. Pass one to the constructor or set HYDRAFETCH_API_KEY. Copy your key from https://app.hydrafetch.com.",
         status: 401
       });
     }
@@ -146,6 +150,7 @@ var Hydrafetch = class {
           body: body === void 0 ? void 0 : JSON.stringify(body),
           signal: controller.signal
         });
+        this.latestRequestId = res.headers.get("x-request-id") ?? this.latestRequestId;
         const text = await res.text();
         let parsed;
         try {
@@ -193,12 +198,25 @@ var Hydrafetch = class {
     const page = await this.scrape(url, { ...options, formats: ["markdown"] });
     return page.markdown;
   }
+  rateResult(input) {
+    return this.request("POST", "/v1/web/feedback", input);
+  }
   map(url, options = {}) {
     return this.request("POST", "/v1/web/map", { url, ...options });
   }
   search(query, options = {}) {
     return this.request("POST", "/v1/web/search", { query, ...options });
   }
+  searchJobs(query, options = {}) {
+    return this.request("POST", "/v1/web/index/jobs/search", { query, ...options });
+  }
+  hiringChanges(domains, since, options = {}) {
+    return this.request("POST", "/v1/web/index/jobs/changes", {
+      domains: Array.isArray(domains) ? domains : [domains],
+      since: since instanceof Date ? since.toISOString() : since,
+      ...options
+    });
+  }
   async extract(urls, options = {}) {
     const { schema, ...rest } = options;
     return this.request("POST", "/v1/web/extract", {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hydrafetch/node-sdk",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Official Node/TypeScript client for the Hydrafetch web data API. Turn any URL into clean Markdown and structured data.",
   "keywords": [
     "hydrafetch",