crawlora 1.5.0.pre.sdk.3 → 1.6.0.pre.sdk.2

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e769697392f10afe8e5b54d3eb890d8a5b88aecba2911962c66e04a901b87ee7
4
- data.tar.gz: 2258a6882ff2fda76328c6da12338ae0bf7d2df03ec58fc8082fe8bb75c266ca
3
+ metadata.gz: 4eae2bacf4352c265efe9ec793a3473affc2ff54bbdac9a73247b29415933f89
4
+ data.tar.gz: 3e7095048fb3748f37e0a6547cefb60af5450f7c152b56202bdbc5c719f00e6c
5
5
  SHA512:
6
- metadata.gz: 39f8c6aa73edab7665e50096673a66bec12bfd8c9f7e2d5aa741cb448f2db77f05fee6c97fe9d9756e2a1d1c10a08dbd752c6e168e4d375e9a35eb6ab6d1ed73
7
- data.tar.gz: 4c5dfbcff65eaf13865077173a092d44edba165a301fa6fe982890ac5b03befc39ecc7076a692f98f588193f4c31c34e19b164df8af883f96534067f5184ae6e
6
+ metadata.gz: 9ad479888af6920b3fc9e69319f3972ff6c047bc84ec21c2396e4b41cceb4dc730534760f88ace23e354a9bb2eae1dbf2428e64b0eaef24e729109e51b530925
7
+ data.tar.gz: ff373e7f5183c2df6d2646af541adcf24480ae02b091aa0f9cc6ed79aa5a1e2abab08627fddf4e7f67dd1de2bbd85dd1f86168b97f5e0e1f188103ad24fe7106
data/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.6.0-sdk.1
4
+
5
+ - Added the **Reddit** platform (`reddit.search`, `reddit.post`,
6
+ `reddit.comments`, `reddit.subreddit_posts`) and the **Brand** platform
7
+ (`brand.retrieve`), plus Yahoo Finance `yahoo_finance.lookup`. Regenerated from
8
+ the public API contract.
9
+
3
10
  ## 1.5.0-sdk.3
4
11
 
5
12
  - Richer RBS: generated `sig/crawlora.rbs` now declares typed keyword parameters
data/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: `330`
5
+ Total operations: `338`
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 Integer)<br>`count` (query Integer)<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 Integer)<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 Integer)<br>`count` (query Integer)<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 bool)<br>`maxAgeMs` (query Integer)<br>`timeoutMS` (query Integer) | `ApiKeyAuth` | `BrandRetrieveResponse` | |
44
45
  | brave | `brave.images` | `brave-images` | `GET /brave/images` | `q` (query String required)<br>`offset` (query Integer)<br>`count` (query Integer)<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 Integer)<br>`count` (query Integer)<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 Integer)<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`
104
105
  | google | `google.jobs` | `google-jobs` | `POST /google/jobs` | `option` (body String required) | `ApiKeyAuth` | `GoogleJobsResponse` | |
105
106
  | google | `google.map_place` | `google-map-place` | `GET /google/map/place/{place_id}` | `place_id` (path String required) | `ApiKeyAuth` | `GoogleMapPlaceResponse` | |
106
107
  | google | `google.map_search` | `google-map-search` | `POST /google/map/search` | `mapSearchOption` (body String required) | `ApiKeyAuth` | `GoogleMapSearchResponse` | |
108
+ | google | `google.news` | `google-news` | `GET /google/news` | `q` (query String required)<br>`page` (query Integer)<br>`count` (query Integer)<br>`country` (query String)<br>`lang` (query String) | `ApiKeyAuth` | `GoogleNewsResponse` | |
107
109
  | google | `google.search` | `google-search` | `POST /google/search` | `searchOption` (body String required) | `ApiKeyAuth` | `GoogleSearchResponse` | |
108
110
  | google | `google.suggest` | `google-suggest` | `GET /google/suggest` | `q` (query String required)<br>`count` (query Integer)<br>`country` (query String)<br>`lang` (query String) | `ApiKeyAuth` | `GoogleSuggestResponse` | |
109
111
  | google | `google.trends_categories` | `google-trends-categories` | `GET /google/trends/categories` | none | `ApiKeyAuth` | `GoogleTrendsCategoriesResponse` | |
@@ -117,6 +119,7 @@ Total operations: `330`
117
119
  | google | `google.trends_locations` | `google-trends-locations` | `GET /google/trends/locations` | none | `ApiKeyAuth` | `GoogleTrendsLocationsResponse` | |
118
120
  | google | `google.trends_trending` | `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 Integer)<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 Integer) | `ApiKeyAuth` | `GoogleTrendsTrendingResponse` | |
119
121
  | google | `google.trends_trending_detail` | `google-trends-trending-detail` | `POST /google/trends/trending/detail` | `request` (body String required) | `ApiKeyAuth` | `GoogleTrendsTrendingDetailResponse` | |
122
+ | google | `google.videos` | `google-videos` | `GET /google/videos` | `q` (query String required)<br>`page` (query Integer)<br>`count` (query Integer)<br>`country` (query String)<br>`lang` (query String) | `ApiKeyAuth` | `GoogleVideosResponse` | |
120
123
  | google_play | `google_play.app` | `googleplay-app` | `GET /googleplay/app` | `app_id` (query String required)<br>`country` (query String)<br>`lang` (query String) | `ApiKeyAuth` | `GooglePlayAppResponse` | |
121
124
  | google_play | `google_play.categories` | `googleplay-categories` | `GET /googleplay/categories` | `country` (query String)<br>`lang` (query String) | `ApiKeyAuth` | `GooglePlayCategoriesResponse` | |
122
125
  | google_play | `google_play.datasafety` | `googleplay-datasafety` | `GET /googleplay/datasafety` | `app_id` (query String required)<br>`lang` (query String) | `ApiKeyAuth` | `GooglePlayDatasafetyResponse` | |
@@ -167,6 +170,10 @@ Total operations: `330`
167
170
  | product_hunt | `product_hunt.makers` | `producthunt-makers` | `GET /producthunt/product/{id}/makers` | `id` (path String required)<br>`cursor` (query String) | `ApiKeyAuth` | `ProductHuntMakersResponse` | |
168
171
  | product_hunt | `product_hunt.reviews` | `producthunt-reviews` | `GET /producthunt/product/{id}/reviews` | `id` (path String required) | `ApiKeyAuth` | `ProductHuntReviewsResponse` | |
169
172
  | product_hunt | `product_hunt.search` | `producthunt-search` | `GET /producthunt/search` | `query` (query String required)<br>`type` (query "product" \| "user" \| "launch")<br>`page` (query Integer)<br>`featured` (query bool)<br>`topics` (query String) | `ApiKeyAuth` | `ProductHuntSearchResponse` | |
173
+ | 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 Integer)<br>`depth` (query Integer) | `ApiKeyAuth` | `RedditCommentsResponse` | |
174
+ | reddit | `reddit.post` | `reddit-post` | `GET /reddit/post/{id}` | `id` (path String required) | `ApiKeyAuth` | `RedditPostResponse` | |
175
+ | 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 Integer)<br>`after` (query String) | `ApiKeyAuth` | `RedditSearchResponse` | |
176
+ | reddit | `reddit.subreddit_posts` | `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 Integer)<br>`after` (query String) | `ApiKeyAuth` | `RedditSubredditPostsResponse` | |
170
177
  | referrals | `referrals.click` | `referrals-click` | `POST /referrals/click` | `request` (body String required) | none | `ReferralsClickResponse` | |
171
178
  | referrals | `referrals.me` | `referrals-me` | `GET /referrals/me` | none | `JWTAuth` | `ReferralsMeResponse` | |
172
179
  | referrals | `referrals.me_events` | `referrals-me-events` | `GET /referrals/me/events` | `limit` (query Integer) | `JWTAuth` | `ReferralsMeEventsResponse` | |
@@ -274,10 +281,10 @@ Total operations: `330`
274
281
  | trustpilot | `trustpilot.categories` | `trustpilot-categories` | `GET /trustpilot/categories` | none | `ApiKeyAuth` | `TrustpilotCategoriesResponse` | |
275
282
  | trustpilot | `trustpilot.category_search` | `trustpilot-category-search` | `GET /trustpilot/categories/search` | `q` (query String required)<br>`country` (query String)<br>`locale` (query String)<br>`size` (query Integer) | `ApiKeyAuth` | `TrustpilotCategorySearchResponse` | |
276
283
  | trustpilot | `trustpilot.category` | `trustpilot-category` | `GET /trustpilot/category/{slug}` | `slug` (path String required)<br>`page` (query Integer) | `ApiKeyAuth` | `TrustpilotCategoryResponse` | |
277
- | usage | `usage.me_endpoints` | `usage-me-endpoints` | `GET /usage/me/endpoints` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`limit` (query Integer)<br>`from` (query String)<br>`to` (query String) | `JWTAuth` | `UsageMeEndpointsResponse` | |
278
- | usage | `usage.me_overview` | `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.me_recent_ips` | `usage-me-recent-ips` | `GET /usage/me/recent-ips` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`limit` (query Integer)<br>`from` (query String)<br>`to` (query String) | `JWTAuth` | `UsageMeRecentIpsResponse` | |
280
- | usage | `usage.me_timeseries` | `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` | |
284
+ | usage | `usage.me_endpoints` | `usage-me-endpoints` | `GET /usage/me/endpoints` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`limit` (query Integer)<br>`from` (query String)<br>`to` (query String) | `ApiKeyAuth` | `UsageMeEndpointsResponse` | |
285
+ | usage | `usage.me_overview` | `usage-me-overview` | `GET /usage/me/overview` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`from` (query String)<br>`to` (query String) | `ApiKeyAuth` | `UsageMeOverviewResponse` | |
286
+ | usage | `usage.me_recent_ips` | `usage-me-recent-ips` | `GET /usage/me/recent-ips` | `range` (query "period" \| "day" \| "week" \| "month" \| "custom")<br>`limit` (query Integer)<br>`from` (query String)<br>`to` (query String) | `ApiKeyAuth` | `UsageMeRecentIpsResponse` | |
287
+ | usage | `usage.me_timeseries` | `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
288
  | user | `user.me` | `user-me` | `GET /user/me` | none | `JWTAuth` | `UserMeResponse` | |
282
289
  | user | `user.me_api_keys` | `user-me-api-keys` | `GET /user/me/api-keys` | none | `JWTAuth` | `UserMeApiKeysResponse` | |
283
290
  | user | `user.me_api_keys_rotate` | `user-me-api-keys-rotate` | `POST /user/me/api-keys/rotate` | none | `JWTAuth` | `UserMeApiKeysRotateResponse` | |
@@ -287,6 +294,7 @@ Total operations: `330`
287
294
  | yahoo_finance | `yahoo_finance.download` | `yahoo-finance-download` | `POST /yahoo-finance/download` | `request` (body String required) | `ApiKeyAuth` | `YahooFinanceDownloadResponse` | |
288
295
  | yahoo_finance | `yahoo_finance.industries` | `yahoo-finance-industries` | `GET /yahoo-finance/industries` | none | `ApiKeyAuth` | `YahooFinanceIndustriesResponse` | |
289
296
  | yahoo_finance | `yahoo_finance.industry` | `yahoo-finance-industry` | `GET /yahoo-finance/industries/{key}` | `key` (path String required) | `ApiKeyAuth` | `YahooFinanceIndustryResponse` | |
297
+ | yahoo_finance | `yahoo_finance.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 Integer)<br>`start` (query Integer) | `ApiKeyAuth` | `YahooFinanceLookupResponse` | |
290
298
  | yahoo_finance | `yahoo_finance.market_status` | `yahoo-finance-market-status` | `GET /yahoo-finance/market/{market}/status` | `market` (path String required) | `ApiKeyAuth` | `YahooFinanceMarketStatusResponse` | |
291
299
  | yahoo_finance | `yahoo_finance.market_summary` | `yahoo-finance-market-summary` | `GET /yahoo-finance/market/{market}/summary` | `market` (path String required) | `ApiKeyAuth` | `YahooFinanceMarketSummaryResponse` | |
292
300
  | yahoo_finance | `yahoo_finance.screener_custom` | `yahoo-finance-screener-custom` | `POST /yahoo-finance/screener` | `request` (body String required) | `ApiKeyAuth` | `YahooFinanceScreenerCustomResponse` | |
data/docs/recipes.md CHANGED
@@ -17,6 +17,15 @@ Crawlora.client(jwt_token: "eyJ…")
17
17
  Both fall back to environment variables: `CRAWLORA_API_KEY` and
18
18
  `CRAWLORA_BASE_URL`.
19
19
 
20
+ ## Reddit and Brand
21
+
22
+ Newer platforms are grouped like every other endpoint:
23
+
24
+ ```ruby
25
+ posts = client.reddit.search(q: "ruby", subreddit: "programming")
26
+ brand = client.brand.retrieve(domain: "stripe.com")
27
+ ```
28
+
20
29
  ## Retries and Retry-After
21
30
 
22
31
  ```ruby