Socket
Socket
Sign inDemoInstall

universal-pdp-scrapper

Package Overview
Dependencies
81
Maintainers
1
Versions
15
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    universal-pdp-scrapper

A universal pdp scrapper using cheerio & ChatGPT


Version published
Maintainers
1
Created

Readme

Source

Universal PDP Scrapper

NPM JavaScript Style Guide pages-build-deployment

This is a universal PDP scrapper that can scrape any product detail page and extract the following information:

product_name?: string;
images?: string[];
height?: string;
width?: string;
depth?: string;
material?: string;
price?: string;
sku?: string;
artist?: string;
type?: Types;
product_url?: string;
source?: string;
glbs?: string[];
glb_to_use?: string;
'supporting-surface'?: 'floor' | 'wall';

Under the hood, it uses OpenAI to extract estimated information from the product page and Google Custom Search JSON API / SerpAPI to extract images from product pages using Google Image Search coupled with Ikea's product search API and some custom scrappers for some popular furniture websites.

How to use

1. Install

npm i universal-pdp-scrapper

2. Usage

import { UniversalPDPScrapper } from 'universal-pdp-scrapper';

// Initialize the client and set the API keys
// You can set API Keys using environment variables as well: check [.env.sample](./.env.sample)
const client = new UniversalPDPScrapper({
    openaiApiKey: '',
    openaiOrgId: '',
    openaiModelId: '',
    googleApiKey: '',
    googleCseId: ''
});
const result = await client.scrape('https://www.ikea.com/us/en/p/jokkmokk-table-and-4-chairs-antique-stain-50211104/');
console.log(result);

3. Demo

Here's a demo of running the scrapper in a server environment integrated with a React app

4. Documentation

Check here.

Features

  • Supports ES6 Async/Await
  • Supports CommonJS require
  • Tree-shakable
  • Can be used both in Node and Browser environments
  • Written in Typescript
  • Uses OpenAI to extract estimated information from the product page
  • Uses Google Custom Search JSON API to extract images from product pages using Google Image Search
  • Uses Cheerio to scrape product pages for some popular websites

NOTE: This library doesn't solve the issue of CORS for images or glbs. If you encounter cors, its better to use this library in the server environment and download the images and glbs to your server and serve them from there.

universal-pdp-scrapper npminsights.com

Module Stats

See Rollup Visualizer

Keywords

FAQs

Last updated on 25 Aug 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc