@crawlora-org/sdk 1.5.0-sdk.3 → 1.6.0-sdk.3

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v1.6.0-sdk.1
+
+- Added the **Reddit** platform (`reddit.search`, `reddit.post`,
+  `reddit.comments`, `reddit.subredditPosts`) and the **Brand** platform
+  (`brand.retrieve`), plus Yahoo Finance `yahooFinance.lookup`. Regenerated from
+  the public API contract.
+
 ## v1.5.0-sdk.1
 
 - Added `beforeRequest`/`afterResponse` middleware hooks (mutate the outgoing

package/README.md

@@ -1,8 +1,9 @@
 # Crawlora JavaScript SDK
 
 Official JavaScript and TypeScript client for the public Crawlora API. Use it
-to call Crawlora scraping, search, marketplace, media, maps, finance, and usage
-endpoints with a small `fetch`-based client and generated TypeScript types.
+to call Crawlora scraping, search, social, marketplace, media, maps, finance,
+brand, and usage endpoints with a small `fetch`-based client and generated
+TypeScript types.
 
 - Runtime: Node.js 18+ or any modern runtime with `fetch`
 - Auth: `x-api-key`

package/docs/operations.md

@@ -2,7 +2,7 @@
 
 Generated from `openapi/public.json`. Deprecated, admin, and internal operations are excluded from this SDK contract.
 
-Total operations: `330`
+Total operations: `338`
 
 | Group | SDK method | Operation ID | HTTP | Params | Auth | Response | Notes |
 | --- | --- | --- | --- | --- | --- | --- | --- |
@@ -41,6 +41,7 @@ Total operations: `330`
 | 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` |  |
 | 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` |  |
 | 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` |  |
+| 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` |  |
 | 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` |  |
 | 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` |  |
 | 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` |  |
@@ -104,6 +105,7 @@ Total operations: `330`
 | google | `google.jobs` | `google-jobs` | `POST /google/jobs` | `option` (body string required) | `ApiKeyAuth` | `GoogleJobsResponse` |  |
 | google | `google.mapPlace` | `google-map-place` | `GET /google/map/place/{place_id}` | `place_id` (path string required) | `ApiKeyAuth` | `GoogleMapPlaceResponse` |  |
 | google | `google.mapSearch` | `google-map-search` | `POST /google/map/search` | `mapSearchOption` (body string required) | `ApiKeyAuth` | `GoogleMapSearchResponse` |  |
+| google | `google.news` | `google-news` | `GET /google/news` | `q` (query string required)<br>`page` (query number)<br>`count` (query number)<br>`country` (query string)<br>`lang` (query string) | `ApiKeyAuth` | `GoogleNewsResponse` |  |
 | google | `google.search` | `google-search` | `POST /google/search` | `searchOption` (body string required) | `ApiKeyAuth` | `GoogleSearchResponse` |  |
 | google | `google.suggest` | `google-suggest` | `GET /google/suggest` | `q` (query string required)<br>`count` (query number)<br>`country` (query string)<br>`lang` (query string) | `ApiKeyAuth` | `GoogleSuggestResponse` |  |
 | google | `google.trendsCategories` | `google-trends-categories` | `GET /google/trends/categories` | none | `ApiKeyAuth` | `GoogleTrendsCategoriesResponse` |  |
@@ -117,6 +119,7 @@ Total operations: `330`
 | google | `google.trendsLocations` | `google-trends-locations` | `GET /google/trends/locations` | none | `ApiKeyAuth` | `GoogleTrendsLocationsResponse` |  |
 | google | `google.trendsTrending` | `google-trends-trending` | `GET /google/trends/trending` | `geo` (query "AF" \| "AX" \| "AL" \| "DZ" \| "AS" \| "AD" \| "AO" \| "AI" \| "AQ" \| "AG" \| "AR" \| "AM" \| "AW" \| "AU" \| "AT" \| "AZ" \| "BS" \| "BH" \| "BD" \| "BB" \| "BY" \| "BE" \| "BZ" \| "BJ" \| "BM" \| "BT" \| "BO" \| "BA" \| "BW" \| "BV" \| "BR" \| "IO" \| "VG" \| "BN" \| "BG" \| "BF" \| "BI" \| "KH" \| "CM" \| "CA" \| "CV" \| "BQ" \| "KY" \| "CF" \| "TD" \| "CL" \| "CN" \| "CX" \| "CC" \| "CO" \| "KM" \| "CG" \| "CD" \| "CK" \| "CR" \| "CI" \| "HR" \| "CU" \| "CW" \| "CY" \| "CZ" \| "DK" \| "DJ" \| "DM" \| "DO" \| "EC" \| "EG" \| "SV" \| "GQ" \| "ER" \| "EE" \| "SZ" \| "ET" \| "FK" \| "FO" \| "FJ" \| "FI" \| "FR" \| "GF" \| "PF" \| "TF" \| "GA" \| "GM" \| "GE" \| "DE" \| "GH" \| "GI" \| "GR" \| "GL" \| "GD" \| "GP" \| "GU" \| "GT" \| "GG" \| "GN" \| "GW" \| "GY" \| "HT" \| "HM" \| "HN" \| "HK" \| "HU" \| "IS" \| "IN" \| "ID" \| "IR" \| "IQ" \| "IE" \| "IM" \| "IL" \| "IT" \| "JM" \| "JP" \| "JE" \| "JO" \| "KZ" \| "KE" \| "KI" \| "XK" \| "KW" \| "KG" \| "LA" \| "LV" \| "LB" \| "LS" \| "LR" \| "LY" \| "LI" \| "LT" \| "LU" \| "MO" \| "MG" \| "MW" \| "MY" \| "MV" \| "ML" \| "MT" \| "MH" \| "MQ" \| "MR" \| "MU" \| "YT" \| "MX" \| "FM" \| "MD" \| "MC" \| "MN" \| "ME" \| "MS" \| "MA" \| "MZ" \| "MM" \| "NA" \| "NR" \| "NP" \| "NL" \| "NC" \| "NZ" \| "NI" \| "NE" \| "NG" \| "NU" \| "NF" \| "KP" \| "MK" \| "MP" \| "NO" \| "OM" \| "PK" \| "PW" \| "PS" \| "PA" \| "PG" \| "PY" \| "PE" \| "PH" \| "PN" \| "PL" \| "PT" \| "PR" \| "QA" \| "RE" \| "RO" \| "RU" \| "RW" \| "WS" \| "SM" \| "ST" \| "SA" \| "SN" \| "RS" \| "SC" \| "SL" \| "SG" \| "SX" \| "SK" \| "SI" \| "SB" \| "SO" \| "ZA" \| "GS" \| "KR" \| "SS" \| "ES" \| "LK" \| "BL" \| "SH" \| "KN" \| "LC" \| "MF" \| "PM" \| "VC" \| "SD" \| "SR" \| "SJ" \| "SE" \| "CH" \| "SY" \| "TW" \| "TJ" \| "TZ" \| "TH" \| "TL" \| "TG" \| "TK" \| "TO" \| "TT" \| "TN" \| "TR" \| "TM" \| "TC" \| "TV" \| "UM" \| "VI" \| "UG" \| "UA" \| "AE" \| "GB" \| "US" \| "UY" \| "UZ" \| "VU" \| "VA" \| "VE" \| "VN" \| "WF" \| "EH" \| "YE" \| "ZM" \| "ZW")<br>`hl` (query string)<br>`tz` (query number)<br>`window` (query "4h" \| "24h" \| "48h" \| "7d")<br>`time_range` (query "4h" \| "24h" \| "48h" \| "7d")<br>`category` (query "0" \| "3" \| "47" \| "44" \| "22" \| "12" \| "5" \| "7" \| "71" \| "8" \| "45" \| "65" \| "11" \| "13" \| "958" \| "19" \| "16" \| "299" \| "14" \| "66" \| "29" \| "533" \| "174" \| "18" \| "20" \| "67")<br>`status` (query "all" \| "active" \| "ended")<br>`sort_by` (query "relevance" \| "title" \| "recency" \| "search_volume")<br>`limit` (query number) | `ApiKeyAuth` | `GoogleTrendsTrendingResponse` |  |
 | google | `google.trendsTrendingDetail` | `google-trends-trending-detail` | `POST /google/trends/trending/detail` | `request` (body string required) | `ApiKeyAuth` | `GoogleTrendsTrendingDetailResponse` |  |
+| google | `google.videos` | `google-videos` | `GET /google/videos` | `q` (query string required)<br>`page` (query number)<br>`count` (query number)<br>`country` (query string)<br>`lang` (query string) | `ApiKeyAuth` | `GoogleVideosResponse` |  |
 | googlePlay | `googlePlay.app` | `googleplay-app` | `GET /googleplay/app` | `app_id` (query string required)<br>`country` (query string)<br>`lang` (query string) | `ApiKeyAuth` | `GooglePlayAppResponse` |  |
 | googlePlay | `googlePlay.categories` | `googleplay-categories` | `GET /googleplay/categories` | `country` (query string)<br>`lang` (query string) | `ApiKeyAuth` | `GooglePlayCategoriesResponse` |  |
 | googlePlay | `googlePlay.datasafety` | `googleplay-datasafety` | `GET /googleplay/datasafety` | `app_id` (query string required)<br>`lang` (query string) | `ApiKeyAuth` | `GooglePlayDatasafetyResponse` |  |
@@ -167,6 +170,10 @@ Total operations: `330`
 | productHunt | `productHunt.makers` | `producthunt-makers` | `GET /producthunt/product/{id}/makers` | `id` (path string required)<br>`cursor` (query string) | `ApiKeyAuth` | `ProductHuntMakersResponse` |  |
 | productHunt | `productHunt.reviews` | `producthunt-reviews` | `GET /producthunt/product/{id}/reviews` | `id` (path string required) | `ApiKeyAuth` | `ProductHuntReviewsResponse` |  |
 | 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` |  |
+| 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` |  |
+| reddit | `reddit.post` | `reddit-post` | `GET /reddit/post/{id}` | `id` (path string required) | `ApiKeyAuth` | `RedditPostResponse` |  |
+| 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` |  |
+| 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` |  |
 | referrals | `referrals.click` | `referrals-click` | `POST /referrals/click` | `request` (body string required) | none | `ReferralsClickResponse` |  |
 | referrals | `referrals.me` | `referrals-me` | `GET /referrals/me` | none | `JWTAuth` | `ReferralsMeResponse` |  |
 | referrals | `referrals.meEvents` | `referrals-me-events` | `GET /referrals/me/events` | `limit` (query number) | `JWTAuth` | `ReferralsMeEventsResponse` |  |
@@ -274,10 +281,10 @@ Total operations: `330`
 | trustpilot | `trustpilot.categories` | `trustpilot-categories` | `GET /trustpilot/categories` | none | `ApiKeyAuth` | `TrustpilotCategoriesResponse` |  |
 | 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` |  |
 | trustpilot | `trustpilot.category` | `trustpilot-category` | `GET /trustpilot/category/{slug}` | `slug` (path string required)<br>`page` (query number) | `ApiKeyAuth` | `TrustpilotCategoryResponse` |  |
-| 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` |  |
-| 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` |  |
-| 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` |  |
-| 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` |  |
+| 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` |  |
+| 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` |  |
+| 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` |  |
+| 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` |  |
 | user | `user.me` | `user-me` | `GET /user/me` | none | `JWTAuth` | `UserMeResponse` |  |
 | user | `user.meApiKeys` | `user-me-api-keys` | `GET /user/me/api-keys` | none | `JWTAuth` | `UserMeApiKeysResponse` |  |
 | user | `user.meApiKeysRotate` | `user-me-api-keys-rotate` | `POST /user/me/api-keys/rotate` | none | `JWTAuth` | `UserMeApiKeysRotateResponse` |  |
@@ -287,6 +294,7 @@ Total operations: `330`
 | yahooFinance | `yahooFinance.download` | `yahoo-finance-download` | `POST /yahoo-finance/download` | `request` (body string required) | `ApiKeyAuth` | `YahooFinanceDownloadResponse` |  |
 | yahooFinance | `yahooFinance.industries` | `yahoo-finance-industries` | `GET /yahoo-finance/industries` | none | `ApiKeyAuth` | `YahooFinanceIndustriesResponse` |  |
 | yahooFinance | `yahooFinance.industry` | `yahoo-finance-industry` | `GET /yahoo-finance/industries/{key}` | `key` (path string required) | `ApiKeyAuth` | `YahooFinanceIndustryResponse` |  |
+| 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` |  |
 | yahooFinance | `yahooFinance.marketStatus` | `yahoo-finance-market-status` | `GET /yahoo-finance/market/{market}/status` | `market` (path string required) | `ApiKeyAuth` | `YahooFinanceMarketStatusResponse` |  |
 | yahooFinance | `yahooFinance.marketSummary` | `yahoo-finance-market-summary` | `GET /yahoo-finance/market/{market}/summary` | `market` (path string required) | `ApiKeyAuth` | `YahooFinanceMarketSummaryResponse` |  |
 | yahooFinance | `yahooFinance.screenerCustom` | `yahoo-finance-screener-custom` | `POST /yahoo-finance/screener` | `request` (body string required) | `ApiKeyAuth` | `YahooFinanceScreenerCustomResponse` |  |

package/docs/recipes.md

@@ -30,6 +30,15 @@ Literal operation ids infer parameter and response types in TypeScript. Use the
 grouped endpoint methods when you want the shortest call shape, and dynamic
 operation calls when you store operation ids in app-level routing or jobs.
 
+## Reddit And Brand
+
+Newer platforms are grouped like every other endpoint:
+
+```ts
+const posts = await crawlora.reddit.search({ q: "typescript", subreddit: "programming" });
+const brand = await crawlora.brand.retrieve({ domain: "stripe.com" });
+```
+
 ## Retries, Timeouts, Headers, And Abort Signals
 
 ```js