@crawlora-org/sdk 1.25.0-sdk.1 → 1.27.0-sdk.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.
- package/CHANGELOG.md +12 -0
- package/README.md +2 -2
- package/docs/operations.md +20 -4
- package/docs/recipes.md +17 -0
- package/openapi/public.json +3465 -809
- package/package.json +2 -2
- package/src/client.js +1 -1
- package/src/operations.js +875 -2
- package/src/types.d.ts +645 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## v1.27.0-sdk.1
|
|
4
|
+
|
|
5
|
+
- Regenerated from the public API contract (837 to 848 operations). Adds public
|
|
6
|
+
job search and detail groups for Amazon, Apple, Google, Meta, and Tesla.
|
|
7
|
+
- Google Maps business responses now distinguish a missing `review_count`
|
|
8
|
+
(`null`) from a confirmed zero, and document locale-specific category labels.
|
|
9
|
+
|
|
10
|
+
## v1.26.0-sdk.1
|
|
11
|
+
|
|
12
|
+
- Regenerated from the public API contract (832 to 837 operations). Adds Google Play ratings, Instagram user dataset search/item/facets, and Reddit trending dataset search.
|
|
13
|
+
- Reddit post and comments operations now expose `include_metrics`. The default feed mode costs 1 credit; metrics mode makes one anonymous HTML request and costs 3 credits.
|
|
14
|
+
|
|
3
15
|
## v1.25.0-sdk.1
|
|
4
16
|
|
|
5
17
|
- Regenerated from the public API contract (836 to 832 operations). Adds Apple Podcasts chart rankings, new releases, and related shows; App Store editorial collections; and the Apple Podcasts shows dataset family. Removes the TCDB endpoints, which no longer exist upstream.
|
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Official JavaScript and TypeScript client for the public Crawlora API. Use it
|
|
4
4
|
to call Crawlora scraping, search, social, developer, marketplace, datasets,
|
|
5
|
-
reviews, media, books, maps, finance, travel, prediction-market, brand, and usage endpoints with a small `fetch`-based client and generated
|
|
5
|
+
reviews, media, books, maps, jobs, finance, travel, prediction-market, brand, and usage endpoints with a small `fetch`-based client and generated
|
|
6
6
|
TypeScript types.
|
|
7
7
|
|
|
8
8
|
- Runtime: Node.js 18+ or any modern runtime with `fetch`
|
|
@@ -26,7 +26,7 @@ npm install @crawlora-org/sdk@VERSION
|
|
|
26
26
|
|
|
27
27
|
## API Key
|
|
28
28
|
|
|
29
|
-
Create or sign in to your Crawlora account at [crawlora.net](https://crawlora.net),
|
|
29
|
+
Create or sign in to your Crawlora account at [crawlora.net](https://crawlora.net?utm_source=github&utm_medium=referral&utm_campaign=crawlora-typescript-sdk),
|
|
30
30
|
then create an API key in the dashboard.
|
|
31
31
|
|
|
32
32
|
```sh
|
package/docs/operations.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Generated from `openapi/public.json`. Deprecated, admin, and internal operations are excluded from this SDK contract.
|
|
4
4
|
|
|
5
|
-
Total operations: `
|
|
5
|
+
Total operations: `848`
|
|
6
6
|
|
|
7
7
|
| Group | SDK method | Operation ID | HTTP | Params | Auth | Response | Notes |
|
|
8
8
|
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
@@ -13,6 +13,8 @@ Total operations: `832`
|
|
|
13
13
|
| airbnb | `airbnb.roomCalendar` | `airbnb-room-calendar` | `GET /airbnb/room/{id}/calendar` | `id` (path string required) | `ApiKeyAuth` | `AirbnbRoomCalendarResponse` | |
|
|
14
14
|
| airbnb | `airbnb.roomReviews` | `airbnb-room-reviews` | `GET /airbnb/room/{id}/reviews` | `id` (path string required)<br>`page` (query number) | `ApiKeyAuth` | `AirbnbRoomReviewsResponse` | |
|
|
15
15
|
| airbnb | `airbnb.search` | `airbnb-search` | `GET /airbnb/search` | `location` (query string required)<br>`check_in` (query string)<br>`check_out` (query string)<br>`adults` (query number)<br>`page` (query number)<br>`currency` (query string)<br>`ne_lat` (query number)<br>`ne_lng` (query number)<br>`sw_lat` (query number)<br>`sw_lng` (query number)<br>`zoom` (query number) | `ApiKeyAuth` | `AirbnbSearchResponse` | |
|
|
16
|
+
| amazonJobs | `amazonJobs.job` | `amazon-jobs-job` | `GET /amazon-jobs/job` | `id` (query string required) | `ApiKeyAuth` | `AmazonJobsJobResponse` | |
|
|
17
|
+
| amazonJobs | `amazonJobs.search` | `amazon-jobs-search` | `GET /amazon-jobs/search` | `q` (query string)<br>`category` (query "administrative-support" \| "applied-science" \| "audio-video-photography-production" \| "business-intelligence-data-engineering" \| "business-merchant-development" \| "buying-planning-instock-management" \| "customer-service" \| "data-science" \| "database-administration" \| "design" \| "economics" \| "editorial-writing-content-management" \| "facilities-maintenance-real-estate" \| "fgbs" \| "fulfillment-center-warehouse-associate" \| "fulfillment-operations-management" \| "hardware-development" \| "human-resources" \| "investigation-loss-prevention" \| "leadership-development-training" \| "legal" \| "marketing" \| "medical-health-safety" \| "operations-it-support-engineering" \| "project-program-product-management-non-tech" \| "project-program-product-management-technical" \| "public-policy" \| "public-relations-communications" \| "research-science" \| "sales-advertising-account-management" \| "software-development" \| "solutions-architecture" \| "supply-chain-transportation-management" \| "systems-quality-security-engineering")<br>`country` (query string)<br>`page` (query number)<br>`limit` (query number)<br>`sort` (query "relevant" \| "recent") | `ApiKeyAuth` | `AmazonJobsSearchResponse` | |
|
|
16
18
|
| amazon | `amazon.product` | `amazon-product` | `GET /amazon/product/{asin}` | `asin` (path string required)<br>`language` (query "en_US")<br>`currency` (query "USD") | `ApiKeyAuth` | `AmazonProductResponse` | |
|
|
17
19
|
| amazon | `amazon.search` | `amazon-search` | `GET /amazon/search` | `k` (query string required)<br>`s` (query string)<br>`page` (query number) | `ApiKeyAuth` | `AmazonSearchResponse` | |
|
|
18
20
|
| amazon | `amazon.suggest` | `amazon-suggest` | `GET /amazon/suggest/{keyword}` | `keyword` (path string required) | `ApiKeyAuth` | `AmazonSuggestResponse` | |
|
|
@@ -37,6 +39,8 @@ Total operations: `832`
|
|
|
37
39
|
| appleBooks | `appleBooks.charts` | `apple-books-charts` | `GET /apple-books/charts` | `collection` (query "top-free" \| "top-paid")<br>`genre` (query number)<br>`country` (query string)<br>`limit` (query number) | `ApiKeyAuth` | `AppleBooksChartsResponse` | |
|
|
38
40
|
| appleBooks | `appleBooks.search` | `apple-books-search` | `GET /apple-books/search` | `term` (query string required)<br>`country` (query string)<br>`lang` (query string)<br>`limit` (query number)<br>`page` (query number) | `ApiKeyAuth` | `AppleBooksSearchResponse` | |
|
|
39
41
|
| appleBooks | `appleBooks.series` | `apple-books-series` | `GET /apple-books/series/{id}` | `id` (path string required)<br>`country` (query string)<br>`lang` (query string) | `ApiKeyAuth` | `AppleBooksSeriesResponse` | |
|
|
42
|
+
| appleJobs | `appleJobs.job` | `apple-jobs-job` | `GET /apple-jobs/job` | `id` (query string required) | `ApiKeyAuth` | `AppleJobsJobResponse` | |
|
|
43
|
+
| appleJobs | `appleJobs.search` | `apple-jobs-search` | `GET /apple-jobs/search` | `q` (query string required)<br>`location` (query string)<br>`page` (query number) | `ApiKeyAuth` | `AppleJobsSearchResponse` | |
|
|
40
44
|
| applePodcasts | `applePodcasts.charts` | `apple-podcasts-charts` | `GET /apple-podcasts/charts` | `collection` (query string)<br>`category` (query number)<br>`country` (query string)<br>`limit` (query number) | `ApiKeyAuth` | `ApplePodcastsChartsResponse` | |
|
|
41
45
|
| applePodcasts | `applePodcasts.chartsRankings` | `apple-podcasts-charts-rankings` | `GET /apple-podcasts/charts/rankings` | `chart` (query string)<br>`type` (query string)<br>`genre` (query number)<br>`country` (query string)<br>`limit` (query number) | `ApiKeyAuth` | `ApplePodcastsChartsRankingsResponse` | |
|
|
42
46
|
| applePodcasts | `applePodcasts.episodesSearch` | `apple-podcasts-episodes-search` | `GET /apple-podcasts/episodes/search` | `term` (query string required)<br>`country` (query string)<br>`lang` (query string)<br>`limit` (query number)<br>`page` (query number) | `ApiKeyAuth` | `ApplePodcastsEpisodesSearchResponse` | |
|
|
@@ -177,6 +181,9 @@ Total operations: `832`
|
|
|
177
181
|
| datasets | `datasets.housingMarketsFacets` | `datasets-housing-markets-facets` | `GET /datasets/housing-markets/facets` | `facet` (query "region_type" \| "state_code" \| "property_type" \| "parent_metro" \| "parent_metro_code" \| "income_vintage" \| "is_latest" \| "period_begin" required)<br>`q` (query string)<br>`region_type` (query "national" \| "metro" \| "county" \| "city" \| "zip")<br>`state_code` (query string)<br>`property_type` (query string)<br>`parent_metro_code` (query string)<br>`zip_code` (query string)<br>`period` (query string)<br>`latest` (query boolean)<br>`min_median_sale_price` (query number)<br>`max_median_sale_price` (query number)<br>`min_median_list_price` (query number)<br>`max_median_list_price` (query number)<br>`min_price_to_income` (query number)<br>`max_price_to_income` (query number)<br>`min_salary_to_buy` (query number)<br>`max_salary_to_buy` (query number)<br>`min_median_dom` (query number)<br>`max_median_dom` (query number)<br>`min_inventory` (query number)<br>`max_inventory` (query number)<br>`min_homes_sold` (query number) | `ApiKeyAuth` | `DatasetsHousingMarketsFacetsResponse` | |
|
|
178
182
|
| datasets | `datasets.housingMarketsItem` | `datasets-housing-markets-item` | `GET /datasets/housing-markets/items/{region_type}/{table_id}` | `region_type` (path "national" \| "metro" \| "county" \| "city" \| "zip" required)<br>`table_id` (path number required)<br>`period` (query string)<br>`property_type` (query string)<br>`history` (query boolean) | `ApiKeyAuth` | `DatasetsHousingMarketsItemResponse` | |
|
|
179
183
|
| datasets | `datasets.housingMarketsSearch` | `datasets-housing-markets-search` | `GET /datasets/housing-markets/search` | `q` (query string)<br>`region_type` (query "national" \| "metro" \| "county" \| "city" \| "zip")<br>`state_code` (query string)<br>`property_type` (query string)<br>`parent_metro_code` (query string)<br>`zip_code` (query string)<br>`period` (query string)<br>`latest` (query boolean)<br>`min_median_sale_price` (query number)<br>`max_median_sale_price` (query number)<br>`min_median_list_price` (query number)<br>`max_median_list_price` (query number)<br>`min_price_to_income` (query number)<br>`max_price_to_income` (query number)<br>`min_salary_to_buy` (query number)<br>`max_salary_to_buy` (query number)<br>`min_median_dom` (query number)<br>`max_median_dom` (query number)<br>`min_inventory` (query number)<br>`max_inventory` (query number)<br>`min_homes_sold` (query number)<br>`sort` (query "relevance" \| "price_desc" \| "price_asc" \| "list_price_desc" \| "list_price_asc" \| "price_to_income_desc" \| "price_to_income_asc" \| "salary_to_buy_desc" \| "salary_to_buy_asc" \| "dom_asc" \| "dom_desc" \| "inventory_desc" \| "homes_sold_desc" \| "period_desc")<br>`page` (query number)<br>`page_size` (query number) | `ApiKeyAuth` | `DatasetsHousingMarketsSearchResponse` | |
|
|
184
|
+
| datasets | `datasets.instagramUsersFacets` | `datasets-instagram-users-facets` | `GET /datasets/instagram-users/facets` | `facet` (query "is_verified" \| "is_business_account" \| "has_bio" \| "has_external_url" \| "category_name" \| "source_tier" required)<br>`q` (query string)<br>`username` (query string)<br>`category_name` (query string)<br>`source_tier` (query string)<br>`is_verified` (query boolean)<br>`is_business_account` (query boolean)<br>`has_bio` (query boolean)<br>`has_external_url` (query boolean)<br>`min_followers` (query number)<br>`max_followers` (query number)<br>`min_ratio` (query number)<br>`max_ratio` (query number)<br>`created_after` (query string)<br>`created_before` (query string)<br>`crawled_after` (query string)<br>`crawled_before` (query string)<br>`sort` (query "relevance" \| "followers_desc" \| "followers_asc" \| "crawled_at_desc" \| "crawled_at_asc" \| "created_at_desc" \| "created_at_asc")<br>`page` (query number)<br>`page_size` (query number) | `ApiKeyAuth` | `DatasetsInstagramUsersFacetsResponse` | |
|
|
185
|
+
| datasets | `datasets.instagramUsersItem` | `datasets-instagram-users-item` | `GET /datasets/instagram-users/items/{username}` | `username` (path string required) | `ApiKeyAuth` | `DatasetsInstagramUsersItemResponse` | |
|
|
186
|
+
| datasets | `datasets.instagramUsersSearch` | `datasets-instagram-users-search` | `GET /datasets/instagram-users/search` | `q` (query string)<br>`username` (query string)<br>`category_name` (query string)<br>`source_tier` (query string)<br>`is_verified` (query boolean)<br>`is_business_account` (query boolean)<br>`has_bio` (query boolean)<br>`has_external_url` (query boolean)<br>`min_followers` (query number)<br>`max_followers` (query number)<br>`min_ratio` (query number)<br>`max_ratio` (query number)<br>`created_after` (query string)<br>`created_before` (query string)<br>`crawled_after` (query string)<br>`crawled_before` (query string)<br>`sort` (query "relevance" \| "followers_desc" \| "followers_asc" \| "crawled_at_desc" \| "crawled_at_asc" \| "created_at_desc" \| "created_at_asc")<br>`page` (query number)<br>`page_size` (query number) | `ApiKeyAuth` | `DatasetsInstagramUsersSearchResponse` | |
|
|
180
187
|
| datasets | `datasets.jobsCompanies` | `datasets-jobs-companies` | `GET /datasets/jobs/companies` | `q` (query string)<br>`provider` (query "greenhouse" \| "lever" \| "ashby" \| "workday" \| "smartrecruiters" \| "workable" \| "recruitee" \| "rippling" \| "personio" \| "teamtailor" \| "oracle" \| "ukg" \| "icims" \| "eightfold" \| "gem" \| "pinpoint")<br>`status` (query "active" \| "empty" \| "gone" \| "blocked" \| "pending" \| "invalid")<br>`min_open_roles` (query number)<br>`sort` (query "open_desc" \| "company_asc" \| "crawled_desc")<br>`page` (query number)<br>`page_size` (query number) | `ApiKeyAuth` | `DatasetsJobsCompaniesResponse` | |
|
|
181
188
|
| datasets | `datasets.jobsCompanyItem` | `datasets-jobs-company-item` | `GET /datasets/jobs/companies/{id}` | `id` (path string required) | `ApiKeyAuth` | `DatasetsJobsCompanyItemResponse` | |
|
|
182
189
|
| datasets | `datasets.jobsFacets` | `datasets-jobs-facets` | `GET /datasets/jobs/facets` | `size` (query number) | `ApiKeyAuth` | `DatasetsJobsFacetsResponse` | |
|
|
@@ -217,6 +224,7 @@ Total operations: `832`
|
|
|
217
224
|
| datasets | `datasets.producthuntProductsSearch` | `datasets-producthunt-products-search` | `GET /datasets/producthunt-products/search` | `q` (query string)<br>`topic` (query string)<br>`maker` (query string)<br>`launched_after` (query string)<br>`launched_before` (query string)<br>`min_votes` (query number)<br>`min_rating` (query number)<br>`pricing_type` (query string)<br>`has_website` (query boolean)<br>`is_online` (query boolean)<br>`sort` (query "relevance" \| "votes_desc" \| "launched_desc" \| "launched_asc" \| "rating_desc" \| "best_rank_asc")<br>`page` (query number)<br>`page_size` (query number) | `ApiKeyAuth` | `DatasetsProducthuntProductsSearchResponse` | |
|
|
218
225
|
| datasets | `datasets.producthuntTrendsFacets` | `datasets-producthunt-trends-facets` | `GET /datasets/producthunt-trends/facets` | `facet` (query "topic" \| "launch_year" required)<br>`group_by` (query "topic_month" \| "topic_year" \| "topic")<br>`topic` (query string)<br>`launched_after` (query string)<br>`launched_before` (query string)<br>`min_votes` (query number)<br>`min_launches` (query number) | `ApiKeyAuth` | `DatasetsProducthuntTrendsFacetsResponse` | |
|
|
219
226
|
| datasets | `datasets.producthuntTrendsSearch` | `datasets-producthunt-trends-search` | `GET /datasets/producthunt-trends/search` | `group_by` (query "topic_month" \| "topic_year" \| "topic")<br>`topic` (query string)<br>`launched_after` (query string)<br>`launched_before` (query string)<br>`min_votes` (query number)<br>`min_launches` (query number)<br>`sort` (query "period_desc" \| "period_asc" \| "launch_count_desc" \| "sum_votes_desc")<br>`page` (query number)<br>`page_size` (query number) | `ApiKeyAuth` | `DatasetsProducthuntTrendsSearchResponse` | |
|
|
227
|
+
| datasets | `datasets.redditTrendingSearch` | `datasets-reddit-trending-search` | `GET /datasets/reddit-trending/search` | `q` (query string)<br>`subreddit` (query string)<br>`date` (query string)<br>`sort` (query "rank" \| "date_desc")<br>`page` (query number)<br>`page_size` (query number) | `ApiKeyAuth` | `DatasetsRedditTrendingSearchResponse` | |
|
|
220
228
|
| datasets | `datasets.secCompaniesFacets` | `datasets-sec-companies-facets` | `GET /datasets/sec-companies/facets` | `facet` (query "sic" \| "sic_description" \| "exchange" \| "state_of_incorporation" \| "entity_type" \| "reporting_currency" \| "revenue_band" \| "forms_filed" required)<br>`q` (query string)<br>`ticker` (query string)<br>`sic` (query string)<br>`exchange` (query string)<br>`state_of_incorporation` (query string)<br>`entity_type` (query string)<br>`reporting_currency` (query string)<br>`has_financials` (query boolean)<br>`min_revenue` (query number)<br>`form_filed` (query string) | `ApiKeyAuth` | `DatasetsSecCompaniesFacetsResponse` | |
|
|
221
229
|
| datasets | `datasets.secCompaniesFinancials` | `datasets-sec-companies-financials` | `GET /datasets/sec-companies/financials/{cik}` | `cik` (path string required)<br>`statement` (query "income" \| "balance" \| "cash_flow")<br>`period` (query "annual" \| "quarterly")<br>`from` (query number)<br>`to` (query number)<br>`limit` (query number) | `ApiKeyAuth` | `DatasetsSecCompaniesFinancialsResponse` | |
|
|
222
230
|
| datasets | `datasets.secCompaniesInsider` | `datasets-sec-companies-insider` | `GET /datasets/sec-companies/insider/{cik}` | `cik` (path string required)<br>`from` (query string)<br>`to` (query string)<br>`code` (query string)<br>`limit` (query number) | `ApiKeyAuth` | `DatasetsSecCompaniesInsiderResponse` | |
|
|
@@ -295,6 +303,8 @@ Total operations: `832`
|
|
|
295
303
|
| goodreads | `goodreads.list` | `goodreads-list` | `GET /goodreads/list/{id}` | `id` (path string required)<br>`page` (query number) | `ApiKeyAuth` | `GoodreadsListResponse` | |
|
|
296
304
|
| goodreads | `goodreads.lists` | `goodreads-lists` | `GET /goodreads/lists` | none | `ApiKeyAuth` | `GoodreadsListsResponse` | |
|
|
297
305
|
| goodreads | `goodreads.search` | `goodreads-search` | `GET /goodreads/search` | `q` (query string required)<br>`limit` (query number) | `ApiKeyAuth` | `GoodreadsSearchResponse` | |
|
|
306
|
+
| googleJobs | `googleJobs.job` | `google-jobs-job` | `GET /google-jobs/job` | `id` (query string required) | `ApiKeyAuth` | `GoogleJobsJobResponse` | |
|
|
307
|
+
| googleJobs | `googleJobs.search` | `google-jobs-search` | `GET /google-jobs/search` | `q` (query string required)<br>`location` (query string)<br>`page` (query number) | `ApiKeyAuth` | `GoogleJobsSearchResponse` | |
|
|
298
308
|
| google | `google.financeAnalystArticles` | `google-finance-analyst-articles` | `GET /google/finance/analyst-articles/{quote}` | `quote` (path string required) | `ApiKeyAuth` | `GoogleFinanceAnalystArticlesResponse` | |
|
|
299
309
|
| google | `google.financeChart` | `google-finance-chart` | `GET /google/finance/chart/{quote}` | `quote` (path string required)<br>`window` (query string) | `ApiKeyAuth` | `GoogleFinanceChartResponse` | |
|
|
300
310
|
| google | `google.financeClassification` | `google-finance-classification` | `GET /google/finance/classification/{quote}` | `quote` (path string required) | `ApiKeyAuth` | `GoogleFinanceClassificationResponse` | |
|
|
@@ -339,8 +349,9 @@ Total operations: `832`
|
|
|
339
349
|
| googlePlay | `googlePlay.categories` | `googleplay-categories` | `GET /googleplay/categories` | `country` (query string)<br>`lang` (query string) | `ApiKeyAuth` | `GooglePlayCategoriesResponse` | |
|
|
340
350
|
| googlePlay | `googlePlay.datasafety` | `googleplay-datasafety` | `GET /googleplay/datasafety` | `app_id` (query string required)<br>`lang` (query string) | `ApiKeyAuth` | `GooglePlayDatasafetyResponse` | |
|
|
341
351
|
| googlePlay | `googlePlay.developer` | `googleplay-developer` | `GET /googleplay/developer/{dev_id}` | `dev_id` (path string required)<br>`num` (query number)<br>`country` (query string)<br>`lang` (query string)<br>`full_detail` (query boolean) | `ApiKeyAuth` | `GooglePlayDeveloperResponse` | |
|
|
342
|
-
| googlePlay | `googlePlay.list` | `googleplay-list` | `GET /googleplay/list` | `collection` (query "TOP_FREE" \| "TOP_PAID" \| "GROSSING" \| "NEW_FREE" \| "NEW_PAID")<br>`category` (query string)<br>`age` (query string)<br>`num` (query number)<br>`country` (query string)<br>`lang` (query string)<br>`full_detail` (query boolean) | `ApiKeyAuth` | `GooglePlayListResponse` | |
|
|
352
|
+
| googlePlay | `googlePlay.list` | `googleplay-list` | `GET /googleplay/list` | `collection` (query "TOP_FREE" \| "TOP_PAID" \| "GROSSING" \| "NEW_FREE" \| "NEW_PAID")<br>`category` (query string)<br>`device` (query "phone" \| "tablet" \| "tv" \| "chromebook" \| "watch" \| "xr" \| "car")<br>`age` (query string)<br>`num` (query number)<br>`country` (query string)<br>`lang` (query string)<br>`full_detail` (query boolean) | `ApiKeyAuth` | `GooglePlayListResponse` | |
|
|
343
353
|
| googlePlay | `googlePlay.permissions` | `googleplay-permissions` | `GET /googleplay/permissions` | `app_id` (query string required)<br>`country` (query string)<br>`lang` (query string)<br>`short` (query boolean) | `ApiKeyAuth` | `GooglePlayPermissionsResponse` | |
|
|
354
|
+
| googlePlay | `googlePlay.ratings` | `googleplay-ratings` | `GET /googleplay/ratings` | `app_id` (query string required)<br>`country` (query string)<br>`lang` (query string) | `ApiKeyAuth` | `GooglePlayRatingsResponse` | |
|
|
344
355
|
| googlePlay | `googlePlay.reviews` | `googleplay-reviews` | `GET /googleplay/reviews` | `app_id` (query string required)<br>`sort` (query "helpfulness" \| "newest" \| "rating")<br>`num` (query number)<br>`country` (query string)<br>`lang` (query string)<br>`paginate` (query boolean)<br>`next_pagination_token` (query string) | `ApiKeyAuth` | `GooglePlayReviewsResponse` | |
|
|
345
356
|
| googlePlay | `googlePlay.search` | `googleplay-search` | `GET /googleplay/search` | `term` (query string required)<br>`num` (query number)<br>`country` (query string)<br>`lang` (query string)<br>`full_detail` (query boolean)<br>`price` (query "all" \| "free" \| "paid") | `ApiKeyAuth` | `GooglePlaySearchResponse` | |
|
|
346
357
|
| googlePlay | `googlePlay.similar` | `googleplay-similar` | `GET /googleplay/similar` | `app_id` (query string required)<br>`num` (query number)<br>`country` (query string)<br>`lang` (query string)<br>`full_detail` (query boolean) | `ApiKeyAuth` | `GooglePlaySimilarResponse` | |
|
|
@@ -451,6 +462,9 @@ Total operations: `832`
|
|
|
451
462
|
| manga | `manga.rankings` | `manga-rankings` | `GET /manga/rankings` | `sort` (query "TRENDING_DESC" \| "POPULARITY_DESC" \| "SCORE_DESC" \| "FAVOURITES_DESC" \| "START_DATE_DESC" \| "UPDATED_AT_DESC")<br>`format` (query "MANGA" \| "NOVEL" \| "ONE_SHOT")<br>`genre` (query string)<br>`status` (query "FINISHED" \| "RELEASING" \| "NOT_YET_RELEASED" \| "CANCELLED" \| "HIATUS")<br>`page` (query number)<br>`per_page` (query number) | `ApiKeyAuth` | `MangaRankingsResponse` | |
|
|
452
463
|
| manga | `manga.search` | `manga-search` | `GET /manga/search` | `query` (query string required)<br>`sort` (query "SEARCH_MATCH" \| "POPULARITY_DESC" \| "SCORE_DESC" \| "TRENDING_DESC" \| "FAVOURITES_DESC" \| "START_DATE_DESC")<br>`page` (query number)<br>`per_page` (query number) | `ApiKeyAuth` | `MangaSearchResponse` | |
|
|
453
464
|
| manga | `manga.title` | `manga-title` | `GET /manga/title/{id}` | `id` (path string required)<br>`mal` (query boolean) | `ApiKeyAuth` | `MangaTitleResponse` | |
|
|
465
|
+
| metaJobs | `metaJobs.job` | `meta-jobs-job` | `GET /meta-jobs/job` | `id` (query string required) | `ApiKeyAuth` | `MetaJobsJobResponse` | |
|
|
466
|
+
| metaJobs | `metaJobs.list` | `meta-jobs-list` | `GET /meta-jobs/list` | `page` (query number)<br>`page_size` (query number) | `ApiKeyAuth` | `MetaJobsListResponse` | |
|
|
467
|
+
| metaJobs | `metaJobs.search` | `meta-jobs-search` | `GET /meta-jobs/search` | `q` (query string)<br>`teams` (query Array<string>)<br>`roles` (query Array<string>)<br>`offices` (query Array<string>)<br>`is_remote_only` (query boolean)<br>`sort_by_new` (query boolean)<br>`results_per_page` (query "all" \| "five" \| "ten") | `ApiKeyAuth` | `MetaJobsSearchResponse` | |
|
|
454
468
|
| metacritic | `metacritic.browse` | `metacritic-browse` | `GET /metacritic/browse` | `type` (query "game" \| "movie" \| "tv" required)<br>`genre` (query string)<br>`sort` (query "score" \| "popularity" \| "release_date" \| "oldest")<br>`page` (query number)<br>`per_page` (query number) | `ApiKeyAuth` | `MetacriticBrowseResponse` | |
|
|
455
469
|
| metacritic | `metacritic.game` | `metacritic-game` | `GET /metacritic/game/{slug}` | `slug` (path string required) | `ApiKeyAuth` | `MetacriticGameResponse` | |
|
|
456
470
|
| metacritic | `metacritic.gameCriticReviews` | `metacritic-game-critic-reviews` | `GET /metacritic/game/{slug}/critic-reviews` | `slug` (path string required)<br>`page` (query number)<br>`per_page` (query number)<br>`sort` (query "date" \| "score" \| "publication") | `ApiKeyAuth` | `MetacriticGameCriticReviewsResponse` | |
|
|
@@ -571,9 +585,9 @@ Total operations: `832`
|
|
|
571
585
|
| productHunt | `productHunt.makers` | `producthunt-makers` | `GET /producthunt/product/{id}/makers` | `id` (path string required)<br>`cursor` (query string) | `ApiKeyAuth` | `ProductHuntMakersResponse` | |
|
|
572
586
|
| productHunt | `productHunt.reviews` | `producthunt-reviews` | `GET /producthunt/product/{id}/reviews` | `id` (path string required) | `ApiKeyAuth` | `ProductHuntReviewsResponse` | |
|
|
573
587
|
| productHunt | `productHunt.search` | `producthunt-search` | `GET /producthunt/search` | `query` (query string required)<br>`type` (query "product" \| "user" \| "launch")<br>`page` (query number)<br>`featured` (query boolean)<br>`topics` (query string) | `ApiKeyAuth` | `ProductHuntSearchResponse` | |
|
|
574
|
-
| reddit | `reddit.comments` | `reddit-comments` | `GET /reddit/comments/{id}` | `id` (path string required)<br>`sort` (query "confidence" \| "top" \| "new" \| "controversial" \| "old" \| "qa")<br>`limit` (query number)<br>`depth` (query number) | `ApiKeyAuth` | `RedditCommentsResponse` | |
|
|
588
|
+
| reddit | `reddit.comments` | `reddit-comments` | `GET /reddit/comments/{id}` | `id` (path string required)<br>`sort` (query "confidence" \| "top" \| "new" \| "controversial" \| "old" \| "qa")<br>`limit` (query number)<br>`depth` (query number)<br>`include_metrics` (query boolean) | `ApiKeyAuth` | `RedditCommentsResponse` | |
|
|
575
589
|
| reddit | `reddit.domainPosts` | `reddit-domain-posts` | `GET /reddit/domain/{domain}/posts` | `domain` (path string required)<br>`sort` (query "hot" \| "new" \| "top" \| "rising")<br>`time` (query "hour" \| "day" \| "week" \| "month" \| "year" \| "all")<br>`limit` (query number)<br>`after` (query string) | `ApiKeyAuth` | `RedditDomainPostsResponse` | |
|
|
576
|
-
| reddit | `reddit.post` | `reddit-post` | `GET /reddit/post/{id}` | `id` (path string required) | `ApiKeyAuth` | `RedditPostResponse` | |
|
|
590
|
+
| reddit | `reddit.post` | `reddit-post` | `GET /reddit/post/{id}` | `id` (path string required)<br>`include_metrics` (query boolean) | `ApiKeyAuth` | `RedditPostResponse` | |
|
|
577
591
|
| reddit | `reddit.search` | `reddit-search` | `GET /reddit/search` | `q` (query string required)<br>`subreddit` (query string)<br>`sort` (query "relevance" \| "hot" \| "new" \| "top" \| "comments")<br>`time` (query "hour" \| "day" \| "week" \| "month" \| "year" \| "all")<br>`limit` (query number)<br>`after` (query string) | `ApiKeyAuth` | `RedditSearchResponse` | |
|
|
578
592
|
| reddit | `reddit.subredditAbout` | `reddit-subreddit-about` | `GET /reddit/subreddit/{subreddit}/about` | `subreddit` (path string required)<br>`limit` (query number) | `ApiKeyAuth` | `RedditSubredditAboutResponse` | |
|
|
579
593
|
| reddit | `reddit.subredditComments` | `reddit-subreddit-comments` | `GET /reddit/subreddit/{subreddit}/comments` | `subreddit` (path string required)<br>`limit` (query number)<br>`after` (query string) | `ApiKeyAuth` | `RedditSubredditCommentsResponse` | |
|
|
@@ -712,6 +726,8 @@ Total operations: `832`
|
|
|
712
726
|
| steam | `steam.tags` | `steam-tags` | `GET /steam/tags` | `tags` (query string)<br>`untags` (query string)<br>`category1` (query string)<br>`category2` (query string)<br>`category3` (query string)<br>`os` (query string)<br>`maxprice` (query string)<br>`specials` (query boolean)<br>`hidef2p` (query boolean)<br>`deck_compatibility` (query "1" \| "2" \| "3")<br>`vrsupport` (query string)<br>`filter` (query "globaltopsellers" \| "topsellers" \| "popularnew" \| "comingsoon")<br>`supportedlang` (query string)<br>`sort_by` (query "Relevance" \| "Released_DESC" \| "Name_ASC" \| "Price_ASC" \| "Price_DESC" \| "Reviews_DESC")<br>`start` (query number)<br>`count` (query number)<br>`cc` (query string)<br>`l` (query string) | `ApiKeyAuth` | `SteamTagsResponse` | |
|
|
713
727
|
| steam | `steam.tagsList` | `steam-tags-list` | `GET /steam/tags/list` | `l` (query string) | `ApiKeyAuth` | `SteamTagsListResponse` | |
|
|
714
728
|
| steam | `steam.topSellers` | `steam-top-sellers` | `GET /steam/top-sellers` | `cc` (query string)<br>`l` (query string) | `ApiKeyAuth` | `SteamTopSellersResponse` | |
|
|
729
|
+
| teslaJobs | `teslaJobs.job` | `tesla-jobs-job` | `GET /tesla-jobs/job` | `id` (query string required) | `ApiKeyAuth` | `TeslaJobsJobResponse` | |
|
|
730
|
+
| teslaJobs | `teslaJobs.list` | `tesla-jobs-list` | `GET /tesla-jobs/list` | `query` (query string)<br>`location` (query string)<br>`page` (query number)<br>`page_size` (query number) | `ApiKeyAuth` | `TeslaJobsListResponse` | |
|
|
715
731
|
| threads | `threads.post` | `threads-post` | `GET /threads/post/{username}/{code}` | `username` (path string required)<br>`code` (path string required) | `ApiKeyAuth` | `ThreadsPostResponse` | |
|
|
716
732
|
| threads | `threads.postReplies` | `threads-post-replies` | `GET /threads/post/{username}/{code}/replies` | `username` (path string required)<br>`code` (path string required) | `ApiKeyAuth` | `ThreadsPostRepliesResponse` | |
|
|
717
733
|
| threads | `threads.profile` | `threads-profile` | `GET /threads/profile/{username}` | `username` (path string required) | `ApiKeyAuth` | `ThreadsProfileResponse` | |
|
package/docs/recipes.md
CHANGED
|
@@ -36,9 +36,26 @@ Newer platforms are grouped like every other endpoint:
|
|
|
36
36
|
|
|
37
37
|
```ts
|
|
38
38
|
const posts = await crawlora.reddit.search({ q: "typescript", subreddit: "programming" });
|
|
39
|
+
const postWithMetrics = await crawlora.reddit.post({ id: "1v8hy3q", include_metrics: true });
|
|
40
|
+
const commentsWithMetrics = await crawlora.reddit.comments({ id: "1v8hy3q", include_metrics: true, limit: 25 });
|
|
39
41
|
const brand = await crawlora.brand.retrieve({ domain: "stripe.com" });
|
|
40
42
|
```
|
|
41
43
|
|
|
44
|
+
Omit `include_metrics` for the 1-credit feed mode. Set it to `true` for the
|
|
45
|
+
3-credit anonymous HTML mode with public post and comment engagement metrics.
|
|
46
|
+
|
|
47
|
+
## Company Job Searches
|
|
48
|
+
|
|
49
|
+
Search public job listings directly from employer career sites:
|
|
50
|
+
|
|
51
|
+
```ts
|
|
52
|
+
const amazon = await crawlora.amazonJobs.search({ q: "software engineer", country: "US" });
|
|
53
|
+
const apple = await crawlora.appleJobs.search({ q: "machine learning", location: "United States" });
|
|
54
|
+
const google = await crawlora.googleJobs.search({ q: "data scientist", location: "Singapore" });
|
|
55
|
+
const meta = await crawlora.metaJobs.search({ q: "product manager", is_remote_only: true });
|
|
56
|
+
const tesla = await crawlora.teslaJobs.list({ query: "manufacturing", location: "Texas" });
|
|
57
|
+
```
|
|
58
|
+
|
|
42
59
|
## Threads Public Lookups
|
|
43
60
|
|
|
44
61
|
```ts
|