@corsair-dev/litescrape 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/README.md +214 -26
  2. package/dist/client.d.ts +5 -1
  3. package/dist/client.d.ts.map +1 -1
  4. package/dist/docs-examples.test.d.ts +2 -0
  5. package/dist/docs-examples.test.d.ts.map +1 -0
  6. package/dist/endpoints/catalog.d.ts +2083 -0
  7. package/dist/endpoints/catalog.d.ts.map +1 -0
  8. package/dist/endpoints/index.d.ts +5 -1683
  9. package/dist/endpoints/index.d.ts.map +1 -1
  10. package/dist/endpoints/keys.d.ts +69 -2
  11. package/dist/endpoints/keys.d.ts.map +1 -1
  12. package/dist/endpoints/manifest.d.ts +51 -0
  13. package/dist/endpoints/manifest.d.ts.map +1 -0
  14. package/dist/endpoints/openapi-schema.d.ts +17 -0
  15. package/dist/endpoints/openapi-schema.d.ts.map +1 -0
  16. package/dist/endpoints/operation-types.d.ts +12023 -0
  17. package/dist/endpoints/operation-types.d.ts.map +1 -0
  18. package/dist/endpoints/operations.d.ts +12 -0
  19. package/dist/endpoints/operations.d.ts.map +1 -0
  20. package/dist/endpoints/types.d.ts +18 -3358
  21. package/dist/endpoints/types.d.ts.map +1 -1
  22. package/dist/index.d.ts +8 -1727
  23. package/dist/index.d.ts.map +1 -1
  24. package/dist/index.js +1 -1
  25. package/package.json +2 -2
  26. package/dist/endpoints/apple-app-store.d.ts +0 -5
  27. package/dist/endpoints/apple-app-store.d.ts.map +0 -1
  28. package/dist/endpoints/apple-maps.d.ts +0 -4
  29. package/dist/endpoints/apple-maps.d.ts.map +0 -1
  30. package/dist/endpoints/bing.d.ts +0 -4
  31. package/dist/endpoints/bing.d.ts.map +0 -1
  32. package/dist/endpoints/duckduckgo.d.ts +0 -4
  33. package/dist/endpoints/duckduckgo.d.ts.map +0 -1
  34. package/dist/endpoints/google-maps.d.ts +0 -8
  35. package/dist/endpoints/google-maps.d.ts.map +0 -1
  36. package/dist/endpoints/google-play.d.ts +0 -8
  37. package/dist/endpoints/google-play.d.ts.map +0 -1
  38. package/dist/endpoints/google.d.ts +0 -9
  39. package/dist/endpoints/google.d.ts.map +0 -1
  40. package/dist/endpoints/tripadvisor.d.ts +0 -5
  41. package/dist/endpoints/tripadvisor.d.ts.map +0 -1
  42. package/dist/endpoints/web.d.ts +0 -4
  43. package/dist/endpoints/web.d.ts.map +0 -1
  44. package/dist/endpoints/yelp.d.ts +0 -4
  45. package/dist/endpoints/yelp.d.ts.map +0 -1
package/README.md CHANGED
@@ -8,56 +8,244 @@ LiteScrape plugin for Corsair.
8
8
  pnpm add @corsair-dev/litescrape
9
9
  ```
10
10
 
11
+ ## How it is built
12
+
13
+ The 200 data operations come from Litescrape's published OpenAPI spec
14
+ (https://api.litescrape.com/api/openapi.json, fetched 2026-11-19):
15
+
16
+ - `litescrape-manifest.json` holds each operation's route, request body schema
17
+ and response schema (identical response models merged, UI metadata dropped).
18
+ - `endpoints/operation-types.ts` and `endpoints/catalog.ts` are generated from
19
+ the same spec: input and output types, the endpoint tree and descriptions.
20
+ - Zod schemas are built from the manifest on first use, one operation at a
21
+ time (`endpoints/openapi-schema.ts`), so loading the plugin stays cheap.
22
+
23
+ Inputs follow the request bodies exactly (required fields, enums, limits, no
24
+ unknown keys). Every operation is sent as a JSON `POST`, the form that carries
25
+ arrays and nested objects. `timeout` (seconds, at most 90) goes in the query
26
+ string. Responses keep the documented types, but every field may be missing or
27
+ `null`, and unknown fields pass through.
28
+
29
+ Left out on purpose: the async job and batch routes (the sync routes cover the
30
+ same data), the Serper-compatible routes (`/search`, `/maps` and so on, which
31
+ duplicate Google), billing and key management (checkout, auto top-up, rotate,
32
+ ZDR), and four routes the spec marks gone (410): Amazon featured and media
33
+ reviews, TikTok keyword and top search.
34
+
11
35
  ## Endpoints
12
36
 
13
37
  | Operation | Operation ID | Risk | Description |
14
38
  |-----------|--------------|------|-------------|
15
- | `google.search` | `litescrape.api.google.search` | `read` | Search Google for organic results, Knowledge Graph, related searches and the AI Overview |
16
- | `google.aiOverview` | `litescrape.api.google.aiOverview` | `read` | Get Google's AI Overview for a query as text blocks and cited references |
17
- | `google.aiMode` | `litescrape.api.google.aiMode` | `read` | Ask Google AI Mode a question and get text blocks with cited references |
39
+ | `airbnb.search` | `litescrape.api.airbnb.search` | `read` | Search Airbnb stays by destination and dates |
40
+ | `aliexpress.product` | `litescrape.api.aliexpress.product` | `read` | Get an AliExpress product's details and price (Alpha) |
41
+ | `aliexpress.search` | `litescrape.api.aliexpress.search` | `read` | Search AliExpress products with prices (Alpha) |
42
+ | `allkeyshop.product` | `litescrape.api.allkeyshop.product` | `read` | Get Allkeyshop product details, prices, and available offers |
43
+ | `allkeyshop.search` | `litescrape.api.allkeyshop.search` | `read` | Search Allkeyshop products with prices and product links |
44
+ | `amazon.autocomplete` | `litescrape.api.amazon.autocomplete` | `read` | Get Amazon search suggestions for a prefix and department (Alpha) |
45
+ | `amazon.product` | `litescrape.api.amazon.product` | `read` | Get an Amazon product page, with optional seller offers (Alpha) |
46
+ | `amazon.search` | `litescrape.api.amazon.search` | `read` | Search Amazon products (Alpha) |
47
+ | `apartments.property` | `litescrape.api.apartments.property` | `read` | Get an Apartments.com property by URL (Alpha) |
48
+ | `apartments.search` | `litescrape.api.apartments.search` | `read` | Search Apartments.com listings from a search URL (Alpha) |
49
+ | `appleAppStore.product` | `litescrape.api.appleAppStore.product` | `read` | Get an Apple App Store product page with version history and privacy labels (Alpha) |
50
+ | `appleAppStore.reviews` | `litescrape.api.appleAppStore.reviews` | `read` | Get Apple App Store reviews, newest or most helpful first (Alpha) |
51
+ | `appleAppStore.search` | `litescrape.api.appleAppStore.search` | `read` | Search the Apple App Store for apps with developer, price and rating (Alpha) |
52
+ | `appleMaps.places` | `litescrape.api.appleMaps.places` | `read` | Get Apple Maps places by MUID with address, hours and ratings |
53
+ | `appleMaps.reviews` | `litescrape.api.appleMaps.reviews` | `read` | Get Apple Maps rating summary and written reviews by MUID |
54
+ | `ashby.search` | `litescrape.api.ashby.search` | `read` | Search jobs on a company's Ashby job board |
55
+ | `baidu.search` | `litescrape.api.baidu.search` | `read` | Get Baidu search results as JSON |
56
+ | `bestbuy.product` | `litescrape.api.bestbuy.product` | `read` | Get a Best Buy product's details, price and availability (Alpha) |
57
+ | `bestbuy.search` | `litescrape.api.bestbuy.search` | `read` | Search Best Buy products with prices and availability (Alpha) |
58
+ | `bing.autocomplete` | `litescrape.api.bing.autocomplete` | `read` | Get Bing search suggestions for a partial query, with entity details when Bing shows them |
59
+ | `bing.images` | `litescrape.api.bing.images` | `read` | Search Bing Images with size, color, date and license filters |
60
+ | `bing.maps` | `litescrape.api.bing.maps` | `read` | Get Bing Maps listings by query or one place by ID |
61
+ | `bing.product` | `litescrape.api.bing.product` | `read` | Get a Bing Shopping product's details using its product token |
62
+ | `bing.search` | `litescrape.api.bing.search` | `read` | Search Bing for organic results, knowledge cards and rich modules |
63
+ | `bing.shopping` | `litescrape.api.bing.shopping` | `read` | Search Bing Shopping products |
64
+ | `bluesky.followers` | `litescrape.api.bluesky.followers` | `read` | List the public followers of a Bluesky account |
65
+ | `bluesky.posts` | `litescrape.api.bluesky.posts` | `read` | Read public posts from a Bluesky account with pagination |
66
+ | `bluesky.profile` | `litescrape.api.bluesky.profile` | `read` | Get a public Bluesky profile and follower counts |
67
+ | `booking.detail` | `litescrape.api.booking.detail` | `read` | Get property photos, facilities, policies, review summaries, guest questions, and a quote for selected dates and guests |
68
+ | `booking.rooms` | `litescrape.api.booking.rooms` | `read` | Get room types and available rate options for a property stay, including capacity, beds, facilities, prices, and cancellation terms |
69
+ | `booking.search` | `litescrape.api.booking.search` | `read` | Search accommodations by destination and stay, with locations, prices, rate terms, ratings, and room configurations |
70
+ | `brave.aiMode` | `litescrape.api.brave.aiMode` | `read` | Get Brave AI answers with citations |
71
+ | `brave.search` | `litescrape.api.brave.search` | `read` | Get Brave web search results |
72
+ | `copilot.chat` | `litescrape.api.copilot.chat` | `read` | Text completions through Microsoft Copilot (Alpha) |
73
+ | `duckduckgo.maps` | `litescrape.api.duckduckgo.maps` | `read` | Get DuckDuckGo Maps places within a bounding box |
74
+ | `duckduckgo.search` | `litescrape.api.duckduckgo.search` | `read` | Search DuckDuckGo for organic results with region and safe-search controls |
75
+ | `ebay.product` | `litescrape.api.ebay.product` | `read` | Get an eBay listing by item ID |
76
+ | `ebay.search` | `litescrape.api.ebay.search` | `read` | Search eBay listings by keyword or category |
77
+ | `ebay.seller` | `litescrape.api.ebay.seller` | `read` | Get an eBay seller's profile and listings |
78
+ | `etsy.product` | `litescrape.api.etsy.product` | `read` | Get an Etsy listing's details and price (Alpha) |
79
+ | `etsy.search` | `litescrape.api.etsy.search` | `read` | Search Etsy listings with prices (Alpha) |
80
+ | `eventbrite.search` | `litescrape.api.eventbrite.search` | `read` | Search Eventbrite events by location and keyword |
81
+ | `facebook.hashtagPosts` | `litescrape.api.facebook.hashtagPosts` | `read` | Get public Facebook posts for a hashtag (Alpha) |
82
+ | `facebook.marketplaceBrowse` | `litescrape.api.facebook.marketplaceBrowse` | `read` | Browse or search Facebook Marketplace listings by city (Alpha) |
83
+ | `facebook.pagePosts` | `litescrape.api.facebook.pagePosts` | `read` | Get recent public posts from a Facebook Page (Alpha) |
84
+ | `facebook.post` | `litescrape.api.facebook.post` | `read` | Get a public Facebook post by its URL (Alpha) |
85
+ | `facebook.reel` | `litescrape.api.facebook.reel` | `read` | Get a public Facebook reel by its URL (Alpha) |
86
+ | `facebook.searchPages` | `litescrape.api.facebook.searchPages` | `read` | Search public Facebook Pages by name (Alpha) |
87
+ | `facebook.searchProfiles` | `litescrape.api.facebook.searchProfiles` | `read` | Search public Facebook profiles by name (Alpha) |
88
+ | `farmavazquez.product` | `litescrape.api.farmavazquez.product` | `read` | Get FarmaVázquez product details, prices, and available offers |
89
+ | `farmavazquez.search` | `litescrape.api.farmavazquez.search` | `read` | Search FarmaVázquez products with prices and product links |
90
+ | `github.issues` | `litescrape.api.github.issues` | `read` | List repository issues and pull requests with their authors and labels |
91
+ | `github.releases` | `litescrape.api.github.releases` | `read` | List repository releases and downloadable assets |
92
+ | `github.repository` | `litescrape.api.github.repository` | `read` | Get repository details, stars, forks, topics, and activity dates |
93
+ | `github.search` | `litescrape.api.github.search` | `read` | Search public GitHub repositories by keywords and qualifiers |
94
+ | `github.user` | `litescrape.api.github.user` | `read` | Get a public GitHub user or organization profile |
95
+ | `glassdoor.search` | `litescrape.api.glassdoor.search` | `read` | Search Glassdoor jobs by keyword and location, with salary, seniority and remote filters |
18
96
  | `google.ads` | `litescrape.api.google.ads` | `read` | Get Google text, local and shopping ads plus the rest of the results page (Alpha) |
97
+ | `google.aiMode` | `litescrape.api.google.aiMode` | `read` | Ask Google AI Mode a question and get text blocks with cited references |
98
+ | `google.aiOverview` | `litescrape.api.google.aiOverview` | `read` | Get Google's AI Overview for a query as text blocks and cited references |
99
+ | `google.autocomplete` | `litescrape.api.google.autocomplete` | `read` | Get search suggestions for a partial query |
100
+ | `google.flights` | `litescrape.api.google.flights` | `read` | Search flights with passenger fares, multiple airports, airline logos, emissions, price insights, compatible return itineraries and booking links |
101
+ | `google.gemini` | `litescrape.api.google.gemini` | `read` | Get a completed text reply from Gemini |
102
+ | `google.images` | `litescrape.api.google.images` | `read` | Search Google Images. Embedded images may use an x-raw-image:/// reference in original instead of an HTTP URL; thumbnail remains an HTTP image URL |
103
+ | `google.jobs` | `litescrape.api.google.jobs` | `read` | Search Google Jobs listings by query and location, including descriptions and application links when available |
19
104
  | `google.local` | `litescrape.api.google.local` | `read` | Get Google local results with rating, reviews, category, address and place IDs |
105
+ | `google.news` | `litescrape.api.google.news` | `read` | Find recent news articles by topic, language, and country |
106
+ | `google.patents` | `litescrape.api.google.patents` | `read` | Search patent publications by query, patent office, status, and publication date |
107
+ | `google.reverseImageSearch` | `litescrape.api.google.reverseImageSearch` | `read` | Find visually similar images and pages using an image URL |
108
+ | `google.scholar` | `litescrape.api.google.scholar` | `read` | Search scholarly articles with publication details, citation counts, and full-text links |
109
+ | `google.search` | `litescrape.api.google.search` | `read` | Search Google for organic results, Knowledge Graph, related searches and the AI Overview |
20
110
  | `google.shopping` | `litescrape.api.google.shopping` | `read` | Get Google Shopping products with price, merchant, rating and delivery |
111
+ | `google.shoppingMerchantUrls` | `litescrape.api.google.shoppingMerchantUrls` | `read` | Get direct merchant URLs for Google Shopping offers |
21
112
  | `google.shoppingProduct` | `litescrape.api.google.shoppingProduct` | `read` | Get one Google Shopping product page with every merchant offer and specification |
22
- | `googleMaps.search` | `litescrape.api.googleMaps.search` | `read` | Get Google Maps places by query or one place by ID |
23
- | `googleMaps.reviews` | `litescrape.api.googleMaps.reviews` | `read` | Get Google Maps reviews with rating, text, author, date and likes |
113
+ | `google.trends` | `litescrape.api.google.trends` | `read` | Get currently trending searches and related news by country |
24
114
  | `googleMaps.contributorReviews` | `litescrape.api.googleMaps.contributorReviews` | `read` | Get the public review history for one Google Maps contributor |
115
+ | `googleMaps.menu` | `litescrape.api.googleMaps.menu` | `read` | Get a restaurant's menu, prices, booking links, and opening hours |
116
+ | `googleMaps.photoMeta` | `litescrape.api.googleMaps.photoMeta` | `read` | Get the place, contributor and date of a Google Maps photo |
117
+ | `googleMaps.photos` | `litescrape.api.googleMaps.photos` | `read` | List a place's photos and videos, including only the ones its owner posted |
25
118
  | `googleMaps.popularTimes` | `litescrape.api.googleMaps.popularTimes` | `read` | See how busy a Google Maps place is right now |
26
119
  | `googleMaps.posts` | `litescrape.api.googleMaps.posts` | `read` | Read the posts published by a Google Maps business |
27
- | `googleMaps.photoMeta` | `litescrape.api.googleMaps.photoMeta` | `read` | Get the place, contributor and date of a Google Maps photo |
28
- | `bing.search` | `litescrape.api.bing.search` | `read` | Search Bing for organic results, knowledge cards and rich modules |
29
- | `bing.maps` | `litescrape.api.bing.maps` | `read` | Get Bing Maps listings by query or one place by ID |
30
- | `duckduckgo.search` | `litescrape.api.duckduckgo.search` | `read` | Search DuckDuckGo for organic results with region and safe-search controls |
31
- | `duckduckgo.maps` | `litescrape.api.duckduckgo.maps` | `read` | Get DuckDuckGo Maps places within a bounding box |
32
- | `yelp.search` | `litescrape.api.yelp.search` | `read` | Search Yelp businesses with rating, reviews, categories and filters |
33
- | `yelp.reviews` | `litescrape.api.yelp.reviews` | `read` | Get Yelp reviews with rating, text, reviewer and owner replies |
34
- | `tripadvisor.search` | `litescrape.api.tripadvisor.search` | `read` | Search Tripadvisor hotels, restaurants and attractions |
35
- | `tripadvisor.place` | `litescrape.api.tripadvisor.place` | `read` | Get Tripadvisor place details by place ID |
36
- | `tripadvisor.reviews` | `litescrape.api.tripadvisor.reviews` | `read` | Get Tripadvisor reviews sorted by recency or relevance |
37
- | `appleMaps.places` | `litescrape.api.appleMaps.places` | `read` | Get Apple Maps places by MUID with address, hours and ratings |
38
- | `appleMaps.reviews` | `litescrape.api.appleMaps.reviews` | `read` | Get Apple Maps rating summary and written reviews by MUID |
120
+ | `googleMaps.reviews` | `litescrape.api.googleMaps.reviews` | `read` | Get Google Maps reviews with rating, text, author, date and likes |
121
+ | `googleMaps.search` | `litescrape.api.googleMaps.search` | `read` | Get Google Maps places by query or one place by ID |
39
122
  | `googlePlay.apps` | `litescrape.api.googlePlay.apps` | `read` | Search and browse Google Play apps with charts, categories and storefronts (Alpha) |
40
- | `googlePlay.games` | `litescrape.api.googlePlay.games` | `read` | Browse Google Play games by category, chart and device (Alpha) |
41
123
  | `googlePlay.books` | `litescrape.api.googlePlay.books` | `read` | Browse Google Play ebooks and audiobooks with categories and charts (Alpha) |
124
+ | `googlePlay.games` | `litescrape.api.googlePlay.games` | `read` | Browse Google Play games by category, chart and device (Alpha) |
42
125
  | `googlePlay.movies` | `litescrape.api.googlePlay.movies` | `read` | Browse Google Play movies, shows and episodes with categories and charts (Alpha) |
43
126
  | `googlePlay.product` | `litescrape.api.googlePlay.product` | `read` | Get a Google Play product page with ratings, permissions, media and reviews (Alpha) |
44
127
  | `googlePlay.reviews` | `litescrape.api.googlePlay.reviews` | `read` | Get Google Play reviews filtered by rating and platform (Alpha) |
45
- | `appleAppStore.search` | `litescrape.api.appleAppStore.search` | `read` | Search the Apple App Store for apps with developer, price and rating (Alpha) |
46
- | `appleAppStore.product` | `litescrape.api.appleAppStore.product` | `read` | Get an Apple App Store product page with version history and privacy labels (Alpha) |
47
- | `appleAppStore.reviews` | `litescrape.api.appleAppStore.reviews` | `read` | Get Apple App Store reviews, newest or most helpful first (Alpha) |
128
+ | `greenhouse.job` | `litescrape.api.greenhouse.job` | `read` | Get a public Greenhouse job description, departments, published pay ranges, and application questions |
129
+ | `greenhouse.jobs` | `litescrape.api.greenhouse.jobs` | `read` | List public employer jobs and filter by title or location |
130
+ | `hackernews.item` | `litescrape.api.hackernews.item` | `read` | Get a Hacker News story, comment, job, or poll by ID |
131
+ | `hackernews.stories` | `litescrape.api.hackernews.stories` | `read` | Get ranked Hacker News stories with scores and discussion IDs |
132
+ | `hackernews.user` | `litescrape.api.hackernews.user` | `read` | Get a public Hacker News profile and recent submitted item IDs |
133
+ | `homedepot.product` | `litescrape.api.homedepot.product` | `read` | Get a Home Depot product's details, price and availability (Alpha) |
134
+ | `homedepot.search` | `litescrape.api.homedepot.search` | `read` | Search Home Depot products with prices and availability (Alpha) |
135
+ | `homes.property` | `litescrape.api.homes.property` | `read` | Get a Homes.com property by URL (Alpha) |
136
+ | `homes.search` | `litescrape.api.homes.search` | `read` | Search Homes.com listings from a search URL (Alpha) |
137
+ | `idealo.product` | `litescrape.api.idealo.product` | `read` | Get Idealo Italy product details, prices, and available offers |
138
+ | `idealo.search` | `litescrape.api.idealo.search` | `read` | Search Idealo Italy products with prices and product links |
139
+ | `ikea.product` | `litescrape.api.ikea.product` | `read` | Get an IKEA product's details, price and availability (Alpha) |
140
+ | `ikea.search` | `litescrape.api.ikea.search` | `read` | Search IKEA products with prices and availability (Alpha) |
141
+ | `indeed.search` | `litescrape.api.indeed.search` | `read` | Search Indeed jobs by keyword and location, with salary, experience and remote filters |
142
+ | `instagram.embed` | `litescrape.api.instagram.embed` | `read` | Retrieve public Instagram embed data (Alpha) |
143
+ | `instagram.post` | `litescrape.api.instagram.post` | `read` | Retrieve public Instagram post data (Alpha) |
144
+ | `instagram.posts` | `litescrape.api.instagram.posts` | `read` | Retrieve public Instagram posts data (Alpha) |
145
+ | `instagram.profile` | `litescrape.api.instagram.profile` | `read` | Retrieve public Instagram profile data (Alpha) |
146
+ | `instagram.profilePostCount` | `litescrape.api.instagram.profilePostCount` | `read` | Retrieve public Instagram profile post count data (Alpha) |
147
+ | `instagram.searchPopular` | `litescrape.api.instagram.searchPopular` | `read` | Get popular Instagram posts for a search topic (Alpha) |
148
+ | `keys.status` | `litescrape.api.keys.status` | `read` | Get LiteScrape key status, remaining calls and concurrency limit |
149
+ | `keys.usage` | `litescrape.api.keys.usage` | `read` | Get call usage for the key over the last 24 hours to 90 days |
150
+ | `kroger.product` | `litescrape.api.kroger.product` | `read` | Get a Kroger product's details, price and availability (Alpha) |
151
+ | `kroger.search` | `litescrape.api.kroger.search` | `read` | Search Kroger products with prices and availability (Alpha) |
152
+ | `levels.search` | `litescrape.api.levels.search` | `read` | Search Levels.fyi jobs by company, location, level and pay |
153
+ | `lever.jobs` | `litescrape.api.lever.jobs` | `read` | Page through an employer's public jobs, descriptions, and application links |
154
+ | `linkedin.company` | `litescrape.api.linkedin.company` | `read` | Read public company profiles with follower and employee counts, office locations, and similar companies |
155
+ | `linkedin.companyPosts` | `litescrape.api.linkedin.companyPosts` | `read` | Read recent public company posts and reposts with reaction and comment counts, authors, and media |
156
+ | `linkedin.job` | `litescrape.api.linkedin.job` | `read` | Get a public LinkedIn job description, employment details, published salary, and applicant count |
157
+ | `linkedin.jobs` | `litescrape.api.linkedin.jobs` | `read` | Search public LinkedIn job listings by keywords, location, and workplace type |
158
+ | `naturitas.product` | `litescrape.api.naturitas.product` | `read` | Get Naturitas product details, prices, pack discounts, ratings, and categories |
159
+ | `naturitas.search` | `litescrape.api.naturitas.search` | `read` | Search Naturitas products with prices, discounts, ratings, and product links |
160
+ | `naver.aiOverview` | `litescrape.api.naver.aiOverview` | `read` | Get Naver AI Briefing answers with citations |
161
+ | `naver.search` | `litescrape.api.naver.search` | `read` | Search Naver web, news, video and image results |
162
+ | `npm.package` | `litescrape.api.npm.package` | `read` | Get an npm package version and its dependencies |
163
+ | `npm.search` | `litescrape.api.npm.search` | `read` | Search npm packages by keywords and qualifiers |
164
+ | `pinterest.profile` | `litescrape.api.pinterest.profile` | `read` | Get a public Pinterest profile, biography, and follower counts |
165
+ | `producthunt.launches` | `litescrape.api.producthunt.launches` | `read` | Read today's public launches with product names, links, and taglines |
166
+ | `pypi.project` | `litescrape.api.pypi.project` | `read` | Get Python package metadata and release files from PyPI |
167
+ | `realtor.property` | `litescrape.api.realtor.property` | `read` | Get a Realtor.com property by URL (Alpha) |
168
+ | `realtor.search` | `litescrape.api.realtor.search` | `read` | Search Realtor.com listings from a search URL (Alpha) |
169
+ | `reddit.post` | `litescrape.api.reddit.post` | `read` | Get a public Reddit post and available discussion comments |
170
+ | `reddit.search` | `litescrape.api.reddit.search` | `read` | Search public Reddit posts by keywords, sort order, and time range |
171
+ | `reddit.subredditPosts` | `litescrape.api.reddit.subredditPosts` | `read` | Read public posts from a subreddit with pagination |
172
+ | `redfin.property` | `litescrape.api.redfin.property` | `read` | Get a Redfin property by listing URL |
173
+ | `redfin.search` | `litescrape.api.redfin.search` | `read` | Search Redfin homes for sale or recently sold |
174
+ | `remoteok.jobs` | `litescrape.api.remoteok.jobs` | `read` | Find remote jobs by keywords and tags |
175
+ | `shopify.products` | `litescrape.api.shopify.products` | `read` | Page through published product catalogs with variants, prices, and availability |
176
+ | `soundcloud.track` | `litescrape.api.soundcloud.track` | `read` | Read public track metadata, duration, and available engagement counts |
177
+ | `spotify.item` | `litescrape.api.spotify.item` | `read` | Read public track, album, artist, and playlist metadata and available track lists |
178
+ | `sprouts.product` | `litescrape.api.sprouts.product` | `read` | Get a Sprouts product's details, price and availability (Alpha) |
179
+ | `sprouts.search` | `litescrape.api.sprouts.search` | `read` | Search Sprouts products with prices and availability (Alpha) |
180
+ | `stackoverflow.answers` | `litescrape.api.stackoverflow.answers` | `read` | Read answers to a Stack Overflow question with pagination |
181
+ | `stackoverflow.comments` | `litescrape.api.stackoverflow.comments` | `read` | Read comments on a Stack Overflow question with pagination |
182
+ | `stackoverflow.question` | `litescrape.api.stackoverflow.question` | `read` | Get a Stack Overflow question, its text, tags, and statistics |
183
+ | `stackoverflow.search` | `litescrape.api.stackoverflow.search` | `read` | Search Stack Overflow questions by keywords and tags |
184
+ | `steam.app` | `litescrape.api.steam.app` | `read` | Get Steam app details, descriptions, publishers, and regional prices |
185
+ | `steam.search` | `litescrape.api.steam.search` | `read` | Find Steam games and software with regional pricing |
186
+ | `substack.posts` | `litescrape.api.substack.posts` | `read` | Page through public publication archives with titles, dates, and engagement counts |
187
+ | `target.product` | `litescrape.api.target.product` | `read` | Get a product sold by the US retailer Target, with its details, price and availability (Alpha) |
188
+ | `target.search` | `litescrape.api.target.search` | `read` | Search products sold by the US retailer Target, with prices and availability (Alpha) |
189
+ | `telegram.posts` | `litescrape.api.telegram.posts` | `read` | Read public channel posts with dates, text, and displayed view counts |
190
+ | `tiktok.collectionVideos` | `litescrape.api.tiktok.collectionVideos` | `read` | Page through posts saved in a public TikTok collection (Alpha) |
191
+ | `tiktok.commentReplies` | `litescrape.api.tiktok.commentReplies` | `read` | Page through replies to a TikTok comment (Alpha) |
192
+ | `tiktok.comments` | `litescrape.api.tiktok.comments` | `read` | Page through public comments on a TikTok post (Alpha) |
193
+ | `tiktok.followers` | `litescrape.api.tiktok.followers` | `read` | Page through public followers of a TikTok user (Alpha) |
194
+ | `tiktok.following` | `litescrape.api.tiktok.following` | `read` | Page through the public accounts a TikTok user follows (Alpha) |
195
+ | `tiktok.live` | `litescrape.api.tiktok.live` | `read` | Get a TikTok live room's status and metrics (Alpha) |
196
+ | `tiktok.profile` | `litescrape.api.tiktok.profile` | `read` | Get public TikTok profile fields and statistics by handle or numeric user ID (Alpha) |
197
+ | `tiktok.profileVideos` | `litescrape.api.tiktok.profileVideos` | `read` | Page through posts from a public TikTok profile by handle or numeric user ID (Alpha) |
198
+ | `tiktok.searchHashtag` | `litescrape.api.tiktok.searchHashtag` | `read` | Resolve a public hashtag and page through its posts (Alpha) |
199
+ | `tiktok.searchSuggestions` | `litescrape.api.tiktok.searchSuggestions` | `read` | Get public TikTok autocomplete suggestions in order (Alpha) |
200
+ | `tiktok.song` | `litescrape.api.tiktok.song` | `read` | Get a TikTok sound's details and usage count (Alpha) |
201
+ | `tiktok.songVideos` | `litescrape.api.tiktok.songVideos` | `read` | Page through TikTok posts that use a sound (Alpha) |
202
+ | `tiktok.transcript` | `litescrape.api.tiktok.transcript` | `read` | Get public TikTok captions with timed segments (Alpha) |
203
+ | `tiktok.trendingFeed` | `litescrape.api.tiktok.trendingFeed` | `read` | Get TikTok's trending feed (Alpha) |
204
+ | `tiktok.userLive` | `litescrape.api.tiktok.userLive` | `read` | Get a TikTok user's live status and room metadata (Alpha) |
205
+ | `tiktok.video` | `litescrape.api.tiktok.video` | `read` | Get a TikTok video or photo post with its media and metrics (Alpha) |
206
+ | `tripadvisor.place` | `litescrape.api.tripadvisor.place` | `read` | Get Tripadvisor place details by place ID |
207
+ | `tripadvisor.reviews` | `litescrape.api.tripadvisor.reviews` | `read` | Get Tripadvisor reviews sorted by recency or relevance |
208
+ | `tripadvisor.search` | `litescrape.api.tripadvisor.search` | `read` | Search Tripadvisor hotels, restaurants and attractions |
209
+ | `walmart.product` | `litescrape.api.walmart.product` | `read` | Get a Walmart product's details, price and availability (Alpha) |
210
+ | `walmart.search` | `litescrape.api.walmart.search` | `read` | Search Walmart products with prices and availability (Alpha) |
211
+ | `wayfair.product` | `litescrape.api.wayfair.product` | `read` | Get a Wayfair product's details, price and availability (Alpha) |
212
+ | `wayfair.search` | `litescrape.api.wayfair.search` | `read` | Search Wayfair products with prices and availability (Alpha) |
48
213
  | `web.fetch` | `litescrape.api.web.fetch` | `read` | Render a public web page and return it as Markdown, HTML or text (Alpha) |
49
214
  | `web.screenshot` | `litescrape.api.web.screenshot` | `read` | Capture a web page screenshot as a PNG download URL (Alpha) |
50
- | `keys.status` | `litescrape.api.keys.status` | `read` | Get LiteScrape key status, remaining calls and concurrency limit |
215
+ | `wholefoods.product` | `litescrape.api.wholefoods.product` | `read` | Get a Whole Foods product's details, price and availability (Alpha) |
216
+ | `wholefoods.search` | `litescrape.api.wholefoods.search` | `read` | Search Whole Foods products with prices and availability (Alpha) |
217
+ | `wikipedia.article` | `litescrape.api.wikipedia.article` | `read` | Get the text of a Wikipedia article in a selected language |
218
+ | `wikipedia.search` | `litescrape.api.wikipedia.search` | `read` | Search Wikipedia articles in a selected language |
219
+ | `workday.jobs` | `litescrape.api.workday.jobs` | `read` | Search an employer's Workday career board with result totals and pagination |
220
+ | `x.community` | `litescrape.api.x.community` | `read` | Get X community details, including its creator, member count and rules (Alpha) |
221
+ | `x.communityPosts` | `litescrape.api.x.communityPosts` | `read` | Get posts from an X community, including authors, engagement and media (Alpha) |
222
+ | `x.post` | `litescrape.api.x.post` | `read` | Get an X post with its text, author, engagement counts and media (Alpha) |
223
+ | `x.profile` | `litescrape.api.x.profile` | `read` | Get a public X profile, including its bio, follower counts and profile images (Alpha) |
224
+ | `x.userPosts` | `litescrape.api.x.userPosts` | `read` | Get posts from an X user (Alpha) |
225
+ | `yahoo.financeHistory` | `litescrape.api.yahoo.financeHistory` | `read` | Read daily, weekly, or monthly prices and volume for a market symbol |
226
+ | `yahoo.images` | `litescrape.api.yahoo.images` | `read` | Search Yahoo Images |
227
+ | `yahoo.search` | `litescrape.api.yahoo.search` | `read` | Get Yahoo web search results |
228
+ | `yandex.images` | `litescrape.api.yandex.images` | `read` | Search Yandex Images, including reverse image search |
229
+ | `yandex.search` | `litescrape.api.yandex.search` | `read` | Get Yandex web search results |
230
+ | `yelp.place` | `litescrape.api.yelp.place` | `read` | Get a Yelp business's details and menu |
231
+ | `yelp.reviews` | `litescrape.api.yelp.reviews` | `read` | Get Yelp reviews with rating, text, reviewer and owner replies |
232
+ | `yelp.search` | `litescrape.api.yelp.search` | `read` | Search Yelp businesses with rating, reviews, categories and filters |
233
+ | `youtube.channel` | `litescrape.api.youtube.channel` | `read` | Get a YouTube channel's profile, videos, Shorts, playlists and posts |
234
+ | `youtube.comments` | `litescrape.api.youtube.comments` | `read` | Read public YouTube video comments with pagination |
235
+ | `youtube.search` | `litescrape.api.youtube.search` | `read` | Search YouTube videos, channels, playlists and Shorts |
236
+ | `youtube.video` | `litescrape.api.youtube.video` | `read` | Get a public YouTube video title, description, channel, and view count |
237
+ | `zillow.locations` | `litescrape.api.zillow.locations` | `read` | Get Zillow region and address suggestions |
238
+ | `zillow.property` | `litescrape.api.zillow.property` | `read` | Get a Zillow property by ID or URL |
239
+ | `zillow.search` | `litescrape.api.zillow.search` | `read` | Search Zillow homes for sale, for rent or recently sold |
240
+ | `ziprecruiter.search` | `litescrape.api.ziprecruiter.search` | `read` | Search ZipRecruiter jobs in the US and Canada by keyword and location |
51
241
 
52
242
  ## Auth
53
243
 
54
- Auth: API key. Send it as `Authorization: Bearer <key>`. Corsair prompts your
55
- tenant for credentials on first use.
244
+ Auth: API key. Corsair prompts your tenant for credentials on first use.
56
245
 
57
246
  ## Webhooks
58
247
 
59
- No webhooks. LiteScrape is request/response only and publishes no inbound event
60
- verification spec.
248
+ No webhooks.
61
249
 
62
250
  ## Reference
63
251
 
package/dist/client.d.ts CHANGED
@@ -14,14 +14,18 @@ export declare class LitescrapeAPIError extends Error {
14
14
  */
15
15
  export declare function tryGetStoredKey(getter: () => Promise<string | null | undefined>): Promise<string | undefined>;
16
16
  /**
17
- * LiteScrape REST gateway. Every endpoint is a `GET` under `/api` and takes
17
+ * LiteScrape REST gateway. Every data endpoint takes a `GET` query or a JSON `POST` body under `/api` and takes
18
18
  * `Authorization: Bearer <key>` (keys look like `ls_live_...`). Reference:
19
19
  * https://litescrape.com/docs/reference and https://litescrape.com/docs.
20
20
  */
21
21
  export declare const LITESCRAPE_API_BASE = "https://api.litescrape.com";
22
+ /** The longest `timeout` the API accepts, in seconds. */
23
+ export declare const LITESCRAPE_MAX_BUDGET_SECONDS = 90;
22
24
  export declare function makeLitescrapeRequest<T>(endpoint: string, apiKey: string, options?: {
23
25
  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
24
26
  body?: Record<string, unknown>;
25
27
  query?: Record<string, string | number | boolean | undefined>;
28
+ /** Litescrape's own budget for the call, in seconds (the `timeout` query field). */
29
+ budgetSeconds?: number;
26
30
  }): Promise<T>;
27
31
  //# sourceMappingURL=client.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAQA,qBAAa,kBAAmB,SAAQ,KAAK;aAG3B,IAAI,CAAC,EAAE,MAAM;gBAD7B,OAAO,EAAE,MAAM,EACC,IAAI,CAAC,EAAE,MAAM,YAAA;CAK9B;AASD;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CACpC,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,GAC9C,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAU7B;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,+BAA+B,CAAC;AAsBhE,wBAAsB,qBAAqB,CAAC,CAAC,EAC5C,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE;IACR,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;IAIrD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC;CACzD,GACJ,OAAO,CAAC,CAAC,CAAC,CA+CZ"}
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAQA,qBAAa,kBAAmB,SAAQ,KAAK;aAG3B,IAAI,CAAC,EAAE,MAAM;gBAD7B,OAAO,EAAE,MAAM,EACC,IAAI,CAAC,EAAE,MAAM,YAAA;CAK9B;AASD;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CACpC,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,GAC9C,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAU7B;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,+BAA+B,CAAC;AAEhE,yDAAyD;AACzD,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAuBhD,wBAAsB,qBAAqB,CAAC,CAAC,EAC5C,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE;IACR,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;IAKrD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC;IAC9D,oFAAoF;IACpF,aAAa,CAAC,EAAE,MAAM,CAAC;CAClB,GACJ,OAAO,CAAC,CAAC,CAAC,CA0DZ"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=docs-examples.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"docs-examples.test.d.ts","sourceRoot":"","sources":["../docs-examples.test.ts"],"names":[],"mappings":""}