@crawlora-org/sdk 1.5.0-sdk.2 → 1.6.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 CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## v1.6.0-sdk.1
4
+
5
+ - Added the **Reddit** platform (`reddit.search`, `reddit.post`,
6
+ `reddit.comments`, `reddit.subredditPosts`) and the **Brand** platform
7
+ (`brand.retrieve`), plus Yahoo Finance `yahooFinance.lookup`. Regenerated from
8
+ the public API contract.
9
+
3
10
  ## v1.5.0-sdk.1
4
11
 
5
12
  - Added `beforeRequest`/`afterResponse` middleware hooks (mutate the outgoing
package/README.md CHANGED
@@ -1,8 +1,9 @@
1
1
  # Crawlora JavaScript SDK
2
2
 
3
3
  Official JavaScript and TypeScript client for the public Crawlora API. Use it
4
- to call Crawlora scraping, search, marketplace, media, maps, finance, and usage
5
- endpoints with a small `fetch`-based client and generated TypeScript types.
4
+ to call Crawlora scraping, search, social, marketplace, media, maps, finance,
5
+ brand, and usage endpoints with a small `fetch`-based client and generated
6
+ TypeScript types.
6
7
 
7
8
  - Runtime: Node.js 18+ or any modern runtime with `fetch`
8
9
  - Auth: `x-api-key`
@@ -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: `330`
5
+ Total operations: `336`
6
6
 
7
7
  | Group | SDK method | Operation ID | HTTP | Params | Auth | Response | Notes |
8
8
  | --- | --- | --- | --- | --- | --- | --- | --- |
@@ -41,6 +41,7 @@ Total operations: `330`
41
41
  | bing | `bing.search` | `bing-search` | `GET /bing/search` | `q` (query string required)<br>`page` (query number)<br>`count` (query number)<br>`country` (query string)<br>`lang` (query string) | `ApiKeyAuth` | `BingSearchResponse` | |
42
42
  | bing | `bing.suggest` | `bing-suggest` | `GET /bing/suggest` | `q` (query string required)<br>`count` (query number)<br>`country` (query string)<br>`lang` (query string) | `ApiKeyAuth` | `BingSuggestResponse` | |
43
43
  | bing | `bing.videos` | `bing-videos` | `GET /bing/videos` | `q` (query string required)<br>`page` (query number)<br>`count` (query number)<br>`country` (query string)<br>`lang` (query string) | `ApiKeyAuth` | `BingVideosResponse` | |
44
+ | brand | `brand.retrieve` | `brand-retrieve` | `GET /brand/retrieve` | `domain` (query string required)<br>`force_language` (query string)<br>`maxSpeed` (query boolean)<br>`maxAgeMs` (query number)<br>`timeoutMS` (query number) | `ApiKeyAuth` | `BrandRetrieveResponse` | |
44
45
  | brave | `brave.images` | `brave-images` | `GET /brave/images` | `q` (query string required)<br>`offset` (query number)<br>`count` (query number)<br>`country` (query "all" \| "ar" \| "at" \| "au" \| "be" \| "br" \| "ca" \| "ch" \| "cl" \| "cn" \| "de" \| "dk" \| "es" \| "fi" \| "fr" \| "gb" \| "gr" \| "hk" \| "id" \| "in" \| "it" \| "jp" \| "kr" \| "mx" \| "my" \| "nl" \| "no" \| "nz" \| "ph" \| "pl" \| "pt" \| "ru" \| "sa" \| "se" \| "sg" \| "tr" \| "tw" \| "us" \| "za")<br>`lang` (query "de-de" \| "en-ca" \| "en-gb" \| "en-in" \| "en-us" \| "fi-fi" \| "fr-ca" \| "fr-fr" \| "ja-jp" \| "pt-br" \| "sq-al" \| "sw-ke" \| "zh-tw") | `ApiKeyAuth` | `BraveImagesResponse` | |
45
46
  | brave | `brave.news` | `brave-news` | `GET /brave/news` | `q` (query string required)<br>`offset` (query number)<br>`count` (query number)<br>`country` (query "all" \| "ar" \| "at" \| "au" \| "be" \| "br" \| "ca" \| "ch" \| "cl" \| "cn" \| "de" \| "dk" \| "es" \| "fi" \| "fr" \| "gb" \| "gr" \| "hk" \| "id" \| "in" \| "it" \| "jp" \| "kr" \| "mx" \| "my" \| "nl" \| "no" \| "nz" \| "ph" \| "pl" \| "pt" \| "ru" \| "sa" \| "se" \| "sg" \| "tr" \| "tw" \| "us" \| "za")<br>`lang` (query "de-de" \| "en-ca" \| "en-gb" \| "en-in" \| "en-us" \| "fi-fi" \| "fr-ca" \| "fr-fr" \| "ja-jp" \| "pt-br" \| "sq-al" \| "sw-ke" \| "zh-tw")<br>`time_range` (query "any" \| "day" \| "week" \| "month" \| "year" \| "custom")<br>`date_from` (query string)<br>`date_to` (query string) | `ApiKeyAuth` | `BraveNewsResponse` | |
46
47
  | brave | `brave.search` | `brave-search` | `GET /brave/search` | `q` (query string required)<br>`offset` (query number)<br>`country` (query "all" \| "ar" \| "at" \| "au" \| "be" \| "br" \| "ca" \| "ch" \| "cl" \| "cn" \| "de" \| "dk" \| "es" \| "fi" \| "fr" \| "gb" \| "gr" \| "hk" \| "id" \| "in" \| "it" \| "jp" \| "kr" \| "mx" \| "my" \| "nl" \| "no" \| "nz" \| "ph" \| "pl" \| "pt" \| "ru" \| "sa" \| "se" \| "sg" \| "tr" \| "tw" \| "us" \| "za")<br>`lang` (query "de-de" \| "en-ca" \| "en-gb" \| "en-in" \| "en-us" \| "fi-fi" \| "fr-ca" \| "fr-fr" \| "ja-jp" \| "pt-br" \| "sq-al" \| "sw-ke" \| "zh-tw")<br>`time_range` (query "any" \| "day" \| "week" \| "month" \| "year" \| "custom")<br>`date_from` (query string)<br>`date_to` (query string) | `ApiKeyAuth` | `BraveSearchResponse` | |
@@ -167,6 +168,10 @@ Total operations: `330`
167
168
  | productHunt | `productHunt.makers` | `producthunt-makers` | `GET /producthunt/product/{id}/makers` | `id` (path string required)<br>`cursor` (query string) | `ApiKeyAuth` | `ProductHuntMakersResponse` | |
168
169
  | productHunt | `productHunt.reviews` | `producthunt-reviews` | `GET /producthunt/product/{id}/reviews` | `id` (path string required) | `ApiKeyAuth` | `ProductHuntReviewsResponse` | |
169
170
  | 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` | |
171
+ | 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` | |
172
+ | reddit | `reddit.post` | `reddit-post` | `GET /reddit/post/{id}` | `id` (path string required) | `ApiKeyAuth` | `RedditPostResponse` | |
173
+ | 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` | |
174
+ | reddit | `reddit.subredditPosts` | `reddit-subreddit-posts` | `GET /reddit/subreddit/{subreddit}/posts` | `subreddit` (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` | `RedditSubredditPostsResponse` | |
170
175
  | referrals | `referrals.click` | `referrals-click` | `POST /referrals/click` | `request` (body string required) | none | `ReferralsClickResponse` | |
171
176
  | referrals | `referrals.me` | `referrals-me` | `GET /referrals/me` | none | `JWTAuth` | `ReferralsMeResponse` | |
172
177
  | referrals | `referrals.meEvents` | `referrals-me-events` | `GET /referrals/me/events` | `limit` (query number) | `JWTAuth` | `ReferralsMeEventsResponse` | |
@@ -274,10 +279,10 @@ Total operations: `330`
274
279
  | trustpilot | `trustpilot.categories` | `trustpilot-categories` | `GET /trustpilot/categories` | none | `ApiKeyAuth` | `TrustpilotCategoriesResponse` | |
275
280
  | trustpilot | `trustpilot.categorySearch` | `trustpilot-category-search` | `GET /trustpilot/categories/search` | `q` (query string required)<br>`country` (query string)<br>`locale` (query string)<br>`size` (query number) | `ApiKeyAuth` | `TrustpilotCategorySearchResponse` | |
276
281
  | trustpilot | `trustpilot.category` | `trustpilot-category` | `GET /trustpilot/category/{slug}` | `slug` (path string required)<br>`page` (query number) | `ApiKeyAuth` | `TrustpilotCategoryResponse` | |
277
- | usage | `usage.meEndpoints` | `usage-me-endpoints` | `GET /usage/me/endpoints` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`limit` (query number)<br>`from` (query string)<br>`to` (query string) | `JWTAuth` | `UsageMeEndpointsResponse` | |
278
- | usage | `usage.meOverview` | `usage-me-overview` | `GET /usage/me/overview` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`from` (query string)<br>`to` (query string) | `JWTAuth` | `UsageMeOverviewResponse` | |
279
- | usage | `usage.meRecentIps` | `usage-me-recent-ips` | `GET /usage/me/recent-ips` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`limit` (query number)<br>`from` (query string)<br>`to` (query string) | `JWTAuth` | `UsageMeRecentIpsResponse` | |
280
- | usage | `usage.meTimeseries` | `usage-me-timeseries` | `GET /usage/me/timeseries` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`bucket` (query "hour" \| "day")<br>`endpoint` (query string)<br>`from` (query string)<br>`to` (query string) | `JWTAuth` | `UsageMeTimeseriesResponse` | |
282
+ | usage | `usage.meEndpoints` | `usage-me-endpoints` | `GET /usage/me/endpoints` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`limit` (query number)<br>`from` (query string)<br>`to` (query string) | `ApiKeyAuth` | `UsageMeEndpointsResponse` | |
283
+ | usage | `usage.meOverview` | `usage-me-overview` | `GET /usage/me/overview` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`from` (query string)<br>`to` (query string) | `ApiKeyAuth` | `UsageMeOverviewResponse` | |
284
+ | usage | `usage.meRecentIps` | `usage-me-recent-ips` | `GET /usage/me/recent-ips` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`limit` (query number)<br>`from` (query string)<br>`to` (query string) | `ApiKeyAuth` | `UsageMeRecentIpsResponse` | |
285
+ | usage | `usage.meTimeseries` | `usage-me-timeseries` | `GET /usage/me/timeseries` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`bucket` (query "hour" \| "day")<br>`endpoint` (query string)<br>`from` (query string)<br>`to` (query string) | `ApiKeyAuth` | `UsageMeTimeseriesResponse` | |
281
286
  | user | `user.me` | `user-me` | `GET /user/me` | none | `JWTAuth` | `UserMeResponse` | |
282
287
  | user | `user.meApiKeys` | `user-me-api-keys` | `GET /user/me/api-keys` | none | `JWTAuth` | `UserMeApiKeysResponse` | |
283
288
  | user | `user.meApiKeysRotate` | `user-me-api-keys-rotate` | `POST /user/me/api-keys/rotate` | none | `JWTAuth` | `UserMeApiKeysRotateResponse` | |
@@ -287,6 +292,7 @@ Total operations: `330`
287
292
  | yahooFinance | `yahooFinance.download` | `yahoo-finance-download` | `POST /yahoo-finance/download` | `request` (body string required) | `ApiKeyAuth` | `YahooFinanceDownloadResponse` | |
288
293
  | yahooFinance | `yahooFinance.industries` | `yahoo-finance-industries` | `GET /yahoo-finance/industries` | none | `ApiKeyAuth` | `YahooFinanceIndustriesResponse` | |
289
294
  | yahooFinance | `yahooFinance.industry` | `yahoo-finance-industry` | `GET /yahoo-finance/industries/{key}` | `key` (path string required) | `ApiKeyAuth` | `YahooFinanceIndustryResponse` | |
295
+ | yahooFinance | `yahooFinance.lookup` | `yahoo-finance-lookup` | `GET /yahoo-finance/lookup` | `query` (query string required)<br>`type` (query "all" \| "equity" \| "etf" \| "mutualfund" \| "index" \| "future" \| "currency" \| "cryptocurrency")<br>`count` (query number)<br>`start` (query number) | `ApiKeyAuth` | `YahooFinanceLookupResponse` | |
290
296
  | yahooFinance | `yahooFinance.marketStatus` | `yahoo-finance-market-status` | `GET /yahoo-finance/market/{market}/status` | `market` (path string required) | `ApiKeyAuth` | `YahooFinanceMarketStatusResponse` | |
291
297
  | yahooFinance | `yahooFinance.marketSummary` | `yahoo-finance-market-summary` | `GET /yahoo-finance/market/{market}/summary` | `market` (path string required) | `ApiKeyAuth` | `YahooFinanceMarketSummaryResponse` | |
292
298
  | yahooFinance | `yahooFinance.screenerCustom` | `yahoo-finance-screener-custom` | `POST /yahoo-finance/screener` | `request` (body string required) | `ApiKeyAuth` | `YahooFinanceScreenerCustomResponse` | |
package/docs/recipes.md CHANGED
@@ -30,6 +30,15 @@ Literal operation ids infer parameter and response types in TypeScript. Use the
30
30
  grouped endpoint methods when you want the shortest call shape, and dynamic
31
31
  operation calls when you store operation ids in app-level routing or jobs.
32
32
 
33
+ ## Reddit And Brand
34
+
35
+ Newer platforms are grouped like every other endpoint:
36
+
37
+ ```ts
38
+ const posts = await crawlora.reddit.search({ q: "typescript", subreddit: "programming" });
39
+ const brand = await crawlora.brand.retrieve({ domain: "stripe.com" });
40
+ ```
41
+
33
42
  ## Retries, Timeouts, Headers, And Abort Signals
34
43
 
35
44
  ```js