scrapebadger 0.15.4 → 0.15.6
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/dist/index.d.cts +1504 -125
- package/dist/index.d.ts +1504 -125
- package/dist/index.js +340 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +331 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -411,7 +411,7 @@ interface VintedPagination {
|
|
|
411
411
|
/**
|
|
412
412
|
* Response from the search endpoint.
|
|
413
413
|
*/
|
|
414
|
-
interface SearchResponse$
|
|
414
|
+
interface SearchResponse$6 {
|
|
415
415
|
/** List of matching items */
|
|
416
416
|
items: VintedItemSummary[];
|
|
417
417
|
/** Pagination metadata */
|
|
@@ -479,7 +479,7 @@ interface StatusesResponse {
|
|
|
479
479
|
/**
|
|
480
480
|
* Response from the markets endpoint.
|
|
481
481
|
*/
|
|
482
|
-
interface MarketsResponse$
|
|
482
|
+
interface MarketsResponse$7 {
|
|
483
483
|
/** List of available markets */
|
|
484
484
|
markets: VintedMarket[];
|
|
485
485
|
}
|
|
@@ -550,7 +550,7 @@ interface VintedSearchParams {
|
|
|
550
550
|
* });
|
|
551
551
|
* ```
|
|
552
552
|
*/
|
|
553
|
-
declare class SearchClient$
|
|
553
|
+
declare class SearchClient$a {
|
|
554
554
|
private readonly client;
|
|
555
555
|
constructor(client: BaseClient);
|
|
556
556
|
/**
|
|
@@ -586,7 +586,7 @@ declare class SearchClient$8 {
|
|
|
586
586
|
* }
|
|
587
587
|
* ```
|
|
588
588
|
*/
|
|
589
|
-
search(params: VintedSearchParams): Promise<SearchResponse$
|
|
589
|
+
search(params: VintedSearchParams): Promise<SearchResponse$6>;
|
|
590
590
|
}
|
|
591
591
|
|
|
592
592
|
/**
|
|
@@ -741,7 +741,7 @@ declare class UsersClient$2 {
|
|
|
741
741
|
* }
|
|
742
742
|
* ```
|
|
743
743
|
*/
|
|
744
|
-
declare class ReferenceClient$
|
|
744
|
+
declare class ReferenceClient$8 {
|
|
745
745
|
private readonly client;
|
|
746
746
|
constructor(client: BaseClient);
|
|
747
747
|
/**
|
|
@@ -819,7 +819,7 @@ declare class ReferenceClient$6 {
|
|
|
819
819
|
* }
|
|
820
820
|
* ```
|
|
821
821
|
*/
|
|
822
|
-
markets(): Promise<MarketsResponse$
|
|
822
|
+
markets(): Promise<MarketsResponse$7>;
|
|
823
823
|
}
|
|
824
824
|
|
|
825
825
|
/**
|
|
@@ -856,13 +856,13 @@ declare class ReferenceClient$6 {
|
|
|
856
856
|
*/
|
|
857
857
|
declare class VintedClient {
|
|
858
858
|
/** Client for item search operations */
|
|
859
|
-
readonly search: SearchClient$
|
|
859
|
+
readonly search: SearchClient$a;
|
|
860
860
|
/** Client for individual item operations */
|
|
861
861
|
readonly items: ItemsClient$1;
|
|
862
862
|
/** Client for user operations */
|
|
863
863
|
readonly users: UsersClient$2;
|
|
864
864
|
/** Client for reference data (brands, colors, statuses, markets) */
|
|
865
|
-
readonly reference: ReferenceClient$
|
|
865
|
+
readonly reference: ReferenceClient$8;
|
|
866
866
|
/**
|
|
867
867
|
* Create a new Vinted client.
|
|
868
868
|
*
|
|
@@ -1862,7 +1862,7 @@ declare class ScholarClient {
|
|
|
1862
1862
|
* }
|
|
1863
1863
|
* ```
|
|
1864
1864
|
*/
|
|
1865
|
-
declare class SearchClient$
|
|
1865
|
+
declare class SearchClient$9 {
|
|
1866
1866
|
private readonly client;
|
|
1867
1867
|
constructor(client: BaseClient);
|
|
1868
1868
|
/**
|
|
@@ -2064,7 +2064,7 @@ declare class VideosClient$2 {
|
|
|
2064
2064
|
*/
|
|
2065
2065
|
declare class GoogleClient {
|
|
2066
2066
|
/** Google Web Search (SERP) — with optional deferred AI Overview follow-up. */
|
|
2067
|
-
readonly search: SearchClient$
|
|
2067
|
+
readonly search: SearchClient$9;
|
|
2068
2068
|
/** Google Maps — places, reviews, photos, posts. */
|
|
2069
2069
|
readonly maps: MapsClient;
|
|
2070
2070
|
/** Google News — articles, topics, trending. */
|
|
@@ -2895,7 +2895,7 @@ interface DomainPostsResponse {
|
|
|
2895
2895
|
* const domainPosts = await client.reddit.search.domainPosts({ domain: "github.com" });
|
|
2896
2896
|
* ```
|
|
2897
2897
|
*/
|
|
2898
|
-
declare class SearchClient$
|
|
2898
|
+
declare class SearchClient$8 {
|
|
2899
2899
|
private readonly client;
|
|
2900
2900
|
constructor(client: BaseClient);
|
|
2901
2901
|
/**
|
|
@@ -3504,7 +3504,7 @@ declare class UsersClient$1 {
|
|
|
3504
3504
|
*/
|
|
3505
3505
|
declare class RedditClient {
|
|
3506
3506
|
/** Client for search operations (posts, subreddits, users, domain posts) */
|
|
3507
|
-
readonly search: SearchClient$
|
|
3507
|
+
readonly search: SearchClient$8;
|
|
3508
3508
|
/** Client for post operations (trending, details, comments, duplicates) */
|
|
3509
3509
|
readonly posts: PostsClient;
|
|
3510
3510
|
/** Client for subreddit operations (details, posts, rules, moderators, wiki) */
|
|
@@ -3543,7 +3543,7 @@ interface AmazonPrice {
|
|
|
3543
3543
|
/**
|
|
3544
3544
|
* Page-number pagination (Amazon listings use 1-based page numbers).
|
|
3545
3545
|
*/
|
|
3546
|
-
interface Pagination$
|
|
3546
|
+
interface Pagination$2 {
|
|
3547
3547
|
/** Current page number (1-indexed) */
|
|
3548
3548
|
current_page: number;
|
|
3549
3549
|
/** Total number of pages, if known */
|
|
@@ -3554,7 +3554,7 @@ interface Pagination$1 {
|
|
|
3554
3554
|
/**
|
|
3555
3555
|
* A single supported marketplace (for /markets).
|
|
3556
3556
|
*/
|
|
3557
|
-
interface MarketInfo$
|
|
3557
|
+
interface MarketInfo$4 {
|
|
3558
3558
|
/** Market code (e.g. "US", "UK", "DE") */
|
|
3559
3559
|
code: string;
|
|
3560
3560
|
/** Amazon domain suffix (e.g. "com", "co.uk") */
|
|
@@ -3869,7 +3869,7 @@ interface SellerFeedbackSummary {
|
|
|
3869
3869
|
/**
|
|
3870
3870
|
* A seller profile.
|
|
3871
3871
|
*/
|
|
3872
|
-
interface Seller$
|
|
3872
|
+
interface Seller$2 {
|
|
3873
3873
|
seller_id: string;
|
|
3874
3874
|
name: string | null;
|
|
3875
3875
|
link: string | null;
|
|
@@ -3900,11 +3900,11 @@ interface AutocompleteSuggestion$1 {
|
|
|
3900
3900
|
alias: string | null;
|
|
3901
3901
|
}
|
|
3902
3902
|
/** Response from the /search endpoint. */
|
|
3903
|
-
interface SearchResponse$
|
|
3903
|
+
interface SearchResponse$5 {
|
|
3904
3904
|
query: string;
|
|
3905
3905
|
domain: string;
|
|
3906
3906
|
results: SearchResult$3[];
|
|
3907
|
-
pagination: Pagination$
|
|
3907
|
+
pagination: Pagination$2;
|
|
3908
3908
|
scraped_utc: number | null;
|
|
3909
3909
|
scraped_at: string | null;
|
|
3910
3910
|
}
|
|
@@ -3931,7 +3931,7 @@ interface ReviewsResponse$1 {
|
|
|
3931
3931
|
rating: number | null;
|
|
3932
3932
|
ratings_total: number | null;
|
|
3933
3933
|
rating_breakdown: RatingBreakdown$1 | null;
|
|
3934
|
-
pagination: Pagination$
|
|
3934
|
+
pagination: Pagination$2;
|
|
3935
3935
|
scraped_utc: number | null;
|
|
3936
3936
|
scraped_at: string | null;
|
|
3937
3937
|
}
|
|
@@ -3940,7 +3940,7 @@ interface BestsellersResponse {
|
|
|
3940
3940
|
domain: string;
|
|
3941
3941
|
category: string | null;
|
|
3942
3942
|
bestsellers: Bestseller[];
|
|
3943
|
-
pagination: Pagination$
|
|
3943
|
+
pagination: Pagination$2;
|
|
3944
3944
|
scraped_utc: number | null;
|
|
3945
3945
|
scraped_at: string | null;
|
|
3946
3946
|
}
|
|
@@ -3949,7 +3949,7 @@ interface NewReleasesResponse {
|
|
|
3949
3949
|
domain: string;
|
|
3950
3950
|
category: string | null;
|
|
3951
3951
|
new_releases: Bestseller[];
|
|
3952
|
-
pagination: Pagination$
|
|
3952
|
+
pagination: Pagination$2;
|
|
3953
3953
|
scraped_utc: number | null;
|
|
3954
3954
|
scraped_at: string | null;
|
|
3955
3955
|
}
|
|
@@ -3958,7 +3958,7 @@ interface DealsResponse {
|
|
|
3958
3958
|
domain: string;
|
|
3959
3959
|
category: string | null;
|
|
3960
3960
|
deals: Deal[];
|
|
3961
|
-
pagination: Pagination$
|
|
3961
|
+
pagination: Pagination$2;
|
|
3962
3962
|
scraped_utc: number | null;
|
|
3963
3963
|
scraped_at: string | null;
|
|
3964
3964
|
}
|
|
@@ -3967,21 +3967,21 @@ interface CategoryResponse$1 {
|
|
|
3967
3967
|
domain: string;
|
|
3968
3968
|
node: string;
|
|
3969
3969
|
results: SearchResult$3[];
|
|
3970
|
-
pagination: Pagination$
|
|
3970
|
+
pagination: Pagination$2;
|
|
3971
3971
|
scraped_utc: number | null;
|
|
3972
3972
|
scraped_at: string | null;
|
|
3973
3973
|
}
|
|
3974
3974
|
/** Response from the /sellers/{seller_id} endpoint. */
|
|
3975
3975
|
interface SellerProfileResponse$1 {
|
|
3976
3976
|
domain: string;
|
|
3977
|
-
seller: Seller$
|
|
3977
|
+
seller: Seller$2;
|
|
3978
3978
|
}
|
|
3979
3979
|
/** Response from the /sellers/{seller_id}/products endpoint. */
|
|
3980
3980
|
interface SellerProductsResponse {
|
|
3981
3981
|
domain: string;
|
|
3982
3982
|
seller_id: string;
|
|
3983
3983
|
products: SearchResult$3[];
|
|
3984
|
-
pagination: Pagination$
|
|
3984
|
+
pagination: Pagination$2;
|
|
3985
3985
|
scraped_utc: number | null;
|
|
3986
3986
|
scraped_at: string | null;
|
|
3987
3987
|
}
|
|
@@ -3990,22 +3990,22 @@ interface SellerFeedbackResponse$1 {
|
|
|
3990
3990
|
domain: string;
|
|
3991
3991
|
seller_id: string;
|
|
3992
3992
|
feedback: SellerFeedbackEntry[];
|
|
3993
|
-
pagination: Pagination$
|
|
3993
|
+
pagination: Pagination$2;
|
|
3994
3994
|
scraped_utc: number | null;
|
|
3995
3995
|
scraped_at: string | null;
|
|
3996
3996
|
}
|
|
3997
3997
|
/** Response from the /autocomplete endpoint. */
|
|
3998
|
-
interface AutocompleteResponse$
|
|
3998
|
+
interface AutocompleteResponse$4 {
|
|
3999
3999
|
query: string;
|
|
4000
4000
|
domain: string;
|
|
4001
4001
|
suggestions: AutocompleteSuggestion$1[];
|
|
4002
4002
|
}
|
|
4003
4003
|
/** Response from the /markets endpoint. */
|
|
4004
|
-
interface MarketsResponse$
|
|
4005
|
-
markets: MarketInfo$
|
|
4004
|
+
interface MarketsResponse$6 {
|
|
4005
|
+
markets: MarketInfo$4[];
|
|
4006
4006
|
}
|
|
4007
4007
|
/** Response from the /categories endpoint. */
|
|
4008
|
-
interface CategoriesResponse$
|
|
4008
|
+
interface CategoriesResponse$3 {
|
|
4009
4009
|
categories: CategoryInfo$1[];
|
|
4010
4010
|
}
|
|
4011
4011
|
/** Parameters for searching Amazon products. */
|
|
@@ -4128,7 +4128,7 @@ interface AmazonAutocompleteParams {
|
|
|
4128
4128
|
* const suggestions = await client.amazon.search.autocomplete("lapt");
|
|
4129
4129
|
* ```
|
|
4130
4130
|
*/
|
|
4131
|
-
declare class SearchClient$
|
|
4131
|
+
declare class SearchClient$7 {
|
|
4132
4132
|
private readonly client;
|
|
4133
4133
|
constructor(client: BaseClient);
|
|
4134
4134
|
/**
|
|
@@ -4139,7 +4139,7 @@ declare class SearchClient$5 {
|
|
|
4139
4139
|
* @throws AuthenticationError - If the API key is invalid.
|
|
4140
4140
|
* @throws ValidationError - If the parameters are invalid.
|
|
4141
4141
|
*/
|
|
4142
|
-
search(params: AmazonSearchParams): Promise<SearchResponse$
|
|
4142
|
+
search(params: AmazonSearchParams): Promise<SearchResponse$5>;
|
|
4143
4143
|
/**
|
|
4144
4144
|
* Get Amazon keyword autocomplete suggestions.
|
|
4145
4145
|
*
|
|
@@ -4147,7 +4147,7 @@ declare class SearchClient$5 {
|
|
|
4147
4147
|
* @param options - Optional parameters (domain).
|
|
4148
4148
|
* @returns Autocomplete suggestions.
|
|
4149
4149
|
*/
|
|
4150
|
-
autocomplete(query: string, options?: AmazonAutocompleteParams): Promise<AutocompleteResponse$
|
|
4150
|
+
autocomplete(query: string, options?: AmazonAutocompleteParams): Promise<AutocompleteResponse$4>;
|
|
4151
4151
|
}
|
|
4152
4152
|
|
|
4153
4153
|
/**
|
|
@@ -4273,7 +4273,7 @@ declare class ListingsClient {
|
|
|
4273
4273
|
* const products = await client.amazon.sellers.products("A2L77EE7U53NWQ");
|
|
4274
4274
|
* ```
|
|
4275
4275
|
*/
|
|
4276
|
-
declare class SellersClient$
|
|
4276
|
+
declare class SellersClient$2 {
|
|
4277
4277
|
private readonly client;
|
|
4278
4278
|
constructor(client: BaseClient);
|
|
4279
4279
|
/**
|
|
@@ -4324,7 +4324,7 @@ declare class SellersClient$1 {
|
|
|
4324
4324
|
* const categories = await client.amazon.reference.categories();
|
|
4325
4325
|
* ```
|
|
4326
4326
|
*/
|
|
4327
|
-
declare class ReferenceClient$
|
|
4327
|
+
declare class ReferenceClient$7 {
|
|
4328
4328
|
private readonly client;
|
|
4329
4329
|
constructor(client: BaseClient);
|
|
4330
4330
|
/**
|
|
@@ -4332,13 +4332,13 @@ declare class ReferenceClient$5 {
|
|
|
4332
4332
|
*
|
|
4333
4333
|
* @returns Markets response with all supported marketplaces.
|
|
4334
4334
|
*/
|
|
4335
|
-
markets(): Promise<MarketsResponse$
|
|
4335
|
+
markets(): Promise<MarketsResponse$6>;
|
|
4336
4336
|
/**
|
|
4337
4337
|
* Get the reference department / category aliases.
|
|
4338
4338
|
*
|
|
4339
4339
|
* @returns Categories response with all category aliases.
|
|
4340
4340
|
*/
|
|
4341
|
-
categories(): Promise<CategoriesResponse$
|
|
4341
|
+
categories(): Promise<CategoriesResponse$3>;
|
|
4342
4342
|
}
|
|
4343
4343
|
|
|
4344
4344
|
/**
|
|
@@ -4379,15 +4379,15 @@ declare class ReferenceClient$5 {
|
|
|
4379
4379
|
*/
|
|
4380
4380
|
declare class AmazonClient {
|
|
4381
4381
|
/** Client for keyword search and autocomplete */
|
|
4382
|
-
readonly search: SearchClient$
|
|
4382
|
+
readonly search: SearchClient$7;
|
|
4383
4383
|
/** Client for product detail, offers, and reviews */
|
|
4384
4384
|
readonly products: ProductsClient$1;
|
|
4385
4385
|
/** Client for bestsellers, new releases, deals, and category browse */
|
|
4386
4386
|
readonly listings: ListingsClient;
|
|
4387
4387
|
/** Client for seller profile, products, and feedback */
|
|
4388
|
-
readonly sellers: SellersClient$
|
|
4388
|
+
readonly sellers: SellersClient$2;
|
|
4389
4389
|
/** Client for reference data (markets, categories) */
|
|
4390
|
-
readonly reference: ReferenceClient$
|
|
4390
|
+
readonly reference: ReferenceClient$7;
|
|
4391
4391
|
/**
|
|
4392
4392
|
* Create a new Amazon client.
|
|
4393
4393
|
*
|
|
@@ -4604,7 +4604,7 @@ interface ShopeeMarket {
|
|
|
4604
4604
|
/**
|
|
4605
4605
|
* Response from the /v1/shopee/markets endpoint.
|
|
4606
4606
|
*/
|
|
4607
|
-
interface MarketsResponse$
|
|
4607
|
+
interface MarketsResponse$5 {
|
|
4608
4608
|
markets: ShopeeMarket[];
|
|
4609
4609
|
}
|
|
4610
4610
|
/** Parameters for searching Shopee products. */
|
|
@@ -4679,7 +4679,7 @@ interface ShopeeCategoriesParams {
|
|
|
4679
4679
|
* const cat = await client.shopee.search.categoryItems(100001, { market: "sg" });
|
|
4680
4680
|
* ```
|
|
4681
4681
|
*/
|
|
4682
|
-
declare class SearchClient$
|
|
4682
|
+
declare class SearchClient$6 {
|
|
4683
4683
|
private readonly client;
|
|
4684
4684
|
constructor(client: BaseClient);
|
|
4685
4685
|
/**
|
|
@@ -4802,7 +4802,7 @@ declare class ReviewsClient {
|
|
|
4802
4802
|
* }
|
|
4803
4803
|
* ```
|
|
4804
4804
|
*/
|
|
4805
|
-
declare class ReferenceClient$
|
|
4805
|
+
declare class ReferenceClient$6 {
|
|
4806
4806
|
private readonly client;
|
|
4807
4807
|
constructor(client: BaseClient);
|
|
4808
4808
|
/**
|
|
@@ -4810,7 +4810,7 @@ declare class ReferenceClient$4 {
|
|
|
4810
4810
|
*
|
|
4811
4811
|
* @returns Markets response with all supported Shopee markets (0 credits).
|
|
4812
4812
|
*/
|
|
4813
|
-
markets(): Promise<MarketsResponse$
|
|
4813
|
+
markets(): Promise<MarketsResponse$5>;
|
|
4814
4814
|
/**
|
|
4815
4815
|
* Get the full category tree for a Shopee market.
|
|
4816
4816
|
*
|
|
@@ -4862,13 +4862,13 @@ declare class ReferenceClient$4 {
|
|
|
4862
4862
|
*/
|
|
4863
4863
|
declare class ShopeeClient {
|
|
4864
4864
|
/** Client for keyword search and category-item listing */
|
|
4865
|
-
readonly search: SearchClient$
|
|
4865
|
+
readonly search: SearchClient$6;
|
|
4866
4866
|
/** Client for full product detail pages */
|
|
4867
4867
|
readonly products: ProductsClient;
|
|
4868
4868
|
/** Client for product reviews and rating summaries */
|
|
4869
4869
|
readonly reviews: ReviewsClient;
|
|
4870
4870
|
/** Client for reference data (markets, category tree) */
|
|
4871
|
-
readonly reference: ReferenceClient$
|
|
4871
|
+
readonly reference: ReferenceClient$6;
|
|
4872
4872
|
/**
|
|
4873
4873
|
* Create a new Shopee client.
|
|
4874
4874
|
*
|
|
@@ -5398,7 +5398,7 @@ interface RegionInfo {
|
|
|
5398
5398
|
name: string;
|
|
5399
5399
|
}
|
|
5400
5400
|
/** Response from the /regions endpoint. */
|
|
5401
|
-
interface RegionsResponse$
|
|
5401
|
+
interface RegionsResponse$2 {
|
|
5402
5402
|
regions: RegionInfo[];
|
|
5403
5403
|
}
|
|
5404
5404
|
/** Options for the user profile endpoint. */
|
|
@@ -5714,7 +5714,7 @@ declare class VideosClient$1 {
|
|
|
5714
5714
|
* const users = await client.tiktok.search.users({ query: "skincare" });
|
|
5715
5715
|
* ```
|
|
5716
5716
|
*/
|
|
5717
|
-
declare class SearchClient$
|
|
5717
|
+
declare class SearchClient$5 {
|
|
5718
5718
|
private readonly client;
|
|
5719
5719
|
constructor(client: BaseClient);
|
|
5720
5720
|
/**
|
|
@@ -5889,7 +5889,7 @@ declare class TrendingClient$1 {
|
|
|
5889
5889
|
* }
|
|
5890
5890
|
* ```
|
|
5891
5891
|
*/
|
|
5892
|
-
declare class AdsClient {
|
|
5892
|
+
declare class AdsClient$1 {
|
|
5893
5893
|
private readonly client;
|
|
5894
5894
|
constructor(client: BaseClient);
|
|
5895
5895
|
/**
|
|
@@ -5920,7 +5920,7 @@ declare class AdsClient {
|
|
|
5920
5920
|
* }
|
|
5921
5921
|
* ```
|
|
5922
5922
|
*/
|
|
5923
|
-
declare class ReferenceClient$
|
|
5923
|
+
declare class ReferenceClient$5 {
|
|
5924
5924
|
private readonly client;
|
|
5925
5925
|
constructor(client: BaseClient);
|
|
5926
5926
|
/**
|
|
@@ -5928,7 +5928,7 @@ declare class ReferenceClient$3 {
|
|
|
5928
5928
|
*
|
|
5929
5929
|
* @returns The regions response with all supported content regions.
|
|
5930
5930
|
*/
|
|
5931
|
-
regions(): Promise<RegionsResponse$
|
|
5931
|
+
regions(): Promise<RegionsResponse$2>;
|
|
5932
5932
|
/**
|
|
5933
5933
|
* Check the health of the TikTok scraper service.
|
|
5934
5934
|
*
|
|
@@ -5985,7 +5985,7 @@ declare class TikTokClient {
|
|
|
5985
5985
|
/** Client for video detail, comments, replies, related, transcript, oEmbed */
|
|
5986
5986
|
readonly videos: VideosClient$1;
|
|
5987
5987
|
/** Client for keyword search across videos, users, and hashtags */
|
|
5988
|
-
readonly search: SearchClient$
|
|
5988
|
+
readonly search: SearchClient$5;
|
|
5989
5989
|
/** Client for sound/music detail and videos using a sound */
|
|
5990
5990
|
readonly music: MusicClient$1;
|
|
5991
5991
|
/** Client for hashtag detail and tagged videos */
|
|
@@ -5993,9 +5993,9 @@ declare class TikTokClient {
|
|
|
5993
5993
|
/** Client for trending videos, hashtags, and songs */
|
|
5994
5994
|
readonly trending: TrendingClient$1;
|
|
5995
5995
|
/** Client for the Commercial Content Library (ad transparency) */
|
|
5996
|
-
readonly ads: AdsClient;
|
|
5996
|
+
readonly ads: AdsClient$1;
|
|
5997
5997
|
/** Client for reference data (regions) and service health */
|
|
5998
|
-
readonly reference: ReferenceClient$
|
|
5998
|
+
readonly reference: ReferenceClient$5;
|
|
5999
5999
|
/**
|
|
6000
6000
|
* Create a new TikTok client.
|
|
6001
6001
|
*
|
|
@@ -6028,7 +6028,7 @@ interface EbayPrice {
|
|
|
6028
6028
|
/**
|
|
6029
6029
|
* Page-number pagination (eBay listings use 1-based `_pgn` numbers).
|
|
6030
6030
|
*/
|
|
6031
|
-
interface Pagination {
|
|
6031
|
+
interface Pagination$1 {
|
|
6032
6032
|
/** Current page number (1-indexed) */
|
|
6033
6033
|
current_page: number;
|
|
6034
6034
|
/** Results per page, if known */
|
|
@@ -6041,7 +6041,7 @@ interface Pagination {
|
|
|
6041
6041
|
/**
|
|
6042
6042
|
* A single supported marketplace (for /markets).
|
|
6043
6043
|
*/
|
|
6044
|
-
interface MarketInfo$
|
|
6044
|
+
interface MarketInfo$3 {
|
|
6045
6045
|
/** Market code (e.g. "US", "GB", "DE") */
|
|
6046
6046
|
code: string;
|
|
6047
6047
|
/** eBay domain suffix (e.g. "com", "co.uk") */
|
|
@@ -6220,7 +6220,7 @@ interface FeedbackBreakdown {
|
|
|
6220
6220
|
/**
|
|
6221
6221
|
* A seller profile.
|
|
6222
6222
|
*/
|
|
6223
|
-
interface Seller {
|
|
6223
|
+
interface Seller$1 {
|
|
6224
6224
|
username: string;
|
|
6225
6225
|
url: string | null;
|
|
6226
6226
|
store_name: string | null;
|
|
@@ -6279,14 +6279,14 @@ interface AutocompleteSuggestion {
|
|
|
6279
6279
|
value: string;
|
|
6280
6280
|
}
|
|
6281
6281
|
/** Response from the /search and /completed endpoints. */
|
|
6282
|
-
interface SearchResponse$
|
|
6282
|
+
interface SearchResponse$4 {
|
|
6283
6283
|
query: string | null;
|
|
6284
6284
|
domain: string;
|
|
6285
6285
|
category_id: string | null;
|
|
6286
6286
|
sold: boolean;
|
|
6287
6287
|
results: SearchResult$1[];
|
|
6288
6288
|
facets: Record<string, string[]>;
|
|
6289
|
-
pagination: Pagination;
|
|
6289
|
+
pagination: Pagination$1;
|
|
6290
6290
|
scraped_utc: number | null;
|
|
6291
6291
|
scraped_at: string | null;
|
|
6292
6292
|
}
|
|
@@ -6298,14 +6298,14 @@ interface ItemDetailResponse {
|
|
|
6298
6298
|
/** Response from the /sellers/{username} endpoint. */
|
|
6299
6299
|
interface SellerProfileResponse {
|
|
6300
6300
|
domain: string;
|
|
6301
|
-
seller: Seller;
|
|
6301
|
+
seller: Seller$1;
|
|
6302
6302
|
}
|
|
6303
6303
|
/** Response from the /sellers/{username}/items endpoint. */
|
|
6304
6304
|
interface SellerItemsResponse {
|
|
6305
6305
|
domain: string;
|
|
6306
6306
|
username: string;
|
|
6307
6307
|
results: SearchResult$1[];
|
|
6308
|
-
pagination: Pagination;
|
|
6308
|
+
pagination: Pagination$1;
|
|
6309
6309
|
scraped_utc: number | null;
|
|
6310
6310
|
scraped_at: string | null;
|
|
6311
6311
|
}
|
|
@@ -6314,7 +6314,7 @@ interface SellerFeedbackResponse {
|
|
|
6314
6314
|
domain: string;
|
|
6315
6315
|
username: string;
|
|
6316
6316
|
feedback: FeedbackEntry[];
|
|
6317
|
-
pagination: Pagination;
|
|
6317
|
+
pagination: Pagination$1;
|
|
6318
6318
|
scraped_utc: number | null;
|
|
6319
6319
|
scraped_at: string | null;
|
|
6320
6320
|
}
|
|
@@ -6327,7 +6327,7 @@ interface ReviewsResponse {
|
|
|
6327
6327
|
ratings_total: number | null;
|
|
6328
6328
|
histogram: RatingHistogram | null;
|
|
6329
6329
|
reviews: Review[];
|
|
6330
|
-
pagination: Pagination;
|
|
6330
|
+
pagination: Pagination$1;
|
|
6331
6331
|
scraped_utc: number | null;
|
|
6332
6332
|
scraped_at: string | null;
|
|
6333
6333
|
}
|
|
@@ -6337,22 +6337,22 @@ interface CategoryResponse {
|
|
|
6337
6337
|
category_id: string;
|
|
6338
6338
|
results: SearchResult$1[];
|
|
6339
6339
|
facets: Record<string, string[]>;
|
|
6340
|
-
pagination: Pagination;
|
|
6340
|
+
pagination: Pagination$1;
|
|
6341
6341
|
scraped_utc: number | null;
|
|
6342
6342
|
scraped_at: string | null;
|
|
6343
6343
|
}
|
|
6344
6344
|
/** Response from the /autocomplete endpoint. */
|
|
6345
|
-
interface AutocompleteResponse$
|
|
6345
|
+
interface AutocompleteResponse$3 {
|
|
6346
6346
|
query: string;
|
|
6347
6347
|
domain: string;
|
|
6348
6348
|
suggestions: AutocompleteSuggestion[];
|
|
6349
6349
|
}
|
|
6350
6350
|
/** Response from the /markets endpoint. */
|
|
6351
|
-
interface MarketsResponse$
|
|
6352
|
-
markets: MarketInfo$
|
|
6351
|
+
interface MarketsResponse$4 {
|
|
6352
|
+
markets: MarketInfo$3[];
|
|
6353
6353
|
}
|
|
6354
6354
|
/** Response from the /categories endpoint. */
|
|
6355
|
-
interface CategoriesResponse$
|
|
6355
|
+
interface CategoriesResponse$2 {
|
|
6356
6356
|
categories: CategoryInfo[];
|
|
6357
6357
|
}
|
|
6358
6358
|
/** Sort order for search / listing endpoints. */
|
|
@@ -6489,7 +6489,7 @@ interface EbayAutocompleteParams {
|
|
|
6489
6489
|
* const suggestions = await client.ebay.search.autocomplete("ipho");
|
|
6490
6490
|
* ```
|
|
6491
6491
|
*/
|
|
6492
|
-
declare class SearchClient$
|
|
6492
|
+
declare class SearchClient$4 {
|
|
6493
6493
|
private readonly client;
|
|
6494
6494
|
constructor(client: BaseClient);
|
|
6495
6495
|
/**
|
|
@@ -6500,14 +6500,14 @@ declare class SearchClient$2 {
|
|
|
6500
6500
|
* @throws AuthenticationError - If the API key is invalid.
|
|
6501
6501
|
* @throws ValidationError - If the parameters are invalid.
|
|
6502
6502
|
*/
|
|
6503
|
-
search(params: EbaySearchParams): Promise<SearchResponse$
|
|
6503
|
+
search(params: EbaySearchParams): Promise<SearchResponse$4>;
|
|
6504
6504
|
/**
|
|
6505
6505
|
* Search completed / sold listings — eBay's sold-price history.
|
|
6506
6506
|
*
|
|
6507
6507
|
* @param params - Search parameters including query, filters, and pagination.
|
|
6508
6508
|
* @returns Search results (with `sold: true`), facets, and pagination.
|
|
6509
6509
|
*/
|
|
6510
|
-
completed(params: EbayCompletedParams): Promise<SearchResponse$
|
|
6510
|
+
completed(params: EbayCompletedParams): Promise<SearchResponse$4>;
|
|
6511
6511
|
/**
|
|
6512
6512
|
* Get eBay keyword autocomplete suggestions.
|
|
6513
6513
|
*
|
|
@@ -6515,7 +6515,7 @@ declare class SearchClient$2 {
|
|
|
6515
6515
|
* @param options - Optional parameters (domain).
|
|
6516
6516
|
* @returns Autocomplete suggestions.
|
|
6517
6517
|
*/
|
|
6518
|
-
autocomplete(query: string, options?: EbayAutocompleteParams): Promise<AutocompleteResponse$
|
|
6518
|
+
autocomplete(query: string, options?: EbayAutocompleteParams): Promise<AutocompleteResponse$3>;
|
|
6519
6519
|
}
|
|
6520
6520
|
|
|
6521
6521
|
/**
|
|
@@ -6580,7 +6580,7 @@ declare class ItemsClient {
|
|
|
6580
6580
|
* const feedback = await client.ebay.sellers.feedback("musicmagpie");
|
|
6581
6581
|
* ```
|
|
6582
6582
|
*/
|
|
6583
|
-
declare class SellersClient {
|
|
6583
|
+
declare class SellersClient$1 {
|
|
6584
6584
|
private readonly client;
|
|
6585
6585
|
constructor(client: BaseClient);
|
|
6586
6586
|
/**
|
|
@@ -6648,7 +6648,7 @@ declare class CategoriesClient {
|
|
|
6648
6648
|
*
|
|
6649
6649
|
* @returns Categories response with all category aliases.
|
|
6650
6650
|
*/
|
|
6651
|
-
list(): Promise<CategoriesResponse$
|
|
6651
|
+
list(): Promise<CategoriesResponse$2>;
|
|
6652
6652
|
}
|
|
6653
6653
|
|
|
6654
6654
|
/**
|
|
@@ -6670,7 +6670,7 @@ declare class CategoriesClient {
|
|
|
6670
6670
|
* }
|
|
6671
6671
|
* ```
|
|
6672
6672
|
*/
|
|
6673
|
-
declare class ReferenceClient$
|
|
6673
|
+
declare class ReferenceClient$4 {
|
|
6674
6674
|
private readonly client;
|
|
6675
6675
|
constructor(client: BaseClient);
|
|
6676
6676
|
/**
|
|
@@ -6678,7 +6678,7 @@ declare class ReferenceClient$2 {
|
|
|
6678
6678
|
*
|
|
6679
6679
|
* @returns Markets response with all supported marketplaces.
|
|
6680
6680
|
*/
|
|
6681
|
-
markets(): Promise<MarketsResponse$
|
|
6681
|
+
markets(): Promise<MarketsResponse$4>;
|
|
6682
6682
|
}
|
|
6683
6683
|
|
|
6684
6684
|
/**
|
|
@@ -6725,15 +6725,15 @@ declare class ReferenceClient$2 {
|
|
|
6725
6725
|
*/
|
|
6726
6726
|
declare class EbayClient {
|
|
6727
6727
|
/** Client for active search, completed/sold search, and autocomplete */
|
|
6728
|
-
readonly search: SearchClient$
|
|
6728
|
+
readonly search: SearchClient$4;
|
|
6729
6729
|
/** Client for item detail and catalog product reviews */
|
|
6730
6730
|
readonly items: ItemsClient;
|
|
6731
6731
|
/** Client for seller profile, items, and feedback */
|
|
6732
|
-
readonly sellers: SellersClient;
|
|
6732
|
+
readonly sellers: SellersClient$1;
|
|
6733
6733
|
/** Client for category browse and the reference category list */
|
|
6734
6734
|
readonly categories: CategoriesClient;
|
|
6735
6735
|
/** Client for reference data (markets) */
|
|
6736
|
-
readonly reference: ReferenceClient$
|
|
6736
|
+
readonly reference: ReferenceClient$4;
|
|
6737
6737
|
/**
|
|
6738
6738
|
* Create a new eBay client.
|
|
6739
6739
|
*
|
|
@@ -7228,7 +7228,7 @@ interface SearchChip {
|
|
|
7228
7228
|
/**
|
|
7229
7229
|
* A page of search results.
|
|
7230
7230
|
*/
|
|
7231
|
-
interface SearchResponse$
|
|
7231
|
+
interface SearchResponse$3 {
|
|
7232
7232
|
query: string | null;
|
|
7233
7233
|
results: SearchResult[];
|
|
7234
7234
|
total_results: number | null;
|
|
@@ -7243,7 +7243,7 @@ interface SearchResponse$1 {
|
|
|
7243
7243
|
/**
|
|
7244
7244
|
* Keyword suggestions for a query prefix.
|
|
7245
7245
|
*/
|
|
7246
|
-
interface AutocompleteResponse$
|
|
7246
|
+
interface AutocompleteResponse$2 {
|
|
7247
7247
|
query: string;
|
|
7248
7248
|
suggestions: string[];
|
|
7249
7249
|
}
|
|
@@ -7447,7 +7447,7 @@ interface LiveChatResponse {
|
|
|
7447
7447
|
/**
|
|
7448
7448
|
* Response from the /categories endpoint.
|
|
7449
7449
|
*/
|
|
7450
|
-
interface CategoriesResponse {
|
|
7450
|
+
interface CategoriesResponse$1 {
|
|
7451
7451
|
gl: string;
|
|
7452
7452
|
categories: ReferenceRow[];
|
|
7453
7453
|
}
|
|
@@ -7460,13 +7460,13 @@ interface LanguagesResponse {
|
|
|
7460
7460
|
/**
|
|
7461
7461
|
* Response from the /regions endpoint.
|
|
7462
7462
|
*/
|
|
7463
|
-
interface RegionsResponse {
|
|
7463
|
+
interface RegionsResponse$1 {
|
|
7464
7464
|
regions: ReferenceRow[];
|
|
7465
7465
|
}
|
|
7466
7466
|
/**
|
|
7467
7467
|
* A single geo-targeted scraper market (for /markets).
|
|
7468
7468
|
*/
|
|
7469
|
-
interface MarketInfo$
|
|
7469
|
+
interface MarketInfo$2 {
|
|
7470
7470
|
/** Content region code (e.g. "US") */
|
|
7471
7471
|
gl: string;
|
|
7472
7472
|
/** UI language code (e.g. "en") */
|
|
@@ -7477,8 +7477,8 @@ interface MarketInfo$1 {
|
|
|
7477
7477
|
/**
|
|
7478
7478
|
* Response from the /markets endpoint.
|
|
7479
7479
|
*/
|
|
7480
|
-
interface MarketsResponse$
|
|
7481
|
-
markets: MarketInfo$
|
|
7480
|
+
interface MarketsResponse$3 {
|
|
7481
|
+
markets: MarketInfo$2[];
|
|
7482
7482
|
}
|
|
7483
7483
|
/** Result-type filter for search. */
|
|
7484
7484
|
type YoutubeSearchType = "video" | "channel" | "playlist" | "movie" | "all";
|
|
@@ -7668,7 +7668,7 @@ interface YoutubeCategoriesParams {
|
|
|
7668
7668
|
* const suggestions = await client.youtube.search.autocomplete("lofi");
|
|
7669
7669
|
* ```
|
|
7670
7670
|
*/
|
|
7671
|
-
declare class SearchClient$
|
|
7671
|
+
declare class SearchClient$3 {
|
|
7672
7672
|
private readonly client;
|
|
7673
7673
|
constructor(client: BaseClient);
|
|
7674
7674
|
/**
|
|
@@ -7679,7 +7679,7 @@ declare class SearchClient$1 {
|
|
|
7679
7679
|
* @throws AuthenticationError - If the API key is invalid.
|
|
7680
7680
|
* @throws ValidationError - If the parameters are invalid.
|
|
7681
7681
|
*/
|
|
7682
|
-
search(params: YoutubeSearchParams): Promise<SearchResponse$
|
|
7682
|
+
search(params: YoutubeSearchParams): Promise<SearchResponse$3>;
|
|
7683
7683
|
/**
|
|
7684
7684
|
* Get YouTube keyword autocomplete suggestions.
|
|
7685
7685
|
*
|
|
@@ -7687,7 +7687,7 @@ declare class SearchClient$1 {
|
|
|
7687
7687
|
* @param options - Optional region parameters (gl, hl).
|
|
7688
7688
|
* @returns Autocomplete suggestions.
|
|
7689
7689
|
*/
|
|
7690
|
-
autocomplete(query: string, options?: YoutubeAutocompleteParams): Promise<AutocompleteResponse$
|
|
7690
|
+
autocomplete(query: string, options?: YoutubeAutocompleteParams): Promise<AutocompleteResponse$2>;
|
|
7691
7691
|
}
|
|
7692
7692
|
|
|
7693
7693
|
/**
|
|
@@ -7893,7 +7893,7 @@ declare class ChannelsClient {
|
|
|
7893
7893
|
* @param options - The required query plus optional continuation and region.
|
|
7894
7894
|
* @returns A page of search results scoped to the channel.
|
|
7895
7895
|
*/
|
|
7896
|
-
search(channelId: string, options: YoutubeChannelSearchParams): Promise<SearchResponse$
|
|
7896
|
+
search(channelId: string, options: YoutubeChannelSearchParams): Promise<SearchResponse$3>;
|
|
7897
7897
|
/**
|
|
7898
7898
|
* Resolve a @handle or URL to canonical YouTube ids.
|
|
7899
7899
|
*
|
|
@@ -8120,7 +8120,7 @@ declare class MusicClient {
|
|
|
8120
8120
|
* @param params - The required query plus optional continuation and region.
|
|
8121
8121
|
* @returns A page of search results with a continuation token.
|
|
8122
8122
|
*/
|
|
8123
|
-
search(params: YoutubeMusicSearchParams): Promise<SearchResponse$
|
|
8123
|
+
search(params: YoutubeMusicSearchParams): Promise<SearchResponse$3>;
|
|
8124
8124
|
}
|
|
8125
8125
|
|
|
8126
8126
|
/**
|
|
@@ -8143,7 +8143,7 @@ declare class MusicClient {
|
|
|
8143
8143
|
* const markets = await client.youtube.reference.markets();
|
|
8144
8144
|
* ```
|
|
8145
8145
|
*/
|
|
8146
|
-
declare class ReferenceClient$
|
|
8146
|
+
declare class ReferenceClient$3 {
|
|
8147
8147
|
private readonly client;
|
|
8148
8148
|
constructor(client: BaseClient);
|
|
8149
8149
|
/**
|
|
@@ -8152,7 +8152,7 @@ declare class ReferenceClient$1 {
|
|
|
8152
8152
|
* @param options - Optional content region (default: "US").
|
|
8153
8153
|
* @returns The categories for the region.
|
|
8154
8154
|
*/
|
|
8155
|
-
categories(options?: YoutubeCategoriesParams): Promise<CategoriesResponse>;
|
|
8155
|
+
categories(options?: YoutubeCategoriesParams): Promise<CategoriesResponse$1>;
|
|
8156
8156
|
/**
|
|
8157
8157
|
* List supported UI languages (hl codes).
|
|
8158
8158
|
*
|
|
@@ -8164,13 +8164,13 @@ declare class ReferenceClient$1 {
|
|
|
8164
8164
|
*
|
|
8165
8165
|
* @returns The supported content regions.
|
|
8166
8166
|
*/
|
|
8167
|
-
regions(): Promise<RegionsResponse>;
|
|
8167
|
+
regions(): Promise<RegionsResponse$1>;
|
|
8168
8168
|
/**
|
|
8169
8169
|
* List the regions the scraper explicitly geo-targets (proxy-pinned).
|
|
8170
8170
|
*
|
|
8171
8171
|
* @returns The supported scraper markets.
|
|
8172
8172
|
*/
|
|
8173
|
-
markets(): Promise<MarketsResponse$
|
|
8173
|
+
markets(): Promise<MarketsResponse$3>;
|
|
8174
8174
|
}
|
|
8175
8175
|
|
|
8176
8176
|
/**
|
|
@@ -8221,7 +8221,7 @@ declare class ReferenceClient$1 {
|
|
|
8221
8221
|
*/
|
|
8222
8222
|
declare class YoutubeClient {
|
|
8223
8223
|
/** Client for full-matrix search and keyword autocomplete */
|
|
8224
|
-
readonly search: SearchClient$
|
|
8224
|
+
readonly search: SearchClient$3;
|
|
8225
8225
|
/** Client for video detail, comments, transcript, captions, streams, live chat, batch, and oEmbed */
|
|
8226
8226
|
readonly videos: VideosClient;
|
|
8227
8227
|
/** Client for channel detail, tab feeds, about, subscriber count, search, and resolve */
|
|
@@ -8237,7 +8237,7 @@ declare class YoutubeClient {
|
|
|
8237
8237
|
/** Client for YouTube Music search */
|
|
8238
8238
|
readonly music: MusicClient;
|
|
8239
8239
|
/** Client for reference data (categories, languages, regions, markets) */
|
|
8240
|
-
readonly reference: ReferenceClient$
|
|
8240
|
+
readonly reference: ReferenceClient$3;
|
|
8241
8241
|
/**
|
|
8242
8242
|
* Create a new YouTube client.
|
|
8243
8243
|
*
|
|
@@ -8263,7 +8263,7 @@ interface Coordinate {
|
|
|
8263
8263
|
lon?: number | null;
|
|
8264
8264
|
}
|
|
8265
8265
|
/** A postal address with an optional coordinate. */
|
|
8266
|
-
interface Address {
|
|
8266
|
+
interface Address$1 {
|
|
8267
8267
|
line?: string | null;
|
|
8268
8268
|
city?: string | null;
|
|
8269
8269
|
state?: string | null;
|
|
@@ -8275,7 +8275,7 @@ interface Address {
|
|
|
8275
8275
|
coordinate?: Coordinate | null;
|
|
8276
8276
|
}
|
|
8277
8277
|
/** A property photo with multiple resolutions. */
|
|
8278
|
-
interface Photo {
|
|
8278
|
+
interface Photo$1 {
|
|
8279
8279
|
href?: string | null;
|
|
8280
8280
|
href_high?: string | null;
|
|
8281
8281
|
href_med?: string | null;
|
|
@@ -8297,10 +8297,10 @@ interface Office {
|
|
|
8297
8297
|
href?: string | null;
|
|
8298
8298
|
logo?: string | null;
|
|
8299
8299
|
phones?: Phone[];
|
|
8300
|
-
address?: Address | null;
|
|
8300
|
+
address?: Address$1 | null;
|
|
8301
8301
|
}
|
|
8302
8302
|
/** A listing agent. */
|
|
8303
|
-
interface Agent {
|
|
8303
|
+
interface Agent$1 {
|
|
8304
8304
|
agent_id?: string | null;
|
|
8305
8305
|
name?: string | null;
|
|
8306
8306
|
first_name?: string | null;
|
|
@@ -8317,7 +8317,7 @@ interface Agent {
|
|
|
8317
8317
|
state_license?: string | null;
|
|
8318
8318
|
}
|
|
8319
8319
|
/** A scheduled open house. */
|
|
8320
|
-
interface OpenHouse {
|
|
8320
|
+
interface OpenHouse$1 {
|
|
8321
8321
|
start_utc?: string | null;
|
|
8322
8322
|
start_at?: string | null;
|
|
8323
8323
|
end_utc?: string | null;
|
|
@@ -8327,7 +8327,7 @@ interface OpenHouse {
|
|
|
8327
8327
|
href?: string | null;
|
|
8328
8328
|
}
|
|
8329
8329
|
/** A nearby school. */
|
|
8330
|
-
interface School {
|
|
8330
|
+
interface School$1 {
|
|
8331
8331
|
name?: string | null;
|
|
8332
8332
|
rating?: number | null;
|
|
8333
8333
|
education_levels?: string[];
|
|
@@ -8377,7 +8377,7 @@ interface Flags {
|
|
|
8377
8377
|
is_coming_soon?: boolean | null;
|
|
8378
8378
|
}
|
|
8379
8379
|
/** A property as returned by /search. */
|
|
8380
|
-
interface Property {
|
|
8380
|
+
interface Property$1 {
|
|
8381
8381
|
property_id?: string | null;
|
|
8382
8382
|
listing_id?: string | null;
|
|
8383
8383
|
mls_number?: string | null;
|
|
@@ -8410,11 +8410,11 @@ interface Property {
|
|
|
8410
8410
|
garage?: number | null;
|
|
8411
8411
|
rooms?: number | null;
|
|
8412
8412
|
parking_spaces?: number | null;
|
|
8413
|
-
address?: Address | null;
|
|
8413
|
+
address?: Address$1 | null;
|
|
8414
8414
|
description_text?: string | null;
|
|
8415
8415
|
primary_photo?: string | null;
|
|
8416
8416
|
photo_count?: number | null;
|
|
8417
|
-
photos?: Photo[];
|
|
8417
|
+
photos?: Photo$1[];
|
|
8418
8418
|
virtual_tours?: string[];
|
|
8419
8419
|
videos?: string[];
|
|
8420
8420
|
flags?: Flags | null;
|
|
@@ -8424,18 +8424,18 @@ interface Property {
|
|
|
8424
8424
|
last_update_utc?: string | null;
|
|
8425
8425
|
last_update_at?: string | null;
|
|
8426
8426
|
days_on_market?: number | null;
|
|
8427
|
-
agents?: Agent[];
|
|
8427
|
+
agents?: Agent$1[];
|
|
8428
8428
|
source_mls_id?: string | null;
|
|
8429
8429
|
source_mls_name?: string | null;
|
|
8430
|
-
open_houses?: OpenHouse[];
|
|
8430
|
+
open_houses?: OpenHouse$1[];
|
|
8431
8431
|
}
|
|
8432
8432
|
/** A property as returned by /properties/{property_id} (Property + extras). */
|
|
8433
|
-
interface PropertyDetail extends Property {
|
|
8433
|
+
interface PropertyDetail extends Property$1 {
|
|
8434
8434
|
details?: DetailGroup[];
|
|
8435
8435
|
amenities?: string[];
|
|
8436
8436
|
tax_history?: TaxRecord[];
|
|
8437
8437
|
price_history?: PriceEvent[];
|
|
8438
|
-
schools?: School[];
|
|
8438
|
+
schools?: School$1[];
|
|
8439
8439
|
estimates?: Estimate[];
|
|
8440
8440
|
}
|
|
8441
8441
|
/** A single location suggestion. */
|
|
@@ -8453,7 +8453,7 @@ interface Suggestion {
|
|
|
8453
8453
|
market?: string | null;
|
|
8454
8454
|
}
|
|
8455
8455
|
/** A single supported market (for /markets). */
|
|
8456
|
-
interface MarketInfo {
|
|
8456
|
+
interface MarketInfo$1 {
|
|
8457
8457
|
code: string;
|
|
8458
8458
|
domain: string;
|
|
8459
8459
|
country: string;
|
|
@@ -8462,24 +8462,24 @@ interface MarketInfo {
|
|
|
8462
8462
|
name: string;
|
|
8463
8463
|
}
|
|
8464
8464
|
/** Response from the /autocomplete endpoint. */
|
|
8465
|
-
interface AutocompleteResponse {
|
|
8465
|
+
interface AutocompleteResponse$1 {
|
|
8466
8466
|
market: string;
|
|
8467
8467
|
query: string;
|
|
8468
8468
|
suggestions: Suggestion[];
|
|
8469
8469
|
}
|
|
8470
8470
|
/** Response from the /search endpoint. */
|
|
8471
|
-
interface SearchResponse {
|
|
8471
|
+
interface SearchResponse$2 {
|
|
8472
8472
|
market: string;
|
|
8473
8473
|
country: string;
|
|
8474
8474
|
total: number;
|
|
8475
8475
|
count: number;
|
|
8476
8476
|
page: number;
|
|
8477
8477
|
total_pages: number;
|
|
8478
|
-
results: Property[];
|
|
8478
|
+
results: Property$1[];
|
|
8479
8479
|
}
|
|
8480
8480
|
/** Response from the /markets endpoint. */
|
|
8481
|
-
interface MarketsResponse {
|
|
8482
|
-
markets: MarketInfo[];
|
|
8481
|
+
interface MarketsResponse$2 {
|
|
8482
|
+
markets: MarketInfo$1[];
|
|
8483
8483
|
}
|
|
8484
8484
|
/** Supported market codes. */
|
|
8485
8485
|
type RealtorMarket = "us" | "ca";
|
|
@@ -8556,7 +8556,7 @@ interface RealtorPropertyOptions {
|
|
|
8556
8556
|
* const suggestions = await client.realtor.search.autocomplete("Miami");
|
|
8557
8557
|
* ```
|
|
8558
8558
|
*/
|
|
8559
|
-
declare class SearchClient {
|
|
8559
|
+
declare class SearchClient$2 {
|
|
8560
8560
|
private readonly client;
|
|
8561
8561
|
constructor(client: BaseClient);
|
|
8562
8562
|
/**
|
|
@@ -8569,7 +8569,7 @@ declare class SearchClient {
|
|
|
8569
8569
|
* @throws AuthenticationError - If the API key is invalid.
|
|
8570
8570
|
* @throws ValidationError - If the parameters are invalid.
|
|
8571
8571
|
*/
|
|
8572
|
-
search(location?: string, options?: RealtorSearchOptions): Promise<SearchResponse>;
|
|
8572
|
+
search(location?: string, options?: RealtorSearchOptions): Promise<SearchResponse$2>;
|
|
8573
8573
|
/**
|
|
8574
8574
|
* Get location autocomplete suggestions.
|
|
8575
8575
|
*
|
|
@@ -8577,7 +8577,7 @@ declare class SearchClient {
|
|
|
8577
8577
|
* @param options - Optional parameters (market, limit).
|
|
8578
8578
|
* @returns Autocomplete suggestions.
|
|
8579
8579
|
*/
|
|
8580
|
-
autocomplete(query: string, options?: RealtorAutocompleteOptions): Promise<AutocompleteResponse>;
|
|
8580
|
+
autocomplete(query: string, options?: RealtorAutocompleteOptions): Promise<AutocompleteResponse$1>;
|
|
8581
8581
|
}
|
|
8582
8582
|
|
|
8583
8583
|
/**
|
|
@@ -8597,7 +8597,7 @@ declare class SearchClient {
|
|
|
8597
8597
|
* console.log(detail.address?.line, detail.list_price);
|
|
8598
8598
|
* ```
|
|
8599
8599
|
*/
|
|
8600
|
-
declare class PropertiesClient {
|
|
8600
|
+
declare class PropertiesClient$1 {
|
|
8601
8601
|
private readonly client;
|
|
8602
8602
|
constructor(client: BaseClient);
|
|
8603
8603
|
/**
|
|
@@ -8630,7 +8630,7 @@ declare class PropertiesClient {
|
|
|
8630
8630
|
* }
|
|
8631
8631
|
* ```
|
|
8632
8632
|
*/
|
|
8633
|
-
declare class ReferenceClient {
|
|
8633
|
+
declare class ReferenceClient$2 {
|
|
8634
8634
|
private readonly client;
|
|
8635
8635
|
constructor(client: BaseClient);
|
|
8636
8636
|
/**
|
|
@@ -8638,7 +8638,7 @@ declare class ReferenceClient {
|
|
|
8638
8638
|
*
|
|
8639
8639
|
* @returns Markets response with all supported markets.
|
|
8640
8640
|
*/
|
|
8641
|
-
listMarkets(): Promise<MarketsResponse>;
|
|
8641
|
+
listMarkets(): Promise<MarketsResponse$2>;
|
|
8642
8642
|
}
|
|
8643
8643
|
|
|
8644
8644
|
/**
|
|
@@ -8676,11 +8676,11 @@ declare class ReferenceClient {
|
|
|
8676
8676
|
*/
|
|
8677
8677
|
declare class RealtorClient {
|
|
8678
8678
|
/** Client for property search and location autocomplete */
|
|
8679
|
-
readonly search: SearchClient;
|
|
8679
|
+
readonly search: SearchClient$2;
|
|
8680
8680
|
/** Client for full property detail */
|
|
8681
|
-
readonly properties: PropertiesClient;
|
|
8681
|
+
readonly properties: PropertiesClient$1;
|
|
8682
8682
|
/** Client for reference data (markets) */
|
|
8683
|
-
readonly reference: ReferenceClient;
|
|
8683
|
+
readonly reference: ReferenceClient$2;
|
|
8684
8684
|
/**
|
|
8685
8685
|
* Create a new Realtor client.
|
|
8686
8686
|
*
|
|
@@ -8689,6 +8689,1381 @@ declare class RealtorClient {
|
|
|
8689
8689
|
constructor(client: BaseClient);
|
|
8690
8690
|
}
|
|
8691
8691
|
|
|
8692
|
+
/**
|
|
8693
|
+
* TypeScript types for Leboncoin API responses.
|
|
8694
|
+
*
|
|
8695
|
+
* These interfaces mirror the backend `leboncoin_scraper` response schema
|
|
8696
|
+
* field-for-field. Optional / nullable backend fields are typed as
|
|
8697
|
+
* `Type | null`; backend list fields default to `[]` and are typed as arrays.
|
|
8698
|
+
* Every datetime field ships in BOTH the raw Leboncoin form (`*_date`) and an
|
|
8699
|
+
* ISO-8601 UTC string (`*_at`).
|
|
8700
|
+
*/
|
|
8701
|
+
/**
|
|
8702
|
+
* A category-specific spec (vehicle mileage, real-estate DPE, etc.).
|
|
8703
|
+
*/
|
|
8704
|
+
interface Attribute {
|
|
8705
|
+
key: string;
|
|
8706
|
+
key_label: string | null;
|
|
8707
|
+
value: string | null;
|
|
8708
|
+
value_label: string | null;
|
|
8709
|
+
values: string[];
|
|
8710
|
+
values_label: string[];
|
|
8711
|
+
generic: boolean | null;
|
|
8712
|
+
}
|
|
8713
|
+
/**
|
|
8714
|
+
* The location attached to an ad or a seller.
|
|
8715
|
+
*/
|
|
8716
|
+
interface Location {
|
|
8717
|
+
country_id: string | null;
|
|
8718
|
+
region_id: string | null;
|
|
8719
|
+
region_name: string | null;
|
|
8720
|
+
department_id: string | null;
|
|
8721
|
+
department_name: string | null;
|
|
8722
|
+
city: string | null;
|
|
8723
|
+
city_label: string | null;
|
|
8724
|
+
zipcode: string | null;
|
|
8725
|
+
district: string | null;
|
|
8726
|
+
lat: number | null;
|
|
8727
|
+
lng: number | null;
|
|
8728
|
+
source: string | null;
|
|
8729
|
+
provider: string | null;
|
|
8730
|
+
is_shape: boolean | null;
|
|
8731
|
+
}
|
|
8732
|
+
/**
|
|
8733
|
+
* Seller stub embedded in each ad.
|
|
8734
|
+
*/
|
|
8735
|
+
interface Owner {
|
|
8736
|
+
user_id: string | null;
|
|
8737
|
+
store_id: string | null;
|
|
8738
|
+
/** "private" | "pro" */
|
|
8739
|
+
type: string | null;
|
|
8740
|
+
name: string | null;
|
|
8741
|
+
siren: string | null;
|
|
8742
|
+
no_salesmen: boolean | null;
|
|
8743
|
+
activity_sector: string | null;
|
|
8744
|
+
online_store_id: string | null;
|
|
8745
|
+
}
|
|
8746
|
+
/**
|
|
8747
|
+
* An ad's image set.
|
|
8748
|
+
*/
|
|
8749
|
+
interface Images {
|
|
8750
|
+
nb_images: number;
|
|
8751
|
+
thumb_url: string | null;
|
|
8752
|
+
small_url: string | null;
|
|
8753
|
+
urls: string[];
|
|
8754
|
+
urls_thumb: string[];
|
|
8755
|
+
urls_large: string[];
|
|
8756
|
+
}
|
|
8757
|
+
/**
|
|
8758
|
+
* A Leboncoin classified ad (search summary + detail share this shape).
|
|
8759
|
+
*/
|
|
8760
|
+
interface Ad {
|
|
8761
|
+
list_id: number;
|
|
8762
|
+
subject: string;
|
|
8763
|
+
body: string | null;
|
|
8764
|
+
brand: string | null;
|
|
8765
|
+
/** "offer" | "demand" */
|
|
8766
|
+
ad_type: string | null;
|
|
8767
|
+
url: string | null;
|
|
8768
|
+
status: string | null;
|
|
8769
|
+
category_id: string | null;
|
|
8770
|
+
category_name: string | null;
|
|
8771
|
+
price: number[];
|
|
8772
|
+
price_cents: number | null;
|
|
8773
|
+
price_eur: number | null;
|
|
8774
|
+
currency: string;
|
|
8775
|
+
first_publication_date: string | null;
|
|
8776
|
+
first_publication_at: string | null;
|
|
8777
|
+
index_date: string | null;
|
|
8778
|
+
index_at: string | null;
|
|
8779
|
+
expiration_date: string | null;
|
|
8780
|
+
expiration_at: string | null;
|
|
8781
|
+
has_phone: boolean | null;
|
|
8782
|
+
favorites: number | null;
|
|
8783
|
+
images: Images;
|
|
8784
|
+
attributes: Attribute[];
|
|
8785
|
+
location: Location;
|
|
8786
|
+
owner: Owner;
|
|
8787
|
+
/** Ad options / boosts (present in the web payload). */
|
|
8788
|
+
options: Record<string, unknown>;
|
|
8789
|
+
}
|
|
8790
|
+
/**
|
|
8791
|
+
* A seller's aggregated feedback scores.
|
|
8792
|
+
*/
|
|
8793
|
+
interface FeedbackScores {
|
|
8794
|
+
overall_score: number | null;
|
|
8795
|
+
received_count: number | null;
|
|
8796
|
+
category_scores: Record<string, unknown>;
|
|
8797
|
+
}
|
|
8798
|
+
/**
|
|
8799
|
+
* A single pro-store rating review.
|
|
8800
|
+
*/
|
|
8801
|
+
interface StoreRatingReview {
|
|
8802
|
+
author_name: string | null;
|
|
8803
|
+
rating_value: number | null;
|
|
8804
|
+
text: string | null;
|
|
8805
|
+
review_time: string | null;
|
|
8806
|
+
}
|
|
8807
|
+
/**
|
|
8808
|
+
* A Leboncoin seller (private profile or pro store).
|
|
8809
|
+
*/
|
|
8810
|
+
interface Seller {
|
|
8811
|
+
user_id: string;
|
|
8812
|
+
store_id: string | null;
|
|
8813
|
+
online_store_id: string | null;
|
|
8814
|
+
name: string | null;
|
|
8815
|
+
/** "private" | "pro" */
|
|
8816
|
+
account_type: string | null;
|
|
8817
|
+
registered_at: string | null;
|
|
8818
|
+
total_ads: number | null;
|
|
8819
|
+
description: string | null;
|
|
8820
|
+
profile_picture_url: string | null;
|
|
8821
|
+
location: Location;
|
|
8822
|
+
badges: Record<string, unknown>[];
|
|
8823
|
+
feedback: FeedbackScores | null;
|
|
8824
|
+
reply_rate: number | null;
|
|
8825
|
+
reply_time_text: string | null;
|
|
8826
|
+
presence_status: string | null;
|
|
8827
|
+
last_activity: string | null;
|
|
8828
|
+
siren: string | null;
|
|
8829
|
+
siret: string | null;
|
|
8830
|
+
activity_sector: string | null;
|
|
8831
|
+
website_url: string | null;
|
|
8832
|
+
opening_hours: Record<string, unknown> | unknown[] | null;
|
|
8833
|
+
store_rating_value: number | null;
|
|
8834
|
+
store_ratings_total: number | null;
|
|
8835
|
+
store_reviews: StoreRatingReview[];
|
|
8836
|
+
}
|
|
8837
|
+
/**
|
|
8838
|
+
* A reference category.
|
|
8839
|
+
*/
|
|
8840
|
+
interface Category {
|
|
8841
|
+
category_id: string;
|
|
8842
|
+
key: string;
|
|
8843
|
+
label: string;
|
|
8844
|
+
parent_id: string | null;
|
|
8845
|
+
}
|
|
8846
|
+
/**
|
|
8847
|
+
* A reference region.
|
|
8848
|
+
*/
|
|
8849
|
+
interface Region {
|
|
8850
|
+
region_id: string;
|
|
8851
|
+
key: string;
|
|
8852
|
+
name: string;
|
|
8853
|
+
}
|
|
8854
|
+
/**
|
|
8855
|
+
* A reference department.
|
|
8856
|
+
*/
|
|
8857
|
+
interface Department {
|
|
8858
|
+
department_id: string;
|
|
8859
|
+
region_id: string;
|
|
8860
|
+
name: string;
|
|
8861
|
+
}
|
|
8862
|
+
/**
|
|
8863
|
+
* A location autocomplete suggestion.
|
|
8864
|
+
*/
|
|
8865
|
+
interface LocationSuggestion {
|
|
8866
|
+
label: string;
|
|
8867
|
+
location_type: string | null;
|
|
8868
|
+
region_id: string | null;
|
|
8869
|
+
department_id: string | null;
|
|
8870
|
+
city: string | null;
|
|
8871
|
+
zipcode: string | null;
|
|
8872
|
+
lat: number | null;
|
|
8873
|
+
lng: number | null;
|
|
8874
|
+
}
|
|
8875
|
+
/** Response from the /search endpoint. */
|
|
8876
|
+
interface SearchResponse$1 {
|
|
8877
|
+
ads: Ad[];
|
|
8878
|
+
total: number | null;
|
|
8879
|
+
total_all: number | null;
|
|
8880
|
+
total_pro: number | null;
|
|
8881
|
+
total_private: number | null;
|
|
8882
|
+
total_shippable: number | null;
|
|
8883
|
+
max_pages: number | null;
|
|
8884
|
+
page: number;
|
|
8885
|
+
limit: number;
|
|
8886
|
+
/** "api" (finder) or "web" (rendered __NEXT_DATA__) */
|
|
8887
|
+
source: string;
|
|
8888
|
+
}
|
|
8889
|
+
/** Response from the /ads/{list_id} endpoint. */
|
|
8890
|
+
interface AdResponse {
|
|
8891
|
+
ad: Ad;
|
|
8892
|
+
}
|
|
8893
|
+
/** Response from the /ads/{list_id}/similar endpoint. */
|
|
8894
|
+
interface SimilarResponse {
|
|
8895
|
+
list_id: number;
|
|
8896
|
+
ads: Ad[];
|
|
8897
|
+
}
|
|
8898
|
+
/** Response from the /sellers/{user_id} endpoint. */
|
|
8899
|
+
interface SellerResponse {
|
|
8900
|
+
seller: Seller;
|
|
8901
|
+
}
|
|
8902
|
+
/** Response from the /sellers/{user_id}/listings endpoint. */
|
|
8903
|
+
interface SellerListingsResponse {
|
|
8904
|
+
user_id: string;
|
|
8905
|
+
ads: Ad[];
|
|
8906
|
+
total: number | null;
|
|
8907
|
+
page: number;
|
|
8908
|
+
limit: number;
|
|
8909
|
+
}
|
|
8910
|
+
/** Response from the /categories endpoint. */
|
|
8911
|
+
interface CategoriesResponse {
|
|
8912
|
+
categories: Category[];
|
|
8913
|
+
}
|
|
8914
|
+
/** Response from the /regions endpoint. */
|
|
8915
|
+
interface RegionsResponse {
|
|
8916
|
+
regions: Region[];
|
|
8917
|
+
}
|
|
8918
|
+
/** Response from the /departments endpoint. */
|
|
8919
|
+
interface DepartmentsResponse {
|
|
8920
|
+
departments: Department[];
|
|
8921
|
+
}
|
|
8922
|
+
/** Response from the /locations/search endpoint. */
|
|
8923
|
+
interface LocationSearchResponse {
|
|
8924
|
+
query: string;
|
|
8925
|
+
suggestions: LocationSuggestion[];
|
|
8926
|
+
}
|
|
8927
|
+
/** Response from the /markets endpoint. */
|
|
8928
|
+
interface MarketsResponse$1 {
|
|
8929
|
+
markets: Record<string, unknown>[];
|
|
8930
|
+
}
|
|
8931
|
+
/** Seller-type filter for search. */
|
|
8932
|
+
type LeboncoinOwnerType = "all" | "pro" | "private";
|
|
8933
|
+
/** Ad-type filter for search. */
|
|
8934
|
+
type LeboncoinAdType = "offer" | "demand";
|
|
8935
|
+
/** Sort order for search. */
|
|
8936
|
+
type LeboncoinSortBy = "relevance" | "newest" | "oldest" | "price_low" | "price_high";
|
|
8937
|
+
/** Parameters for searching Leboncoin ads. */
|
|
8938
|
+
interface LeboncoinSearchParams {
|
|
8939
|
+
/** Free-text query */
|
|
8940
|
+
text?: string;
|
|
8941
|
+
/** Category id (see reference.categories) */
|
|
8942
|
+
category?: string;
|
|
8943
|
+
/** Region id (see reference.regions) */
|
|
8944
|
+
region_id?: string;
|
|
8945
|
+
/** Department id, e.g. "75" (see reference.departments) */
|
|
8946
|
+
department_id?: string;
|
|
8947
|
+
/** City name */
|
|
8948
|
+
city?: string;
|
|
8949
|
+
/** Postal code */
|
|
8950
|
+
zipcode?: string;
|
|
8951
|
+
/** Minimum price filter */
|
|
8952
|
+
price_min?: number;
|
|
8953
|
+
/** Maximum price filter */
|
|
8954
|
+
price_max?: number;
|
|
8955
|
+
/** Seller-type filter (default: "all") */
|
|
8956
|
+
owner_type?: LeboncoinOwnerType;
|
|
8957
|
+
/** Ad-type filter (default: "offer") */
|
|
8958
|
+
ad_type?: LeboncoinAdType;
|
|
8959
|
+
/** Sort order (default: "relevance") */
|
|
8960
|
+
sort?: LeboncoinSortBy;
|
|
8961
|
+
/** Page number (1-indexed) */
|
|
8962
|
+
page?: number;
|
|
8963
|
+
/** Results per page (1-100; default 35) */
|
|
8964
|
+
limit?: number;
|
|
8965
|
+
}
|
|
8966
|
+
/** Options for the similar-ads endpoint. */
|
|
8967
|
+
interface LeboncoinSimilarParams {
|
|
8968
|
+
/** Number of similar ads to return (1-50; default 20) */
|
|
8969
|
+
limit?: number;
|
|
8970
|
+
}
|
|
8971
|
+
/** Options for the seller-listings endpoint. */
|
|
8972
|
+
interface LeboncoinSellerListingsParams {
|
|
8973
|
+
/** Page number (1-indexed) */
|
|
8974
|
+
page?: number;
|
|
8975
|
+
/** Results per page (1-100; default 35) */
|
|
8976
|
+
limit?: number;
|
|
8977
|
+
}
|
|
8978
|
+
/** Options for the departments endpoint. */
|
|
8979
|
+
interface LeboncoinDepartmentsParams {
|
|
8980
|
+
/** Filter by region id */
|
|
8981
|
+
region_id?: string;
|
|
8982
|
+
}
|
|
8983
|
+
|
|
8984
|
+
/**
|
|
8985
|
+
* Leboncoin Search API client.
|
|
8986
|
+
*
|
|
8987
|
+
* Provides ad search across the single France marketplace, scoped by
|
|
8988
|
+
* category, geography, price, seller type, and ad type.
|
|
8989
|
+
*/
|
|
8990
|
+
|
|
8991
|
+
/**
|
|
8992
|
+
* Client for the Leboncoin search endpoint.
|
|
8993
|
+
*
|
|
8994
|
+
* @example
|
|
8995
|
+
* ```typescript
|
|
8996
|
+
* const client = new ScrapeBadger({ apiKey: "key" });
|
|
8997
|
+
*
|
|
8998
|
+
* const results = await client.leboncoin.search.search({ text: "velo" });
|
|
8999
|
+
* for (const ad of results.ads) {
|
|
9000
|
+
* console.log(`${ad.subject} — ${ad.price_eur} EUR`);
|
|
9001
|
+
* }
|
|
9002
|
+
* ```
|
|
9003
|
+
*/
|
|
9004
|
+
declare class SearchClient$1 {
|
|
9005
|
+
private readonly client;
|
|
9006
|
+
constructor(client: BaseClient);
|
|
9007
|
+
/**
|
|
9008
|
+
* Search Leboncoin classified ads.
|
|
9009
|
+
*
|
|
9010
|
+
* France is a single market; scope results with `region_id` /
|
|
9011
|
+
* `department_id` / `city` (DOM-TOM are region values).
|
|
9012
|
+
*
|
|
9013
|
+
* @param params - Search parameters including text, filters, and pagination.
|
|
9014
|
+
* @returns Search results with ads, totals, and pagination metadata.
|
|
9015
|
+
* @throws AuthenticationError - If the API key is invalid.
|
|
9016
|
+
* @throws ValidationError - If the parameters are invalid.
|
|
9017
|
+
*/
|
|
9018
|
+
search(params?: LeboncoinSearchParams): Promise<SearchResponse$1>;
|
|
9019
|
+
}
|
|
9020
|
+
|
|
9021
|
+
/**
|
|
9022
|
+
* Leboncoin Ads API client.
|
|
9023
|
+
*
|
|
9024
|
+
* Provides methods for fetching a single ad's detail and the ads Leboncoin
|
|
9025
|
+
* surfaces as similar to it.
|
|
9026
|
+
*/
|
|
9027
|
+
|
|
9028
|
+
/**
|
|
9029
|
+
* Client for Leboncoin ad endpoints (detail, similar).
|
|
9030
|
+
*
|
|
9031
|
+
* @example
|
|
9032
|
+
* ```typescript
|
|
9033
|
+
* const client = new ScrapeBadger({ apiKey: "key" });
|
|
9034
|
+
*
|
|
9035
|
+
* const detail = await client.leboncoin.ads.get(2934857123);
|
|
9036
|
+
* console.log(detail.ad.subject);
|
|
9037
|
+
*
|
|
9038
|
+
* const similar = await client.leboncoin.ads.similar(2934857123);
|
|
9039
|
+
* console.log(`${similar.ads.length} similar ads`);
|
|
9040
|
+
* ```
|
|
9041
|
+
*/
|
|
9042
|
+
declare class AdsClient {
|
|
9043
|
+
private readonly client;
|
|
9044
|
+
constructor(client: BaseClient);
|
|
9045
|
+
/**
|
|
9046
|
+
* Get a single Leboncoin ad's full detail.
|
|
9047
|
+
*
|
|
9048
|
+
* @param listId - The Leboncoin ad list id.
|
|
9049
|
+
* @returns Ad detail response.
|
|
9050
|
+
* @throws NotFoundError - If the ad doesn't exist.
|
|
9051
|
+
*/
|
|
9052
|
+
get(listId: number | string): Promise<AdResponse>;
|
|
9053
|
+
/**
|
|
9054
|
+
* Get the ads Leboncoin surfaces as similar to a given ad.
|
|
9055
|
+
*
|
|
9056
|
+
* @param listId - The Leboncoin ad list id.
|
|
9057
|
+
* @param options - Optional parameters (limit).
|
|
9058
|
+
* @returns Similar-ads response.
|
|
9059
|
+
*/
|
|
9060
|
+
similar(listId: number | string, options?: LeboncoinSimilarParams): Promise<SimilarResponse>;
|
|
9061
|
+
}
|
|
9062
|
+
|
|
9063
|
+
/**
|
|
9064
|
+
* Leboncoin Sellers API client.
|
|
9065
|
+
*
|
|
9066
|
+
* Provides methods for a seller's public profile and their active listings.
|
|
9067
|
+
*/
|
|
9068
|
+
|
|
9069
|
+
/**
|
|
9070
|
+
* Client for Leboncoin seller endpoints (profile, listings).
|
|
9071
|
+
*
|
|
9072
|
+
* @example
|
|
9073
|
+
* ```typescript
|
|
9074
|
+
* const client = new ScrapeBadger({ apiKey: "key" });
|
|
9075
|
+
*
|
|
9076
|
+
* const profile = await client.leboncoin.sellers.get("a1b2c3d4-...");
|
|
9077
|
+
* console.log(profile.seller.name);
|
|
9078
|
+
*
|
|
9079
|
+
* const listings = await client.leboncoin.sellers.listings("a1b2c3d4-...");
|
|
9080
|
+
* console.log(`${listings.total} ads`);
|
|
9081
|
+
* ```
|
|
9082
|
+
*/
|
|
9083
|
+
declare class SellersClient {
|
|
9084
|
+
private readonly client;
|
|
9085
|
+
constructor(client: BaseClient);
|
|
9086
|
+
/**
|
|
9087
|
+
* Get a Leboncoin seller's public profile.
|
|
9088
|
+
*
|
|
9089
|
+
* @param userId - The seller user id.
|
|
9090
|
+
* @returns Seller profile response.
|
|
9091
|
+
* @throws NotFoundError - If the seller doesn't exist.
|
|
9092
|
+
*/
|
|
9093
|
+
get(userId: string): Promise<SellerResponse>;
|
|
9094
|
+
/**
|
|
9095
|
+
* List a Leboncoin seller's active ads.
|
|
9096
|
+
*
|
|
9097
|
+
* @param userId - The seller user id.
|
|
9098
|
+
* @param options - Optional parameters (page, limit).
|
|
9099
|
+
* @returns Seller listings response with ads and pagination.
|
|
9100
|
+
*/
|
|
9101
|
+
listings(userId: string, options?: LeboncoinSellerListingsParams): Promise<SellerListingsResponse>;
|
|
9102
|
+
}
|
|
9103
|
+
|
|
9104
|
+
/**
|
|
9105
|
+
* Leboncoin Reference Data API client.
|
|
9106
|
+
*
|
|
9107
|
+
* Provides the static category / region / department lists, the market list,
|
|
9108
|
+
* and location autocomplete for building search filters.
|
|
9109
|
+
*/
|
|
9110
|
+
|
|
9111
|
+
/**
|
|
9112
|
+
* Client for Leboncoin reference endpoints (categories, regions, departments,
|
|
9113
|
+
* location autocomplete, markets).
|
|
9114
|
+
*
|
|
9115
|
+
* @example
|
|
9116
|
+
* ```typescript
|
|
9117
|
+
* const client = new ScrapeBadger({ apiKey: "key" });
|
|
9118
|
+
*
|
|
9119
|
+
* const { categories } = await client.leboncoin.reference.categories();
|
|
9120
|
+
* const { regions } = await client.leboncoin.reference.regions();
|
|
9121
|
+
* const { departments } = await client.leboncoin.reference.departments({ region_id: "12" });
|
|
9122
|
+
* const { suggestions } = await client.leboncoin.reference.locations("Paris");
|
|
9123
|
+
* const { markets } = await client.leboncoin.reference.markets();
|
|
9124
|
+
* ```
|
|
9125
|
+
*/
|
|
9126
|
+
declare class ReferenceClient$1 {
|
|
9127
|
+
private readonly client;
|
|
9128
|
+
constructor(client: BaseClient);
|
|
9129
|
+
/**
|
|
9130
|
+
* List all Leboncoin categories.
|
|
9131
|
+
*
|
|
9132
|
+
* @returns Categories response.
|
|
9133
|
+
*/
|
|
9134
|
+
categories(): Promise<CategoriesResponse>;
|
|
9135
|
+
/**
|
|
9136
|
+
* List all Leboncoin regions.
|
|
9137
|
+
*
|
|
9138
|
+
* @returns Regions response.
|
|
9139
|
+
*/
|
|
9140
|
+
regions(): Promise<RegionsResponse>;
|
|
9141
|
+
/**
|
|
9142
|
+
* List Leboncoin departments, optionally filtered by region.
|
|
9143
|
+
*
|
|
9144
|
+
* @param options - Optional parameters (region_id).
|
|
9145
|
+
* @returns Departments response.
|
|
9146
|
+
*/
|
|
9147
|
+
departments(options?: LeboncoinDepartmentsParams): Promise<DepartmentsResponse>;
|
|
9148
|
+
/**
|
|
9149
|
+
* Resolve a place name to Leboncoin location ids (for building filters).
|
|
9150
|
+
*
|
|
9151
|
+
* @param query - Place name to resolve.
|
|
9152
|
+
* @returns Location search response with suggestions.
|
|
9153
|
+
*/
|
|
9154
|
+
locations(query: string): Promise<LocationSearchResponse>;
|
|
9155
|
+
/**
|
|
9156
|
+
* List the supported Leboncoin markets (France is the single market).
|
|
9157
|
+
*
|
|
9158
|
+
* @returns Markets response.
|
|
9159
|
+
*/
|
|
9160
|
+
markets(): Promise<MarketsResponse$1>;
|
|
9161
|
+
}
|
|
9162
|
+
|
|
9163
|
+
/**
|
|
9164
|
+
* Leboncoin API client.
|
|
9165
|
+
*
|
|
9166
|
+
* Provides access to all Leboncoin API endpoints through specialized
|
|
9167
|
+
* sub-clients.
|
|
9168
|
+
*/
|
|
9169
|
+
|
|
9170
|
+
/**
|
|
9171
|
+
* Leboncoin API client with access to all Leboncoin endpoints.
|
|
9172
|
+
*
|
|
9173
|
+
* Provides sub-clients for different resource types:
|
|
9174
|
+
* - `search` - Ad search across the single France marketplace
|
|
9175
|
+
* - `ads` - Ad detail and similar ads
|
|
9176
|
+
* - `sellers` - Seller profile and their active listings
|
|
9177
|
+
* - `reference` - Reference data (categories, regions, departments,
|
|
9178
|
+
* location autocomplete, markets)
|
|
9179
|
+
*
|
|
9180
|
+
* @example
|
|
9181
|
+
* ```typescript
|
|
9182
|
+
* const client = new ScrapeBadger({ apiKey: "key" });
|
|
9183
|
+
*
|
|
9184
|
+
* // Search ads
|
|
9185
|
+
* const results = await client.leboncoin.search.search({ text: "velo" });
|
|
9186
|
+
*
|
|
9187
|
+
* // Get an ad
|
|
9188
|
+
* const ad = await client.leboncoin.ads.get(2934857123);
|
|
9189
|
+
*
|
|
9190
|
+
* // Similar ads
|
|
9191
|
+
* const similar = await client.leboncoin.ads.similar(2934857123);
|
|
9192
|
+
*
|
|
9193
|
+
* // Seller profile + listings
|
|
9194
|
+
* const seller = await client.leboncoin.sellers.get("a1b2c3d4-...");
|
|
9195
|
+
* const listings = await client.leboncoin.sellers.listings("a1b2c3d4-...");
|
|
9196
|
+
*
|
|
9197
|
+
* // Reference data
|
|
9198
|
+
* const { categories } = await client.leboncoin.reference.categories();
|
|
9199
|
+
* ```
|
|
9200
|
+
*/
|
|
9201
|
+
declare class LeboncoinClient {
|
|
9202
|
+
/** Client for ad search */
|
|
9203
|
+
readonly search: SearchClient$1;
|
|
9204
|
+
/** Client for ad detail and similar ads */
|
|
9205
|
+
readonly ads: AdsClient;
|
|
9206
|
+
/** Client for seller profile and listings */
|
|
9207
|
+
readonly sellers: SellersClient;
|
|
9208
|
+
/** Client for reference data (categories, regions, departments, locations, markets) */
|
|
9209
|
+
readonly reference: ReferenceClient$1;
|
|
9210
|
+
/**
|
|
9211
|
+
* Create a new Leboncoin client.
|
|
9212
|
+
*
|
|
9213
|
+
* @param client - The base HTTP client for making requests.
|
|
9214
|
+
*/
|
|
9215
|
+
constructor(client: BaseClient);
|
|
9216
|
+
}
|
|
9217
|
+
|
|
9218
|
+
/**
|
|
9219
|
+
* TypeScript types for Zillow API responses.
|
|
9220
|
+
*
|
|
9221
|
+
* These interfaces mirror the backend `zillow_scraper` response schema
|
|
9222
|
+
* field-for-field. Backend keys are snake_case (e.g. `home_status`,
|
|
9223
|
+
* `price_history`, `home_facts`, `scraped_at`) and are kept snake_case here to
|
|
9224
|
+
* match the JSON exactly. Most model fields are optional and nullable
|
|
9225
|
+
* (`field?: type | null`); list fields default to `[]` on the backend and are
|
|
9226
|
+
* typed as arrays. Every datetime field ships in BOTH `*_utc` (Unix float
|
|
9227
|
+
* seconds) and `*_at` (ISO-8601 Z string) form.
|
|
9228
|
+
*
|
|
9229
|
+
* Zillow is a single-domain, single-locale target (zillow.com, USD, en-US);
|
|
9230
|
+
* US + Canadian inventory are both served from zillow.com behind a US IP, so
|
|
9231
|
+
* there is no market/currency dimension on the models.
|
|
9232
|
+
*/
|
|
9233
|
+
/** A lat/lon coordinate pair. */
|
|
9234
|
+
interface LatLong {
|
|
9235
|
+
latitude?: number | null;
|
|
9236
|
+
longitude?: number | null;
|
|
9237
|
+
}
|
|
9238
|
+
/** A single listing photo with its responsive source variants. */
|
|
9239
|
+
interface Photo {
|
|
9240
|
+
url?: string | null;
|
|
9241
|
+
caption?: string | null;
|
|
9242
|
+
subject_type?: string | null;
|
|
9243
|
+
/** Responsive variants: [{ url, width, format: "jpeg" | "webp" }] */
|
|
9244
|
+
sources?: Record<string, unknown>[];
|
|
9245
|
+
}
|
|
9246
|
+
/** Page-number pagination (Zillow search returns ~40 results per page). */
|
|
9247
|
+
interface Pagination {
|
|
9248
|
+
current_page?: number;
|
|
9249
|
+
per_page?: number | null;
|
|
9250
|
+
total_pages?: number | null;
|
|
9251
|
+
total_results?: number | null;
|
|
9252
|
+
}
|
|
9253
|
+
/**
|
|
9254
|
+
* The map bounding box a search covers — callers tile with this to beat
|
|
9255
|
+
* Zillow's ~820-result (20-page) cap by subdividing dense boxes.
|
|
9256
|
+
*/
|
|
9257
|
+
interface MapBounds {
|
|
9258
|
+
north?: number | null;
|
|
9259
|
+
east?: number | null;
|
|
9260
|
+
south?: number | null;
|
|
9261
|
+
west?: number | null;
|
|
9262
|
+
}
|
|
9263
|
+
/** The numeric region Zillow resolved a search location to. */
|
|
9264
|
+
interface RegionSelection {
|
|
9265
|
+
region_id?: number | null;
|
|
9266
|
+
region_type?: number | null;
|
|
9267
|
+
}
|
|
9268
|
+
/** A linked nearby region (city / neighborhood / zip) on a property page. */
|
|
9269
|
+
interface NearbyRegion {
|
|
9270
|
+
name?: string | null;
|
|
9271
|
+
region_type?: string | null;
|
|
9272
|
+
url?: string | null;
|
|
9273
|
+
}
|
|
9274
|
+
/** A supported coverage region (for /markets). */
|
|
9275
|
+
interface MarketInfo {
|
|
9276
|
+
code: string;
|
|
9277
|
+
country: string;
|
|
9278
|
+
currency: string;
|
|
9279
|
+
locale: string;
|
|
9280
|
+
name: string;
|
|
9281
|
+
domain: string;
|
|
9282
|
+
}
|
|
9283
|
+
/**
|
|
9284
|
+
* One Zillow search card (search / agent listings).
|
|
9285
|
+
*
|
|
9286
|
+
* Merges the search `listResult` top-level with its richer
|
|
9287
|
+
* `hdpData.homeInfo` sub-object.
|
|
9288
|
+
*/
|
|
9289
|
+
interface Listing {
|
|
9290
|
+
position: number;
|
|
9291
|
+
zpid?: string | null;
|
|
9292
|
+
id?: string | null;
|
|
9293
|
+
detail_url?: string | null;
|
|
9294
|
+
home_type?: string | null;
|
|
9295
|
+
home_status?: string | null;
|
|
9296
|
+
status_text?: string | null;
|
|
9297
|
+
status_type?: string | null;
|
|
9298
|
+
marketing_status?: string | null;
|
|
9299
|
+
contingent_listing_type?: string | null;
|
|
9300
|
+
price?: number | null;
|
|
9301
|
+
price_raw?: string | null;
|
|
9302
|
+
currency?: string | null;
|
|
9303
|
+
price_change?: number | null;
|
|
9304
|
+
date_price_changed_utc?: number | null;
|
|
9305
|
+
date_price_changed_at?: string | null;
|
|
9306
|
+
price_reduction?: string | null;
|
|
9307
|
+
flex_field_text?: string | null;
|
|
9308
|
+
zestimate?: number | null;
|
|
9309
|
+
rent_zestimate?: number | null;
|
|
9310
|
+
tax_assessed_value?: number | null;
|
|
9311
|
+
beds?: number | null;
|
|
9312
|
+
baths?: number | null;
|
|
9313
|
+
living_area?: number | null;
|
|
9314
|
+
lot_area_value?: number | null;
|
|
9315
|
+
lot_area_unit?: string | null;
|
|
9316
|
+
address?: string | null;
|
|
9317
|
+
street_address?: string | null;
|
|
9318
|
+
unit?: string | null;
|
|
9319
|
+
city?: string | null;
|
|
9320
|
+
state?: string | null;
|
|
9321
|
+
zipcode?: string | null;
|
|
9322
|
+
country?: string | null;
|
|
9323
|
+
is_undisclosed_address?: boolean | null;
|
|
9324
|
+
latitude?: number | null;
|
|
9325
|
+
longitude?: number | null;
|
|
9326
|
+
broker_name?: string | null;
|
|
9327
|
+
provider_listing_id?: string | null;
|
|
9328
|
+
days_on_zillow?: number | null;
|
|
9329
|
+
is_zillow_owned?: boolean | null;
|
|
9330
|
+
is_featured?: boolean | null;
|
|
9331
|
+
is_showcase?: boolean | null;
|
|
9332
|
+
is_fsba?: boolean | null;
|
|
9333
|
+
is_new_construction?: boolean | null;
|
|
9334
|
+
is_premier_builder?: boolean | null;
|
|
9335
|
+
is_preforeclosure_auction?: boolean | null;
|
|
9336
|
+
is_non_owner_occupied?: boolean | null;
|
|
9337
|
+
img_src?: string | null;
|
|
9338
|
+
has_image?: boolean | null;
|
|
9339
|
+
has_video?: boolean | null;
|
|
9340
|
+
has_3d_model?: boolean | null;
|
|
9341
|
+
has_open_house?: boolean | null;
|
|
9342
|
+
open_house_start?: string | null;
|
|
9343
|
+
open_house_end?: string | null;
|
|
9344
|
+
photos?: string[];
|
|
9345
|
+
}
|
|
9346
|
+
/** A property's structured address. */
|
|
9347
|
+
interface Address {
|
|
9348
|
+
street_address?: string | null;
|
|
9349
|
+
city?: string | null;
|
|
9350
|
+
state?: string | null;
|
|
9351
|
+
zipcode?: string | null;
|
|
9352
|
+
community?: string | null;
|
|
9353
|
+
subdivision?: string | null;
|
|
9354
|
+
neighborhood?: string | null;
|
|
9355
|
+
}
|
|
9356
|
+
/** `listingSubType` flags — the for-sale / foreclosure / auction taxonomy. */
|
|
9357
|
+
interface ListingSubType {
|
|
9358
|
+
is_fsba?: boolean | null;
|
|
9359
|
+
is_fsbo?: boolean | null;
|
|
9360
|
+
is_foreclosure?: boolean | null;
|
|
9361
|
+
is_bank_owned?: boolean | null;
|
|
9362
|
+
is_for_auction?: boolean | null;
|
|
9363
|
+
is_coming_soon?: boolean | null;
|
|
9364
|
+
is_new_home?: boolean | null;
|
|
9365
|
+
is_pending?: boolean | null;
|
|
9366
|
+
}
|
|
9367
|
+
/** A scheduled open house. */
|
|
9368
|
+
interface OpenHouse {
|
|
9369
|
+
start_utc?: number | null;
|
|
9370
|
+
start_at?: string | null;
|
|
9371
|
+
end_utc?: number | null;
|
|
9372
|
+
end_at?: string | null;
|
|
9373
|
+
note?: string | null;
|
|
9374
|
+
}
|
|
9375
|
+
/** One point in the Zestimate value history series (`homeValueChartData`). */
|
|
9376
|
+
interface ZestimateHistoryPoint {
|
|
9377
|
+
date?: string | null;
|
|
9378
|
+
date_utc?: number | null;
|
|
9379
|
+
date_at?: string | null;
|
|
9380
|
+
value?: number | null;
|
|
9381
|
+
}
|
|
9382
|
+
/** A single price-history event (listed, price change, sold, etc.). */
|
|
9383
|
+
interface PriceHistoryEvent {
|
|
9384
|
+
date?: string | null;
|
|
9385
|
+
date_utc?: number | null;
|
|
9386
|
+
date_at?: string | null;
|
|
9387
|
+
event?: string | null;
|
|
9388
|
+
price?: number | null;
|
|
9389
|
+
price_per_square_foot?: number | null;
|
|
9390
|
+
price_change_rate?: number | null;
|
|
9391
|
+
source?: string | null;
|
|
9392
|
+
buyer_agent?: string | null;
|
|
9393
|
+
seller_agent?: string | null;
|
|
9394
|
+
posting_is_rental?: boolean | null;
|
|
9395
|
+
}
|
|
9396
|
+
/** A single year's tax + assessment record. */
|
|
9397
|
+
interface TaxHistoryEvent {
|
|
9398
|
+
year_utc?: number | null;
|
|
9399
|
+
year_at?: string | null;
|
|
9400
|
+
value?: number | null;
|
|
9401
|
+
value_increase_rate?: number | null;
|
|
9402
|
+
tax_paid?: number | null;
|
|
9403
|
+
tax_increase_rate?: number | null;
|
|
9404
|
+
}
|
|
9405
|
+
/** A nearby / assigned school. */
|
|
9406
|
+
interface School {
|
|
9407
|
+
name?: string | null;
|
|
9408
|
+
rating?: number | null;
|
|
9409
|
+
grades?: string | null;
|
|
9410
|
+
level?: string | null;
|
|
9411
|
+
type?: string | null;
|
|
9412
|
+
distance?: number | null;
|
|
9413
|
+
link?: string | null;
|
|
9414
|
+
student_count?: number | null;
|
|
9415
|
+
assigned?: boolean | null;
|
|
9416
|
+
}
|
|
9417
|
+
/** Listing agent / broker attribution (from `attributionInfo`). */
|
|
9418
|
+
interface AgentAttribution {
|
|
9419
|
+
agent_name?: string | null;
|
|
9420
|
+
agent_phone?: string | null;
|
|
9421
|
+
agent_email?: string | null;
|
|
9422
|
+
agent_license_number?: string | null;
|
|
9423
|
+
co_agent_name?: string | null;
|
|
9424
|
+
co_agent_number?: string | null;
|
|
9425
|
+
co_agent_license_number?: string | null;
|
|
9426
|
+
broker_name?: string | null;
|
|
9427
|
+
broker_phone?: string | null;
|
|
9428
|
+
buyer_agent_name?: string | null;
|
|
9429
|
+
buyer_brokerage_name?: string | null;
|
|
9430
|
+
mls_id?: string | null;
|
|
9431
|
+
mls_name?: string | null;
|
|
9432
|
+
mls_disclaimer?: string | null;
|
|
9433
|
+
listing_agreement?: string | null;
|
|
9434
|
+
listing_attribution_contact?: string | null;
|
|
9435
|
+
provider_logo?: string | null;
|
|
9436
|
+
true_status?: string | null;
|
|
9437
|
+
last_checked?: string | null;
|
|
9438
|
+
last_updated?: string | null;
|
|
9439
|
+
listing_agents?: Record<string, unknown>[];
|
|
9440
|
+
listing_offices?: Record<string, unknown>[];
|
|
9441
|
+
}
|
|
9442
|
+
/** A single mortgage rate quote. */
|
|
9443
|
+
interface MortgageRate {
|
|
9444
|
+
rate?: number | null;
|
|
9445
|
+
rate_source?: string | null;
|
|
9446
|
+
last_updated_utc?: number | null;
|
|
9447
|
+
last_updated_at?: string | null;
|
|
9448
|
+
}
|
|
9449
|
+
/** Current mortgage rates surfaced on the property page. */
|
|
9450
|
+
interface MortgageRates {
|
|
9451
|
+
fifteen_year_fixed?: MortgageRate | null;
|
|
9452
|
+
thirty_year_fixed?: MortgageRate | null;
|
|
9453
|
+
arm_5?: MortgageRate | null;
|
|
9454
|
+
}
|
|
9455
|
+
/**
|
|
9456
|
+
* High-value subset of Zillow's `resoFacts` MLS block.
|
|
9457
|
+
*
|
|
9458
|
+
* resoFacts carries ~187 keys; these are the ones competitors surface and
|
|
9459
|
+
* callers actually query.
|
|
9460
|
+
*/
|
|
9461
|
+
interface HomeFacts {
|
|
9462
|
+
bathrooms_full?: number | null;
|
|
9463
|
+
bathrooms_half?: number | null;
|
|
9464
|
+
bathrooms_three_quarter?: number | null;
|
|
9465
|
+
bathrooms_one_quarter?: number | null;
|
|
9466
|
+
stories?: number | null;
|
|
9467
|
+
stories_decimal?: number | null;
|
|
9468
|
+
levels?: string | null;
|
|
9469
|
+
property_condition?: string | null;
|
|
9470
|
+
architectural_style?: string | null;
|
|
9471
|
+
structure_type?: string | null;
|
|
9472
|
+
building_name?: string | null;
|
|
9473
|
+
construction_materials?: string[];
|
|
9474
|
+
foundation_details?: string[];
|
|
9475
|
+
roof_type?: string | null;
|
|
9476
|
+
year_built_effective?: number | null;
|
|
9477
|
+
above_grade_finished_area?: string | null;
|
|
9478
|
+
below_grade_finished_area?: string | null;
|
|
9479
|
+
lot_size_dimensions?: string | null;
|
|
9480
|
+
main_level_bedrooms?: number | null;
|
|
9481
|
+
main_level_bathrooms?: number | null;
|
|
9482
|
+
basement?: string | null;
|
|
9483
|
+
has_basement?: boolean | null;
|
|
9484
|
+
attic?: string | null;
|
|
9485
|
+
heating?: string[];
|
|
9486
|
+
cooling?: string[];
|
|
9487
|
+
appliances?: string[];
|
|
9488
|
+
flooring?: string[];
|
|
9489
|
+
utilities?: string[];
|
|
9490
|
+
electric?: string[];
|
|
9491
|
+
gas?: string[];
|
|
9492
|
+
sewer?: string[];
|
|
9493
|
+
water_source?: string[];
|
|
9494
|
+
green_building_verification_type?: string[];
|
|
9495
|
+
green_energy_efficient?: string[];
|
|
9496
|
+
green_energy_generation?: string[];
|
|
9497
|
+
green_sustainability?: string[];
|
|
9498
|
+
green_water_conservation?: string[];
|
|
9499
|
+
interior_features?: string[];
|
|
9500
|
+
exterior_features?: string[];
|
|
9501
|
+
lot_features?: string[];
|
|
9502
|
+
community_features?: string[];
|
|
9503
|
+
accessibility_features?: string[];
|
|
9504
|
+
door_features?: string[];
|
|
9505
|
+
window_features?: string[];
|
|
9506
|
+
laundry_features?: string[];
|
|
9507
|
+
patio_and_porch_features?: string[];
|
|
9508
|
+
fencing?: string[];
|
|
9509
|
+
other_structures?: string[];
|
|
9510
|
+
view?: string[];
|
|
9511
|
+
has_view?: boolean | null;
|
|
9512
|
+
waterfront_features?: string[];
|
|
9513
|
+
water_view?: string | null;
|
|
9514
|
+
water_body_name?: string | null;
|
|
9515
|
+
security_features?: string[];
|
|
9516
|
+
parking_features?: string[];
|
|
9517
|
+
parking_capacity?: number | null;
|
|
9518
|
+
garage_parking_capacity?: number | null;
|
|
9519
|
+
carport_parking_capacity?: number | null;
|
|
9520
|
+
covered_parking_capacity?: number | null;
|
|
9521
|
+
open_parking_capacity?: number | null;
|
|
9522
|
+
has_attached_garage?: boolean | null;
|
|
9523
|
+
has_garage?: boolean | null;
|
|
9524
|
+
has_carport?: boolean | null;
|
|
9525
|
+
has_open_parking?: boolean | null;
|
|
9526
|
+
pool_features?: string[];
|
|
9527
|
+
has_private_pool?: boolean | null;
|
|
9528
|
+
spa_features?: string[];
|
|
9529
|
+
fireplaces?: number | null;
|
|
9530
|
+
fireplace_features?: string[];
|
|
9531
|
+
has_fireplace?: boolean | null;
|
|
9532
|
+
association_name?: string | null;
|
|
9533
|
+
association_name2?: string | null;
|
|
9534
|
+
association_fee?: string | null;
|
|
9535
|
+
association_fee2?: string | null;
|
|
9536
|
+
association_fee_includes?: string[];
|
|
9537
|
+
association_amenities?: string[];
|
|
9538
|
+
association_phone?: string | null;
|
|
9539
|
+
has_association?: boolean | null;
|
|
9540
|
+
hoa_fee?: string | null;
|
|
9541
|
+
hoa_fee_total?: string | null;
|
|
9542
|
+
tax_annual_amount?: number | null;
|
|
9543
|
+
price_per_square_foot?: number | null;
|
|
9544
|
+
has_land_lease?: boolean | null;
|
|
9545
|
+
land_lease_amount?: string | null;
|
|
9546
|
+
land_lease_expiration_date?: string | null;
|
|
9547
|
+
can_raise_horses?: boolean | null;
|
|
9548
|
+
additional_parcels_description?: string | null;
|
|
9549
|
+
road_surface_type?: string[];
|
|
9550
|
+
on_market_date?: string | null;
|
|
9551
|
+
cumulative_days_on_market?: number | null;
|
|
9552
|
+
offer_review_date?: string | null;
|
|
9553
|
+
number_of_units_in_community?: number | null;
|
|
9554
|
+
availability_date?: string | null;
|
|
9555
|
+
lease_term?: string | null;
|
|
9556
|
+
tenant_pays?: string[];
|
|
9557
|
+
has_pets_allowed?: boolean | null;
|
|
9558
|
+
pets_max_weight?: number | null;
|
|
9559
|
+
has_rent_control?: boolean | null;
|
|
9560
|
+
elementary_school?: string | null;
|
|
9561
|
+
middle_school?: string | null;
|
|
9562
|
+
high_school?: string | null;
|
|
9563
|
+
elementary_school_district?: string | null;
|
|
9564
|
+
middle_school_district?: string | null;
|
|
9565
|
+
high_school_district?: string | null;
|
|
9566
|
+
parcel_number?: string | null;
|
|
9567
|
+
subdivision_name?: string | null;
|
|
9568
|
+
municipality?: string | null;
|
|
9569
|
+
city_region?: string | null;
|
|
9570
|
+
zoning?: string | null;
|
|
9571
|
+
zoning_description?: string | null;
|
|
9572
|
+
ownership?: string | null;
|
|
9573
|
+
ownership_type?: string | null;
|
|
9574
|
+
property_sub_type?: string[];
|
|
9575
|
+
special_listing_conditions?: string | null;
|
|
9576
|
+
listing_terms?: string | null;
|
|
9577
|
+
inclusions?: string | null;
|
|
9578
|
+
exclusions?: string | null;
|
|
9579
|
+
is_new_construction?: boolean | null;
|
|
9580
|
+
is_senior_community?: boolean | null;
|
|
9581
|
+
has_home_warranty?: boolean | null;
|
|
9582
|
+
furnished?: boolean | null;
|
|
9583
|
+
development_status?: string | null;
|
|
9584
|
+
park_name?: string | null;
|
|
9585
|
+
at_a_glance_facts?: Record<string, unknown>[];
|
|
9586
|
+
rooms?: Record<string, unknown>[];
|
|
9587
|
+
}
|
|
9588
|
+
/** Full Zillow property detail (from `gdpClientCache[...].property`). */
|
|
9589
|
+
interface Property {
|
|
9590
|
+
zpid: string;
|
|
9591
|
+
id?: string | null;
|
|
9592
|
+
url?: string | null;
|
|
9593
|
+
home_status?: string | null;
|
|
9594
|
+
home_type?: string | null;
|
|
9595
|
+
property_type?: string | null;
|
|
9596
|
+
listing_type?: string | null;
|
|
9597
|
+
posting_product_type?: string | null;
|
|
9598
|
+
listing_data_source?: string | null;
|
|
9599
|
+
mls_id?: string | null;
|
|
9600
|
+
parcel_id?: string | null;
|
|
9601
|
+
county_fips?: string | null;
|
|
9602
|
+
provider_listing_id?: string | null;
|
|
9603
|
+
broker_id?: string | null;
|
|
9604
|
+
contingent_listing_type?: string | null;
|
|
9605
|
+
listing_sub_type?: ListingSubType | null;
|
|
9606
|
+
price?: number | null;
|
|
9607
|
+
currency?: string | null;
|
|
9608
|
+
list_price_low?: number | null;
|
|
9609
|
+
monthly_hoa_fee?: number | null;
|
|
9610
|
+
property_tax_rate?: number | null;
|
|
9611
|
+
annual_homeowners_insurance?: number | null;
|
|
9612
|
+
last_sold_price?: number | null;
|
|
9613
|
+
date_sold_utc?: number | null;
|
|
9614
|
+
date_sold_at?: string | null;
|
|
9615
|
+
price_change?: number | null;
|
|
9616
|
+
price_change_date_utc?: number | null;
|
|
9617
|
+
price_change_date_at?: string | null;
|
|
9618
|
+
zestimate?: number | null;
|
|
9619
|
+
rent_zestimate?: number | null;
|
|
9620
|
+
zestimate_low_percent?: string | null;
|
|
9621
|
+
zestimate_high_percent?: string | null;
|
|
9622
|
+
rent_zestimate_low_percent?: string | null;
|
|
9623
|
+
rent_zestimate_high_percent?: string | null;
|
|
9624
|
+
zestimate_30_days_ago?: number | null;
|
|
9625
|
+
rent_zestimate_30_days_ago?: number | null;
|
|
9626
|
+
tax_assessed_value?: number | null;
|
|
9627
|
+
zestimate_history?: ZestimateHistoryPoint[];
|
|
9628
|
+
bedrooms?: number | null;
|
|
9629
|
+
bathrooms?: number | null;
|
|
9630
|
+
living_area?: number | null;
|
|
9631
|
+
living_area_units?: string | null;
|
|
9632
|
+
lot_size?: number | null;
|
|
9633
|
+
lot_area_value?: number | null;
|
|
9634
|
+
lot_area_units?: string | null;
|
|
9635
|
+
year_built?: number | null;
|
|
9636
|
+
move_in_ready?: boolean | null;
|
|
9637
|
+
move_in_completion_date?: string | null;
|
|
9638
|
+
latitude?: number | null;
|
|
9639
|
+
longitude?: number | null;
|
|
9640
|
+
street_address?: string | null;
|
|
9641
|
+
abbreviated_address?: string | null;
|
|
9642
|
+
city?: string | null;
|
|
9643
|
+
state?: string | null;
|
|
9644
|
+
zipcode?: string | null;
|
|
9645
|
+
county?: string | null;
|
|
9646
|
+
country?: string | null;
|
|
9647
|
+
time_zone?: string | null;
|
|
9648
|
+
neighborhood?: string | null;
|
|
9649
|
+
is_undisclosed_address?: boolean | null;
|
|
9650
|
+
is_income_restricted?: boolean | null;
|
|
9651
|
+
days_on_zillow?: number | null;
|
|
9652
|
+
time_on_zillow?: string | null;
|
|
9653
|
+
page_view_count?: number | null;
|
|
9654
|
+
favorite_count?: number | null;
|
|
9655
|
+
tour_view_count?: number | null;
|
|
9656
|
+
photo_count?: number | null;
|
|
9657
|
+
description?: string | null;
|
|
9658
|
+
what_i_love?: string | null;
|
|
9659
|
+
home_insights?: string[];
|
|
9660
|
+
marketing_name?: string | null;
|
|
9661
|
+
brokerage_name?: string | null;
|
|
9662
|
+
is_showcase_listing?: boolean | null;
|
|
9663
|
+
has_vr_model?: boolean | null;
|
|
9664
|
+
has_3d_model?: boolean | null;
|
|
9665
|
+
virtual_tour_url?: string | null;
|
|
9666
|
+
interactive_floor_plan_url?: string | null;
|
|
9667
|
+
street_view_image_url?: string | null;
|
|
9668
|
+
static_map_url?: string | null;
|
|
9669
|
+
new_construction_type?: string | null;
|
|
9670
|
+
builder_name?: string | null;
|
|
9671
|
+
promotion_headline?: string | null;
|
|
9672
|
+
promotion_description?: string | null;
|
|
9673
|
+
has_promotion?: boolean | null;
|
|
9674
|
+
address?: Address | null;
|
|
9675
|
+
home_facts?: HomeFacts | null;
|
|
9676
|
+
agent?: AgentAttribution | null;
|
|
9677
|
+
mortgage_rates?: MortgageRates | null;
|
|
9678
|
+
price_history?: PriceHistoryEvent[];
|
|
9679
|
+
tax_history?: TaxHistoryEvent[];
|
|
9680
|
+
schools?: School[];
|
|
9681
|
+
photos?: Photo[];
|
|
9682
|
+
open_house_schedule?: OpenHouse[];
|
|
9683
|
+
nearby_cities?: NearbyRegion[];
|
|
9684
|
+
nearby_neighborhoods?: NearbyRegion[];
|
|
9685
|
+
nearby_zipcodes?: NearbyRegion[];
|
|
9686
|
+
/** nearby_homes / comps are lazy-loaded client-side (usually empty in SSR). */
|
|
9687
|
+
nearby_homes?: Listing[];
|
|
9688
|
+
scraped_utc?: number | null;
|
|
9689
|
+
scraped_at?: string | null;
|
|
9690
|
+
}
|
|
9691
|
+
/** One review on a Zillow agent profile (from `reviewsData.reviews`). */
|
|
9692
|
+
interface AgentReview {
|
|
9693
|
+
rating?: number | null;
|
|
9694
|
+
comment?: string | null;
|
|
9695
|
+
date?: string | null;
|
|
9696
|
+
date_utc?: number | null;
|
|
9697
|
+
date_at?: string | null;
|
|
9698
|
+
work_description?: string | null;
|
|
9699
|
+
reviewer_name?: string | null;
|
|
9700
|
+
rebuttal?: string | null;
|
|
9701
|
+
/** [{ description: "Responsiveness", score: 5 }, …] */
|
|
9702
|
+
sub_ratings?: Record<string, unknown>[];
|
|
9703
|
+
}
|
|
9704
|
+
/** A closed transaction from an agent's `pastSales` block. */
|
|
9705
|
+
interface PastSale {
|
|
9706
|
+
zpid?: string | null;
|
|
9707
|
+
street_address?: string | null;
|
|
9708
|
+
city_state_zip?: string | null;
|
|
9709
|
+
price?: number | null;
|
|
9710
|
+
sold_date?: string | null;
|
|
9711
|
+
sold_date_utc?: number | null;
|
|
9712
|
+
sold_date_at?: string | null;
|
|
9713
|
+
bedrooms?: number | null;
|
|
9714
|
+
bathrooms?: number | null;
|
|
9715
|
+
living_area?: number | null;
|
|
9716
|
+
latitude?: number | null;
|
|
9717
|
+
longitude?: number | null;
|
|
9718
|
+
represented?: string | null;
|
|
9719
|
+
image_url?: string | null;
|
|
9720
|
+
url?: string | null;
|
|
9721
|
+
}
|
|
9722
|
+
/** A professional license held by an agent. */
|
|
9723
|
+
interface AgentLicense {
|
|
9724
|
+
state?: string | null;
|
|
9725
|
+
license_type?: string | null;
|
|
9726
|
+
license_number?: string | null;
|
|
9727
|
+
status?: string | null;
|
|
9728
|
+
expiration?: string | null;
|
|
9729
|
+
}
|
|
9730
|
+
/** A Zillow real-estate professional profile (from /profile/{username}). */
|
|
9731
|
+
interface Agent {
|
|
9732
|
+
username?: string | null;
|
|
9733
|
+
encoded_zuid?: string | null;
|
|
9734
|
+
name?: string | null;
|
|
9735
|
+
url?: string | null;
|
|
9736
|
+
profile_photo?: string | null;
|
|
9737
|
+
phone?: string | null;
|
|
9738
|
+
email?: string | null;
|
|
9739
|
+
business_name?: string | null;
|
|
9740
|
+
business_address?: string | null;
|
|
9741
|
+
broker_name?: string | null;
|
|
9742
|
+
title?: string | null;
|
|
9743
|
+
bio?: string | null;
|
|
9744
|
+
rating?: number | null;
|
|
9745
|
+
review_count?: number | null;
|
|
9746
|
+
recent_sales_count?: number | null;
|
|
9747
|
+
total_sales_last_year?: number | null;
|
|
9748
|
+
for_sale_count?: number | null;
|
|
9749
|
+
for_rent_count?: number | null;
|
|
9750
|
+
past_sales_count?: number | null;
|
|
9751
|
+
years_experience?: number | null;
|
|
9752
|
+
is_top_agent?: boolean | null;
|
|
9753
|
+
is_team_lead?: boolean | null;
|
|
9754
|
+
license_number?: string | null;
|
|
9755
|
+
license_state?: string | null;
|
|
9756
|
+
website_url?: string | null;
|
|
9757
|
+
facebook_url?: string | null;
|
|
9758
|
+
linkedin_url?: string | null;
|
|
9759
|
+
x_url?: string | null;
|
|
9760
|
+
video_url?: string | null;
|
|
9761
|
+
specialties?: string[];
|
|
9762
|
+
service_areas?: string[];
|
|
9763
|
+
languages?: string[];
|
|
9764
|
+
licenses?: AgentLicense[];
|
|
9765
|
+
professional_information?: Record<string, unknown>[];
|
|
9766
|
+
reviews?: AgentReview[];
|
|
9767
|
+
past_sales?: PastSale[];
|
|
9768
|
+
listings?: Listing[];
|
|
9769
|
+
scraped_utc?: number | null;
|
|
9770
|
+
scraped_at?: string | null;
|
|
9771
|
+
}
|
|
9772
|
+
/** A region/address suggestion resolved for a search term. */
|
|
9773
|
+
interface AutocompleteResult {
|
|
9774
|
+
display?: string | null;
|
|
9775
|
+
region_id?: number | null;
|
|
9776
|
+
region_type?: string | null;
|
|
9777
|
+
latitude?: number | null;
|
|
9778
|
+
longitude?: number | null;
|
|
9779
|
+
/** Populated when the suggestion is a specific home. */
|
|
9780
|
+
zpid?: string | null;
|
|
9781
|
+
metro_id?: number | null;
|
|
9782
|
+
}
|
|
9783
|
+
/** Response from the /search endpoint. */
|
|
9784
|
+
interface SearchResponse {
|
|
9785
|
+
location?: string | null;
|
|
9786
|
+
status: string;
|
|
9787
|
+
results: Listing[];
|
|
9788
|
+
map_results_count: number;
|
|
9789
|
+
region?: RegionSelection | null;
|
|
9790
|
+
map_bounds?: MapBounds | null;
|
|
9791
|
+
pagination: Pagination;
|
|
9792
|
+
scraped_utc?: number | null;
|
|
9793
|
+
scraped_at?: string | null;
|
|
9794
|
+
}
|
|
9795
|
+
/** Response from the /property endpoints. */
|
|
9796
|
+
interface PropertyResponse {
|
|
9797
|
+
property: Property;
|
|
9798
|
+
}
|
|
9799
|
+
/** Response from the /agent endpoint. */
|
|
9800
|
+
interface AgentResponse {
|
|
9801
|
+
agent: Agent;
|
|
9802
|
+
}
|
|
9803
|
+
/** Response from the /autocomplete endpoint. */
|
|
9804
|
+
interface AutocompleteResponse {
|
|
9805
|
+
query: string;
|
|
9806
|
+
results: AutocompleteResult[];
|
|
9807
|
+
}
|
|
9808
|
+
/** Response from the /markets endpoint. */
|
|
9809
|
+
interface MarketsResponse {
|
|
9810
|
+
markets: MarketInfo[];
|
|
9811
|
+
}
|
|
9812
|
+
/** Listing status filter. */
|
|
9813
|
+
type ZillowStatus = "for_sale" | "for_rent" | "sold";
|
|
9814
|
+
/** Sort order for search results. */
|
|
9815
|
+
type ZillowSort = "homes_for_you" | "newest" | "price_high_to_low" | "price_low_to_high" | "bedrooms" | "bathrooms" | "square_feet" | "lot_size" | "year_built";
|
|
9816
|
+
/** Options for the search endpoint. */
|
|
9817
|
+
interface ZillowSearchOptions {
|
|
9818
|
+
/** Listing status (default: "for_sale") */
|
|
9819
|
+
status?: ZillowStatus;
|
|
9820
|
+
/** Page number, 1-20 (Zillow caps search at 20 pages / ~820 results) */
|
|
9821
|
+
page?: number;
|
|
9822
|
+
/** Sort order */
|
|
9823
|
+
sort?: ZillowSort;
|
|
9824
|
+
/** Minimum price */
|
|
9825
|
+
priceMin?: number;
|
|
9826
|
+
/** Maximum price */
|
|
9827
|
+
priceMax?: number;
|
|
9828
|
+
/** Minimum bedrooms (0-10) */
|
|
9829
|
+
bedsMin?: number;
|
|
9830
|
+
/** Minimum bathrooms (0-10) */
|
|
9831
|
+
bathsMin?: number;
|
|
9832
|
+
/** Home type (houses|condos|townhomes|apartments|manufactured|lots|multi_family) */
|
|
9833
|
+
homeType?: string;
|
|
9834
|
+
/** Minimum living area (sqft) */
|
|
9835
|
+
sqftMin?: number;
|
|
9836
|
+
/** Maximum living area (sqft) */
|
|
9837
|
+
sqftMax?: number;
|
|
9838
|
+
/** Minimum lot size (sqft) */
|
|
9839
|
+
lotMin?: number;
|
|
9840
|
+
/** Maximum lot size (sqft) */
|
|
9841
|
+
lotMax?: number;
|
|
9842
|
+
/** Minimum year built */
|
|
9843
|
+
yearBuiltMin?: number;
|
|
9844
|
+
/** Maximum year built */
|
|
9845
|
+
yearBuiltMax?: number;
|
|
9846
|
+
/** Max monthly HOA */
|
|
9847
|
+
hoaMax?: number;
|
|
9848
|
+
/** Match listing description keywords */
|
|
9849
|
+
keywords?: string;
|
|
9850
|
+
/** Days on Zillow filter (e.g. "1", "7", "30") */
|
|
9851
|
+
daysOn?: string;
|
|
9852
|
+
/** Map bounds north latitude (for tiling past the 820 cap) */
|
|
9853
|
+
north?: number;
|
|
9854
|
+
/** Map bounds south latitude */
|
|
9855
|
+
south?: number;
|
|
9856
|
+
/** Map bounds east longitude */
|
|
9857
|
+
east?: number;
|
|
9858
|
+
/** Map bounds west longitude */
|
|
9859
|
+
west?: number;
|
|
9860
|
+
}
|
|
9861
|
+
/** Options for the agent endpoint. Provide a `username` or a `url`. */
|
|
9862
|
+
interface ZillowAgentOptions {
|
|
9863
|
+
/** Zillow profile username (screen name) */
|
|
9864
|
+
username?: string;
|
|
9865
|
+
/** Full Zillow /profile/... URL */
|
|
9866
|
+
url?: string;
|
|
9867
|
+
}
|
|
9868
|
+
|
|
9869
|
+
/**
|
|
9870
|
+
* Zillow Search API client.
|
|
9871
|
+
*
|
|
9872
|
+
* Provides methods for property search and location autocomplete.
|
|
9873
|
+
*/
|
|
9874
|
+
|
|
9875
|
+
/**
|
|
9876
|
+
* Client for zillow search and autocomplete endpoints.
|
|
9877
|
+
*
|
|
9878
|
+
* @example
|
|
9879
|
+
* ```typescript
|
|
9880
|
+
* const client = new ScrapeBadger({ apiKey: "key" });
|
|
9881
|
+
*
|
|
9882
|
+
* const results = await client.zillow.search.search("Austin, TX", { bedsMin: 3 });
|
|
9883
|
+
* for (const l of results.results) {
|
|
9884
|
+
* console.log(`${l.address} — ${l.price_raw}`);
|
|
9885
|
+
* }
|
|
9886
|
+
*
|
|
9887
|
+
* const suggestions = await client.zillow.search.autocomplete("Miami");
|
|
9888
|
+
* ```
|
|
9889
|
+
*/
|
|
9890
|
+
declare class SearchClient {
|
|
9891
|
+
private readonly client;
|
|
9892
|
+
constructor(client: BaseClient);
|
|
9893
|
+
/**
|
|
9894
|
+
* Search Zillow for properties.
|
|
9895
|
+
*
|
|
9896
|
+
* Beat the ~820-result (20-page) cap by re-issuing the search over
|
|
9897
|
+
* subdivided `north/south/east/west` map-bound boxes returned in
|
|
9898
|
+
* `map_bounds`.
|
|
9899
|
+
*
|
|
9900
|
+
* @param location - City/state, ZIP, address, or neighborhood ("Austin, TX").
|
|
9901
|
+
* @param options - Filters, sorting, pagination, and map bounds.
|
|
9902
|
+
* @returns Search results with pagination and map metadata.
|
|
9903
|
+
* @throws AuthenticationError - If the API key is invalid.
|
|
9904
|
+
* @throws ValidationError - If the parameters are invalid.
|
|
9905
|
+
*/
|
|
9906
|
+
search(location: string, options?: ZillowSearchOptions): Promise<SearchResponse>;
|
|
9907
|
+
/**
|
|
9908
|
+
* Resolve a search term to Zillow regions/addresses (regionId, lat/lng).
|
|
9909
|
+
*
|
|
9910
|
+
* @param query - Partial location — city, ZIP, address, or neighborhood.
|
|
9911
|
+
* @returns Autocomplete suggestions.
|
|
9912
|
+
*/
|
|
9913
|
+
autocomplete(query: string): Promise<AutocompleteResponse>;
|
|
9914
|
+
}
|
|
9915
|
+
|
|
9916
|
+
/**
|
|
9917
|
+
* Zillow Properties API client.
|
|
9918
|
+
*
|
|
9919
|
+
* Provides a method for fetching full property detail.
|
|
9920
|
+
*/
|
|
9921
|
+
|
|
9922
|
+
/**
|
|
9923
|
+
* Client for the zillow property detail endpoint.
|
|
9924
|
+
*
|
|
9925
|
+
* @example
|
|
9926
|
+
* ```typescript
|
|
9927
|
+
* const client = new ScrapeBadger({ apiKey: "key" });
|
|
9928
|
+
*
|
|
9929
|
+
* const { property } = await client.zillow.properties.getProperty("2078029085");
|
|
9930
|
+
* console.log(property.street_address, property.price);
|
|
9931
|
+
* ```
|
|
9932
|
+
*/
|
|
9933
|
+
declare class PropertiesClient {
|
|
9934
|
+
private readonly client;
|
|
9935
|
+
constructor(client: BaseClient);
|
|
9936
|
+
/**
|
|
9937
|
+
* Get a single Zillow property's full detail by its zpid.
|
|
9938
|
+
*
|
|
9939
|
+
* Returns price/valuation, specs, resoFacts (home_facts), price & tax
|
|
9940
|
+
* history, schools, listing agent, mortgage rates and photos.
|
|
9941
|
+
*
|
|
9942
|
+
* @param zpid - The Zillow property id.
|
|
9943
|
+
* @returns Property detail wrapped in `{ property }`.
|
|
9944
|
+
* @throws NotFoundError - If the property doesn't exist.
|
|
9945
|
+
*/
|
|
9946
|
+
getProperty(zpid: string): Promise<PropertyResponse>;
|
|
9947
|
+
}
|
|
9948
|
+
|
|
9949
|
+
/**
|
|
9950
|
+
* Zillow Agent API client.
|
|
9951
|
+
*
|
|
9952
|
+
* Provides a method for fetching an agent profile and their listings.
|
|
9953
|
+
*/
|
|
9954
|
+
|
|
9955
|
+
/**
|
|
9956
|
+
* Client for the zillow agent profile endpoint.
|
|
9957
|
+
*
|
|
9958
|
+
* @example
|
|
9959
|
+
* ```typescript
|
|
9960
|
+
* const client = new ScrapeBadger({ apiKey: "key" });
|
|
9961
|
+
*
|
|
9962
|
+
* const { agent } = await client.zillow.agent.getAgent({ username: "some-agent" });
|
|
9963
|
+
* console.log(agent.name, agent.review_count, agent.listings.length);
|
|
9964
|
+
* ```
|
|
9965
|
+
*/
|
|
9966
|
+
declare class AgentClient {
|
|
9967
|
+
private readonly client;
|
|
9968
|
+
constructor(client: BaseClient);
|
|
9969
|
+
/**
|
|
9970
|
+
* Get a Zillow real-estate professional's profile and their active listings.
|
|
9971
|
+
*
|
|
9972
|
+
* Provide either a `username` (screen name) or a full `url`.
|
|
9973
|
+
*
|
|
9974
|
+
* @param options - The agent `username` or profile `url`.
|
|
9975
|
+
* @returns Agent profile wrapped in `{ agent }`.
|
|
9976
|
+
* @throws NotFoundError - If the agent doesn't exist.
|
|
9977
|
+
* @throws ValidationError - If neither username nor url is provided.
|
|
9978
|
+
*/
|
|
9979
|
+
getAgent(options?: ZillowAgentOptions): Promise<AgentResponse>;
|
|
9980
|
+
}
|
|
9981
|
+
|
|
9982
|
+
/**
|
|
9983
|
+
* Zillow Reference Data API client.
|
|
9984
|
+
*
|
|
9985
|
+
* Provides a method for fetching the coverage market list.
|
|
9986
|
+
*/
|
|
9987
|
+
|
|
9988
|
+
/**
|
|
9989
|
+
* Client for zillow reference data endpoints (markets).
|
|
9990
|
+
*
|
|
9991
|
+
* @example
|
|
9992
|
+
* ```typescript
|
|
9993
|
+
* const client = new ScrapeBadger({ apiKey: "key" });
|
|
9994
|
+
*
|
|
9995
|
+
* const markets = await client.zillow.reference.listMarkets();
|
|
9996
|
+
* for (const m of markets.markets) {
|
|
9997
|
+
* console.log(`${m.code}: ${m.domain} (${m.currency})`);
|
|
9998
|
+
* }
|
|
9999
|
+
* ```
|
|
10000
|
+
*/
|
|
10001
|
+
declare class ReferenceClient {
|
|
10002
|
+
private readonly client;
|
|
10003
|
+
constructor(client: BaseClient);
|
|
10004
|
+
/**
|
|
10005
|
+
* List Zillow coverage regions (US + Canada, all served via zillow.com).
|
|
10006
|
+
*
|
|
10007
|
+
* @returns Markets response with all supported markets.
|
|
10008
|
+
*/
|
|
10009
|
+
listMarkets(): Promise<MarketsResponse>;
|
|
10010
|
+
}
|
|
10011
|
+
|
|
10012
|
+
/**
|
|
10013
|
+
* Zillow API client.
|
|
10014
|
+
*
|
|
10015
|
+
* Provides access to all Zillow API endpoints through specialized sub-clients.
|
|
10016
|
+
*/
|
|
10017
|
+
|
|
10018
|
+
/**
|
|
10019
|
+
* Zillow API client with access to all Zillow endpoints.
|
|
10020
|
+
*
|
|
10021
|
+
* Maximal-coverage real-estate API over zillow.com (US + Canadian inventory,
|
|
10022
|
+
* all served from zillow.com behind a US IP).
|
|
10023
|
+
*
|
|
10024
|
+
* Provides sub-clients for different resource types:
|
|
10025
|
+
* - `search` - Property search and location autocomplete
|
|
10026
|
+
* - `properties` - Full property detail
|
|
10027
|
+
* - `agent` - Agent profile + their listings
|
|
10028
|
+
* - `reference` - Reference data (markets)
|
|
10029
|
+
*
|
|
10030
|
+
* @example
|
|
10031
|
+
* ```typescript
|
|
10032
|
+
* const client = new ScrapeBadger({ apiKey: "key" });
|
|
10033
|
+
*
|
|
10034
|
+
* // Search properties
|
|
10035
|
+
* const results = await client.zillow.search.search("Austin, TX");
|
|
10036
|
+
*
|
|
10037
|
+
* // Location autocomplete
|
|
10038
|
+
* const suggestions = await client.zillow.search.autocomplete("Miami");
|
|
10039
|
+
*
|
|
10040
|
+
* // Get property detail
|
|
10041
|
+
* const { property } = await client.zillow.properties.getProperty("2078029085");
|
|
10042
|
+
*
|
|
10043
|
+
* // Get an agent profile
|
|
10044
|
+
* const { agent } = await client.zillow.agent.getAgent({ username: "some-agent" });
|
|
10045
|
+
*
|
|
10046
|
+
* // Reference data
|
|
10047
|
+
* const markets = await client.zillow.reference.listMarkets();
|
|
10048
|
+
* ```
|
|
10049
|
+
*/
|
|
10050
|
+
declare class ZillowClient {
|
|
10051
|
+
/** Client for property search and location autocomplete */
|
|
10052
|
+
readonly search: SearchClient;
|
|
10053
|
+
/** Client for full property detail */
|
|
10054
|
+
readonly properties: PropertiesClient;
|
|
10055
|
+
/** Client for agent profile + listings */
|
|
10056
|
+
readonly agent: AgentClient;
|
|
10057
|
+
/** Client for reference data (markets) */
|
|
10058
|
+
readonly reference: ReferenceClient;
|
|
10059
|
+
/**
|
|
10060
|
+
* Create a new Zillow client.
|
|
10061
|
+
*
|
|
10062
|
+
* @param client - The base HTTP client for making requests.
|
|
10063
|
+
*/
|
|
10064
|
+
constructor(client: BaseClient);
|
|
10065
|
+
}
|
|
10066
|
+
|
|
8692
10067
|
/**
|
|
8693
10068
|
* Main ScrapeBadger client.
|
|
8694
10069
|
*
|
|
@@ -8751,6 +10126,10 @@ declare class ScrapeBadger {
|
|
|
8751
10126
|
readonly youtube: YoutubeClient;
|
|
8752
10127
|
/** Realtor scraper API client — 4 endpoints across 2 markets (us, ca) */
|
|
8753
10128
|
readonly realtor: RealtorClient;
|
|
10129
|
+
/** Leboncoin scraper API client — 10 endpoints (France) */
|
|
10130
|
+
readonly leboncoin: LeboncoinClient;
|
|
10131
|
+
/** Zillow scraper API client — 5 endpoints (search, property, agent, autocomplete, markets) */
|
|
10132
|
+
readonly zillow: ZillowClient;
|
|
8754
10133
|
/**
|
|
8755
10134
|
* Create a new ScrapeBadger client.
|
|
8756
10135
|
*
|
|
@@ -8779,4 +10158,4 @@ declare class ScrapeBadger {
|
|
|
8779
10158
|
constructor(config?: Partial<ScrapeBadgerConfig>);
|
|
8780
10159
|
}
|
|
8781
10160
|
|
|
8782
|
-
export { type AiListItem, type AiModeResponse, type AiModeSearchParams, type AiReference, type AiTableRow, type AiTextBlock, type AmazonAutocompleteParams, type AutocompleteResponse$3 as AmazonAutocompleteResponse, type AutocompleteSuggestion$1 as AmazonAutocompleteSuggestion, type Bestseller as AmazonBestseller, type BestsellersRankEntry as AmazonBestsellersRankEntry, type BestsellersResponse as AmazonBestsellersResponse, type Buybox as AmazonBuybox, type CategoriesResponse$2 as AmazonCategoriesResponse, type CategoryInfo$1 as AmazonCategoryInfo, type AmazonCategoryParams, type CategoryResponse$1 as AmazonCategoryResponse, AmazonClient, type Coupon as AmazonCoupon, type Deal as AmazonDeal, type AmazonDealsParams, type DealsResponse as AmazonDealsResponse, type Delivery as AmazonDelivery, type FeedbackWindow as AmazonFeedbackWindow, ListingsClient as AmazonListingsClient, type AmazonListingsParams, type MarketInfo$3 as AmazonMarketInfo, type MarketsResponse$4 as AmazonMarketsResponse, type NewReleasesResponse as AmazonNewReleasesResponse, type Offer as AmazonOffer, type OfferCondition as AmazonOfferCondition, type OfferDelivery as AmazonOfferDelivery, type OfferSeller as AmazonOfferSeller, type AmazonOffersParams, type OffersResponse as AmazonOffersResponse, type Pagination$1 as AmazonPagination, type AmazonPrice, type Product as AmazonProduct, type ProductBadges as AmazonProductBadges, type ProductDeal as AmazonProductDeal, type ProductDetailResponse as AmazonProductDetailResponse, type AmazonProductParams, type ProductVariant as AmazonProductVariant, ProductsClient$1 as AmazonProductsClient, type RatingBreakdown$1 as AmazonRatingBreakdown, ReferenceClient$5 as AmazonReferenceClient, type RelatedProduct as AmazonRelatedProduct, type Review$1 as AmazonReview, type ReviewProfile as AmazonReviewProfile, type AmazonReviewsParams, type ReviewsResponse$1 as AmazonReviewsResponse, SearchClient$5 as AmazonSearchClient, type AmazonSearchParams, type SearchResponse$3 as AmazonSearchResponse, type SearchResult$3 as AmazonSearchResult, type Seller$1 as AmazonSeller, type SellerFeedbackEntry as AmazonSellerFeedbackEntry, type SellerFeedbackResponse$1 as AmazonSellerFeedbackResponse, type SellerFeedbackSummary as AmazonSellerFeedbackSummary, type AmazonSellerListParams, type AmazonSellerParams, type SellerProductsResponse as AmazonSellerProductsResponse, type SellerProfileResponse$1 as AmazonSellerProfileResponse, SellersClient$1 as AmazonSellersClient, type AutocompleteParams, type DetectOptions, type DetectResult, type DomainPostsResponse, type EbayAutocompleteParams, type AutocompleteResponse$2 as EbayAutocompleteResponse, type AutocompleteSuggestion as EbayAutocompleteSuggestion, type EbayBuyingFormat, CategoriesClient as EbayCategoriesClient, type CategoriesResponse$1 as EbayCategoriesResponse, type CategoryInfo as EbayCategoryInfo, type EbayCategoryParams, type CategoryResponse as EbayCategoryResponse, EbayClient, type EbayCompletedParams, type EbayCondition, type FeedbackBreakdown as EbayFeedbackBreakdown, type FeedbackEntry as EbayFeedbackEntry, type Image as EbayImage, type Item as EbayItem, type ItemDetailResponse as EbayItemDetailResponse, type EbayItemParams, type ItemSeller as EbayItemSeller, ItemsClient as EbayItemsClient, type MarketInfo$2 as EbayMarketInfo, type MarketsResponse$2 as EbayMarketsResponse, type Pagination as EbayPagination, type EbayPrice, type RatingHistogram as EbayRatingHistogram, ReferenceClient$2 as EbayReferenceClient, type ReturnsPolicy as EbayReturnsPolicy, type Review as EbayReview, type EbayReviewsParams, type ReviewsResponse as EbayReviewsResponse, SearchClient$2 as EbaySearchClient, type EbaySearchParams, type SearchResponse$2 as EbaySearchResponse, type SearchResult$1 as EbaySearchResult, type Seller as EbaySeller, type EbaySellerFeedbackParams, type SellerFeedbackResponse as EbaySellerFeedbackResponse, type EbaySellerItemsParams, type SellerItemsResponse as EbaySellerItemsResponse, type EbaySellerParams, type SellerProfileResponse as EbaySellerProfileResponse, SellersClient as EbaySellersClient, type ShippingOption as EbayShippingOption, type EbaySortBy, type FinanceQuoteParams, type FlightsSearchParams, type FlightsStopsFilter, type FlightsTravelClass, type FlightsTripType, AiModeClient as GoogleAiModeClient, AutocompleteClient as GoogleAutocompleteClient, GoogleClient, FinanceClient as GoogleFinanceClient, FlightsClient as GoogleFlightsClient, HotelsClient as GoogleHotelsClient, ImagesClient as GoogleImagesClient, JobsClient as GoogleJobsClient, LensClient as GoogleLensClient, MapsClient as GoogleMapsClient, NewsClient as GoogleNewsClient, PatentsClient as GooglePatentsClient, ProductsClient$2 as GoogleProductsClient, type GoogleResponse, ScholarClient as GoogleScholarClient, SearchClient$7 as GoogleSearchClient, type GoogleSearchParams, ShoppingClient as GoogleShoppingClient, ShortsClient$1 as GoogleShortsClient, TrendsClient as GoogleTrendsClient, VideosClient$2 as GoogleVideosClient, type HotelsDetailsParams, type HotelsSearchParams, type ImagesSearchParams, type JobsSearchParams, type LensSearchParams, type MapsPhotosParams, type MapsPlaceParams, type MapsPostsParams, type MapsReviewsParams, type MapsSearchParams, type NewsSearchParams, type NewsTopicsParams, type NewsTrendingParams, type PatentsDetailParams, type PatentsSearchParams, type PopularSubredditsResponse, type PostCommentsResponse, type PostDetailResponse, type PostDuplicatesResponse, type ProductsDetailParams, type Address as RealtorAddress, type Agent as RealtorAgent, type RealtorAutocompleteOptions, type AutocompleteResponse as RealtorAutocompleteResponse, RealtorClient, type Coordinate as RealtorCoordinate, type DetailGroup as RealtorDetailGroup, type Estimate as RealtorEstimate, type Flags as RealtorFlags, type RealtorMarket, type MarketInfo as RealtorMarketInfo, type MarketsResponse as RealtorMarketsResponse, type Office as RealtorOffice, type OpenHouse as RealtorOpenHouse, type Phone as RealtorPhone, type Photo as RealtorPhoto, type PriceEvent as RealtorPriceEvent, PropertiesClient as RealtorPropertiesClient, type Property as RealtorProperty, type PropertyDetail as RealtorPropertyDetail, type RealtorPropertyOptions, ReferenceClient as RealtorReferenceClient, type School as RealtorSchool, SearchClient as RealtorSearchClient, type RealtorSearchOptions, type SearchResponse as RealtorSearchResponse, type RealtorSort, type RealtorStatus, type Suggestion as RealtorSuggestion, type TaxRecord as RealtorTaxRecord, type RedditAward, RedditClient, type RedditComment, type RedditModeratedSubreddit, type RedditPagination, type RedditPost, PostsClient as RedditPostsClient, type RedditRule, SearchClient$6 as RedditSearchClient, type RedditSubreddit, SubredditsClient as RedditSubredditsClient, type RedditTrophy, type RedditUser, type UserProfileResponse as RedditUserProfileResponse, type RedditUserSubreddit, UsersClient$1 as RedditUsersClient, type RedditWikiPage, type ScholarAuthorCitationParams, type ScholarAuthorParams, type ScholarCiteParams, type ScholarProfilesParams, type ScholarSearchParams, ScrapeBadger, ScrapeBadgerConfig, type ScrapeOptions, type ScrapeResult, type SearchPostsResponse, type SearchSubredditsResponse, type SearchUsersResponse, type ShopeeCategoriesParams, type ShopeeCategoryItemsParams, type CategoryNode as ShopeeCategoryNode, type CategoryTree as ShopeeCategoryTree, ShopeeClient, type ShopeeMarket, type MarketsResponse$3 as ShopeeMarketsResponse, type ShopeeProduct, type ProductAttribute as ShopeeProductAttribute, type ProductImage as ShopeeProductImage, type ProductModel as ShopeeProductModel, type ShopeeProductParams, ProductsClient as ShopeeProductsClient, type RatingBreakdown as ShopeeRatingBreakdown, ReferenceClient$4 as ShopeeReferenceClient, type ShopeeReview, type ReviewReply as ShopeeReviewReply, type ReviewSummary as ShopeeReviewSummary, ReviewsClient as ShopeeReviewsClient, type ShopeeReviewsParams, type ReviewsResult as ShopeeReviewsResult, SearchClient$4 as ShopeeSearchClient, type ShopeeSearchParams, type SearchResult$2 as ShopeeSearchResult, type ShoppingClickParams, type ShoppingOffersParams, type ShoppingProductParams, type ShoppingSearchParams, type ShortsSearchParams, type SubredditDetailResponse, type SubredditPostsResponse, type SubredditRulesResponse, type SubredditWikiPagesResponse, type TikTokAd, type AdLibraryPage as TikTokAdLibraryPage, type AdLibrarySearchResponse as TikTokAdLibrarySearchResponse, type TikTokAdSearchParams, type TikTokAdVideo, AdsClient as TikTokAdsClient, type TikTokAnchor, type TikTokAuthor, type TikTokChallenge, TikTokClient, type TikTokComment, type CommentListResponse as TikTokCommentListResponse, type TikTokCommentRepliesParams, type TikTokCommentsParams, type TikTokCursorPage, type TikTokEffectSticker, type TikTokHashtag, type TikTokHashtagParams, type HashtagResponse$1 as TikTokHashtagResponse, type HashtagSearchResponse as TikTokHashtagSearchResponse, HashtagsClient as TikTokHashtagsClient, type TikTokListVideosParams, type TikTokMusic, MusicClient$1 as TikTokMusicClient, type TikTokMusicParams, type MusicResponse as TikTokMusicResponse, type TikTokOEmbed, type TikTokOEmbedParams, type ProfileResponse as TikTokProfileResponse, ReferenceClient$3 as TikTokReferenceClient, type RegionInfo as TikTokRegionInfo, type RegionsResponse$1 as TikTokRegionsResponse, type TikTokRelatedParams, SearchClient$3 as TikTokSearchClient, type TikTokSearchParams, type TikTokStats, type TikTokSubtitle, type TikTokTextExtra, type TikTokTranscriptParams, type TranscriptResponse as TikTokTranscriptResponse, TrendingClient$1 as TikTokTrendingClient, type TikTokTrendingHashtag, type TrendingHashtagsResponse as TikTokTrendingHashtagsResponse, type TikTokTrendingParams, type TikTokTrendingSong, type TrendingSongsResponse as TikTokTrendingSongsResponse, type TikTokTrendingVideosParams, type TikTokUser, type TikTokUserListParams, type UserListResponse as TikTokUserListResponse, type TikTokUserParams, type UserSearchResponse as TikTokUserSearchResponse, type TikTokUserStats, UsersClient as TikTokUsersClient, type TikTokVideo, type TikTokVideoControl, type VideoListResponse as TikTokVideoListResponse, type TikTokVideoMeta, type TikTokVideoParams, type VideoResponse as TikTokVideoResponse, type TikTokVideoStatus, VideosClient$1 as TikTokVideosClient, type TrendingPostsResponse, type TrendsAutocompleteParams, type TrendsInterestParams, type TrendsRegionsParams, type TrendsRelatedParams, type TrendsTrendingParams, TwitterClient, type UserCommentsResponse, type UserModeratedResponse, type UserPostsResponse, type UserTrophiesResponse, type VideosSearchParams, type VintedBrand, type BrandsResponse as VintedBrandsResponse, VintedClient, type VintedColor, type ColorsResponse as VintedColorsResponse, type VintedItemDetail, type ItemDetailResponse$1 as VintedItemDetailResponse, type VintedItemSummary, ItemsClient$1 as VintedItemsClient, type VintedMarket, type MarketsResponse$5 as VintedMarketsResponse, type VintedPagination, type VintedPhoto, type VintedPrice, ReferenceClient$6 as VintedReferenceClient, SearchClient$8 as VintedSearchClient, type VintedSearchParams, type SearchResponse$4 as VintedSearchResponse, type VintedSellerSummary, type VintedStatus, type StatusesResponse as VintedStatusesResponse, type UserItemsResponse as VintedUserItemsResponse, type VintedUserProfile, type UserProfileResponse$1 as VintedUserProfileResponse, type VintedUserSummary, UsersClient$2 as VintedUsersClient, WebClient, type WikiPageResponse, type AudioTrack as YoutubeAudioTrack, type YoutubeAutocompleteParams, type AutocompleteResponse$1 as YoutubeAutocompleteResponse, type YoutubeBatchParams, type BatchResponse as YoutubeBatchResponse, type CaptionTrack as YoutubeCaptionTrack, type YoutubeCaptionsParams, type CaptionsResponse as YoutubeCaptionsResponse, type YoutubeCategoriesParams, type CategoriesResponse as YoutubeCategoriesResponse, type Channel as YoutubeChannel, type ChannelAbout as YoutubeChannelAbout, type ChannelLink as YoutubeChannelLink, type YoutubeChannelParams, type YoutubeChannelSearchParams, type YoutubeChannelTabParams, type ChannelTabResponse as YoutubeChannelTabResponse, type ChannelVideosResponse as YoutubeChannelVideosResponse, ChannelsClient as YoutubeChannelsClient, type Chapter as YoutubeChapter, YoutubeClient, type Comment as YoutubeComment, type YoutubeCommentSort, type YoutubeCommentsParams, type CommentsResponse as YoutubeCommentsResponse, CommunityClient as YoutubeCommunityClient, type CommunityPost as YoutubeCommunityPost, type CommunityResponse as YoutubeCommunityResponse, type YoutubeDuration, type Format as YoutubeFormat, type YoutubeHashtagParams, type HashtagResponse as YoutubeHashtagResponse, type HeatMarker as YoutubeHeatMarker, type YoutubeHomeParams, type HomeResponse as YoutubeHomeResponse, type LanguagesResponse as YoutubeLanguagesResponse, type LiveChatMessage as YoutubeLiveChatMessage, type YoutubeLiveChatParams, type LiveChatResponse as YoutubeLiveChatResponse, type LiveStreamingDetails as YoutubeLiveStreamingDetails, type MarketInfo$1 as YoutubeMarketInfo, type MarketsResponse$1 as YoutubeMarketsResponse, MusicClient as YoutubeMusicClient, type YoutubeMusicSearchParams, type OEmbed as YoutubeOEmbed, type YoutubeOEmbedParams, type Playlist as YoutubePlaylist, type PlaylistItem as YoutubePlaylistItem, type YoutubePlaylistItemsParams, type PlaylistItemsResponse as YoutubePlaylistItemsResponse, type YoutubePlaylistParams, PlaylistsClient as YoutubePlaylistsClient, type PollChoice as YoutubePollChoice, type YoutubePostCommentsParams, type YoutubePostParams, ReferenceClient$1 as YoutubeReferenceClient, type ReferenceRow as YoutubeReferenceRow, type YoutubeRegionParams, type RegionRestriction as YoutubeRegionRestriction, type RegionsResponse as YoutubeRegionsResponse, type YoutubeRelatedParams, type RelatedResponse as YoutubeRelatedResponse, type YoutubeRepliesParams, type RepliesResponse as YoutubeRepliesResponse, type YoutubeResolveParams, type ResolveResult as YoutubeResolveResult, type SearchChip as YoutubeSearchChip, SearchClient$1 as YoutubeSearchClient, type YoutubeSearchParams, type SearchResponse$1 as YoutubeSearchResponse, type SearchResult as YoutubeSearchResult, type YoutubeSearchSort, type YoutubeSearchType, type ShoppingResult as YoutubeShoppingResult, type Short as YoutubeShort, type YoutubeShortParams, type YoutubeShortsBySoundParams, ShortsClient as YoutubeShortsClient, type StreamingData as YoutubeStreamingData, type YoutubeStreamsClient, type YoutubeStreamsParams, type SubscriberCount as YoutubeSubscriberCount, type Thumbnail as YoutubeThumbnail, type Transcript as YoutubeTranscript, type YoutubeTranscriptParams, type TranscriptSegment as YoutubeTranscriptSegment, TrendingClient as YoutubeTrendingClient, type TrendingItem as YoutubeTrendingItem, type YoutubeTrendingParams, type TrendingResponse as YoutubeTrendingResponse, type YoutubeTrendingShortsParams, type YoutubeTrendingType, type YoutubeUploadDate, type Video as YoutubeVideo, type YoutubeVideoParams, VideosClient as YoutubeVideosClient };
|
|
10161
|
+
export { type AiListItem, type AiModeResponse, type AiModeSearchParams, type AiReference, type AiTableRow, type AiTextBlock, type AmazonAutocompleteParams, type AutocompleteResponse$4 as AmazonAutocompleteResponse, type AutocompleteSuggestion$1 as AmazonAutocompleteSuggestion, type Bestseller as AmazonBestseller, type BestsellersRankEntry as AmazonBestsellersRankEntry, type BestsellersResponse as AmazonBestsellersResponse, type Buybox as AmazonBuybox, type CategoriesResponse$3 as AmazonCategoriesResponse, type CategoryInfo$1 as AmazonCategoryInfo, type AmazonCategoryParams, type CategoryResponse$1 as AmazonCategoryResponse, AmazonClient, type Coupon as AmazonCoupon, type Deal as AmazonDeal, type AmazonDealsParams, type DealsResponse as AmazonDealsResponse, type Delivery as AmazonDelivery, type FeedbackWindow as AmazonFeedbackWindow, ListingsClient as AmazonListingsClient, type AmazonListingsParams, type MarketInfo$4 as AmazonMarketInfo, type MarketsResponse$6 as AmazonMarketsResponse, type NewReleasesResponse as AmazonNewReleasesResponse, type Offer as AmazonOffer, type OfferCondition as AmazonOfferCondition, type OfferDelivery as AmazonOfferDelivery, type OfferSeller as AmazonOfferSeller, type AmazonOffersParams, type OffersResponse as AmazonOffersResponse, type Pagination$2 as AmazonPagination, type AmazonPrice, type Product as AmazonProduct, type ProductBadges as AmazonProductBadges, type ProductDeal as AmazonProductDeal, type ProductDetailResponse as AmazonProductDetailResponse, type AmazonProductParams, type ProductVariant as AmazonProductVariant, ProductsClient$1 as AmazonProductsClient, type RatingBreakdown$1 as AmazonRatingBreakdown, ReferenceClient$7 as AmazonReferenceClient, type RelatedProduct as AmazonRelatedProduct, type Review$1 as AmazonReview, type ReviewProfile as AmazonReviewProfile, type AmazonReviewsParams, type ReviewsResponse$1 as AmazonReviewsResponse, SearchClient$7 as AmazonSearchClient, type AmazonSearchParams, type SearchResponse$5 as AmazonSearchResponse, type SearchResult$3 as AmazonSearchResult, type Seller$2 as AmazonSeller, type SellerFeedbackEntry as AmazonSellerFeedbackEntry, type SellerFeedbackResponse$1 as AmazonSellerFeedbackResponse, type SellerFeedbackSummary as AmazonSellerFeedbackSummary, type AmazonSellerListParams, type AmazonSellerParams, type SellerProductsResponse as AmazonSellerProductsResponse, type SellerProfileResponse$1 as AmazonSellerProfileResponse, SellersClient$2 as AmazonSellersClient, type AutocompleteParams, type DetectOptions, type DetectResult, type DomainPostsResponse, type EbayAutocompleteParams, type AutocompleteResponse$3 as EbayAutocompleteResponse, type AutocompleteSuggestion as EbayAutocompleteSuggestion, type EbayBuyingFormat, CategoriesClient as EbayCategoriesClient, type CategoriesResponse$2 as EbayCategoriesResponse, type CategoryInfo as EbayCategoryInfo, type EbayCategoryParams, type CategoryResponse as EbayCategoryResponse, EbayClient, type EbayCompletedParams, type EbayCondition, type FeedbackBreakdown as EbayFeedbackBreakdown, type FeedbackEntry as EbayFeedbackEntry, type Image as EbayImage, type Item as EbayItem, type ItemDetailResponse as EbayItemDetailResponse, type EbayItemParams, type ItemSeller as EbayItemSeller, ItemsClient as EbayItemsClient, type MarketInfo$3 as EbayMarketInfo, type MarketsResponse$4 as EbayMarketsResponse, type Pagination$1 as EbayPagination, type EbayPrice, type RatingHistogram as EbayRatingHistogram, ReferenceClient$4 as EbayReferenceClient, type ReturnsPolicy as EbayReturnsPolicy, type Review as EbayReview, type EbayReviewsParams, type ReviewsResponse as EbayReviewsResponse, SearchClient$4 as EbaySearchClient, type EbaySearchParams, type SearchResponse$4 as EbaySearchResponse, type SearchResult$1 as EbaySearchResult, type Seller$1 as EbaySeller, type EbaySellerFeedbackParams, type SellerFeedbackResponse as EbaySellerFeedbackResponse, type EbaySellerItemsParams, type SellerItemsResponse as EbaySellerItemsResponse, type EbaySellerParams, type SellerProfileResponse as EbaySellerProfileResponse, SellersClient$1 as EbaySellersClient, type ShippingOption as EbayShippingOption, type EbaySortBy, type FinanceQuoteParams, type FlightsSearchParams, type FlightsStopsFilter, type FlightsTravelClass, type FlightsTripType, AiModeClient as GoogleAiModeClient, AutocompleteClient as GoogleAutocompleteClient, GoogleClient, FinanceClient as GoogleFinanceClient, FlightsClient as GoogleFlightsClient, HotelsClient as GoogleHotelsClient, ImagesClient as GoogleImagesClient, JobsClient as GoogleJobsClient, LensClient as GoogleLensClient, MapsClient as GoogleMapsClient, NewsClient as GoogleNewsClient, PatentsClient as GooglePatentsClient, ProductsClient$2 as GoogleProductsClient, type GoogleResponse, ScholarClient as GoogleScholarClient, SearchClient$9 as GoogleSearchClient, type GoogleSearchParams, ShoppingClient as GoogleShoppingClient, ShortsClient$1 as GoogleShortsClient, TrendsClient as GoogleTrendsClient, VideosClient$2 as GoogleVideosClient, type HotelsDetailsParams, type HotelsSearchParams, type ImagesSearchParams, type JobsSearchParams, type Ad as LeboncoinAd, type AdResponse as LeboncoinAdResponse, type LeboncoinAdType, AdsClient as LeboncoinAdsClient, type Attribute as LeboncoinAttribute, type CategoriesResponse as LeboncoinCategoriesResponse, type Category as LeboncoinCategory, LeboncoinClient, type Department as LeboncoinDepartment, type LeboncoinDepartmentsParams, type DepartmentsResponse as LeboncoinDepartmentsResponse, type FeedbackScores as LeboncoinFeedbackScores, type Images as LeboncoinImages, type Location as LeboncoinLocation, type LocationSearchResponse as LeboncoinLocationSearchResponse, type LocationSuggestion as LeboncoinLocationSuggestion, type MarketsResponse$1 as LeboncoinMarketsResponse, type Owner as LeboncoinOwner, type LeboncoinOwnerType, ReferenceClient$1 as LeboncoinReferenceClient, type Region as LeboncoinRegion, type RegionsResponse as LeboncoinRegionsResponse, SearchClient$1 as LeboncoinSearchClient, type LeboncoinSearchParams, type SearchResponse$1 as LeboncoinSearchResponse, type Seller as LeboncoinSeller, type LeboncoinSellerListingsParams, type SellerListingsResponse as LeboncoinSellerListingsResponse, type SellerResponse as LeboncoinSellerResponse, SellersClient as LeboncoinSellersClient, type LeboncoinSimilarParams, type SimilarResponse as LeboncoinSimilarResponse, type LeboncoinSortBy, type StoreRatingReview as LeboncoinStoreRatingReview, type LensSearchParams, type MapsPhotosParams, type MapsPlaceParams, type MapsPostsParams, type MapsReviewsParams, type MapsSearchParams, type NewsSearchParams, type NewsTopicsParams, type NewsTrendingParams, type PatentsDetailParams, type PatentsSearchParams, type PopularSubredditsResponse, type PostCommentsResponse, type PostDetailResponse, type PostDuplicatesResponse, type ProductsDetailParams, type Address$1 as RealtorAddress, type Agent$1 as RealtorAgent, type RealtorAutocompleteOptions, type AutocompleteResponse$1 as RealtorAutocompleteResponse, RealtorClient, type Coordinate as RealtorCoordinate, type DetailGroup as RealtorDetailGroup, type Estimate as RealtorEstimate, type Flags as RealtorFlags, type RealtorMarket, type MarketInfo$1 as RealtorMarketInfo, type MarketsResponse$2 as RealtorMarketsResponse, type Office as RealtorOffice, type OpenHouse$1 as RealtorOpenHouse, type Phone as RealtorPhone, type Photo$1 as RealtorPhoto, type PriceEvent as RealtorPriceEvent, PropertiesClient$1 as RealtorPropertiesClient, type Property$1 as RealtorProperty, type PropertyDetail as RealtorPropertyDetail, type RealtorPropertyOptions, ReferenceClient$2 as RealtorReferenceClient, type School$1 as RealtorSchool, SearchClient$2 as RealtorSearchClient, type RealtorSearchOptions, type SearchResponse$2 as RealtorSearchResponse, type RealtorSort, type RealtorStatus, type Suggestion as RealtorSuggestion, type TaxRecord as RealtorTaxRecord, type RedditAward, RedditClient, type RedditComment, type RedditModeratedSubreddit, type RedditPagination, type RedditPost, PostsClient as RedditPostsClient, type RedditRule, SearchClient$8 as RedditSearchClient, type RedditSubreddit, SubredditsClient as RedditSubredditsClient, type RedditTrophy, type RedditUser, type UserProfileResponse as RedditUserProfileResponse, type RedditUserSubreddit, UsersClient$1 as RedditUsersClient, type RedditWikiPage, type ScholarAuthorCitationParams, type ScholarAuthorParams, type ScholarCiteParams, type ScholarProfilesParams, type ScholarSearchParams, ScrapeBadger, ScrapeBadgerConfig, type ScrapeOptions, type ScrapeResult, type SearchPostsResponse, type SearchSubredditsResponse, type SearchUsersResponse, type ShopeeCategoriesParams, type ShopeeCategoryItemsParams, type CategoryNode as ShopeeCategoryNode, type CategoryTree as ShopeeCategoryTree, ShopeeClient, type ShopeeMarket, type MarketsResponse$5 as ShopeeMarketsResponse, type ShopeeProduct, type ProductAttribute as ShopeeProductAttribute, type ProductImage as ShopeeProductImage, type ProductModel as ShopeeProductModel, type ShopeeProductParams, ProductsClient as ShopeeProductsClient, type RatingBreakdown as ShopeeRatingBreakdown, ReferenceClient$6 as ShopeeReferenceClient, type ShopeeReview, type ReviewReply as ShopeeReviewReply, type ReviewSummary as ShopeeReviewSummary, ReviewsClient as ShopeeReviewsClient, type ShopeeReviewsParams, type ReviewsResult as ShopeeReviewsResult, SearchClient$6 as ShopeeSearchClient, type ShopeeSearchParams, type SearchResult$2 as ShopeeSearchResult, type ShoppingClickParams, type ShoppingOffersParams, type ShoppingProductParams, type ShoppingSearchParams, type ShortsSearchParams, type SubredditDetailResponse, type SubredditPostsResponse, type SubredditRulesResponse, type SubredditWikiPagesResponse, type TikTokAd, type AdLibraryPage as TikTokAdLibraryPage, type AdLibrarySearchResponse as TikTokAdLibrarySearchResponse, type TikTokAdSearchParams, type TikTokAdVideo, AdsClient$1 as TikTokAdsClient, type TikTokAnchor, type TikTokAuthor, type TikTokChallenge, TikTokClient, type TikTokComment, type CommentListResponse as TikTokCommentListResponse, type TikTokCommentRepliesParams, type TikTokCommentsParams, type TikTokCursorPage, type TikTokEffectSticker, type TikTokHashtag, type TikTokHashtagParams, type HashtagResponse$1 as TikTokHashtagResponse, type HashtagSearchResponse as TikTokHashtagSearchResponse, HashtagsClient as TikTokHashtagsClient, type TikTokListVideosParams, type TikTokMusic, MusicClient$1 as TikTokMusicClient, type TikTokMusicParams, type MusicResponse as TikTokMusicResponse, type TikTokOEmbed, type TikTokOEmbedParams, type ProfileResponse as TikTokProfileResponse, ReferenceClient$5 as TikTokReferenceClient, type RegionInfo as TikTokRegionInfo, type RegionsResponse$2 as TikTokRegionsResponse, type TikTokRelatedParams, SearchClient$5 as TikTokSearchClient, type TikTokSearchParams, type TikTokStats, type TikTokSubtitle, type TikTokTextExtra, type TikTokTranscriptParams, type TranscriptResponse as TikTokTranscriptResponse, TrendingClient$1 as TikTokTrendingClient, type TikTokTrendingHashtag, type TrendingHashtagsResponse as TikTokTrendingHashtagsResponse, type TikTokTrendingParams, type TikTokTrendingSong, type TrendingSongsResponse as TikTokTrendingSongsResponse, type TikTokTrendingVideosParams, type TikTokUser, type TikTokUserListParams, type UserListResponse as TikTokUserListResponse, type TikTokUserParams, type UserSearchResponse as TikTokUserSearchResponse, type TikTokUserStats, UsersClient as TikTokUsersClient, type TikTokVideo, type TikTokVideoControl, type VideoListResponse as TikTokVideoListResponse, type TikTokVideoMeta, type TikTokVideoParams, type VideoResponse as TikTokVideoResponse, type TikTokVideoStatus, VideosClient$1 as TikTokVideosClient, type TrendingPostsResponse, type TrendsAutocompleteParams, type TrendsInterestParams, type TrendsRegionsParams, type TrendsRelatedParams, type TrendsTrendingParams, TwitterClient, type UserCommentsResponse, type UserModeratedResponse, type UserPostsResponse, type UserTrophiesResponse, type VideosSearchParams, type VintedBrand, type BrandsResponse as VintedBrandsResponse, VintedClient, type VintedColor, type ColorsResponse as VintedColorsResponse, type VintedItemDetail, type ItemDetailResponse$1 as VintedItemDetailResponse, type VintedItemSummary, ItemsClient$1 as VintedItemsClient, type VintedMarket, type MarketsResponse$7 as VintedMarketsResponse, type VintedPagination, type VintedPhoto, type VintedPrice, ReferenceClient$8 as VintedReferenceClient, SearchClient$a as VintedSearchClient, type VintedSearchParams, type SearchResponse$6 as VintedSearchResponse, type VintedSellerSummary, type VintedStatus, type StatusesResponse as VintedStatusesResponse, type UserItemsResponse as VintedUserItemsResponse, type VintedUserProfile, type UserProfileResponse$1 as VintedUserProfileResponse, type VintedUserSummary, UsersClient$2 as VintedUsersClient, WebClient, type WikiPageResponse, type AudioTrack as YoutubeAudioTrack, type YoutubeAutocompleteParams, type AutocompleteResponse$2 as YoutubeAutocompleteResponse, type YoutubeBatchParams, type BatchResponse as YoutubeBatchResponse, type CaptionTrack as YoutubeCaptionTrack, type YoutubeCaptionsParams, type CaptionsResponse as YoutubeCaptionsResponse, type YoutubeCategoriesParams, type CategoriesResponse$1 as YoutubeCategoriesResponse, type Channel as YoutubeChannel, type ChannelAbout as YoutubeChannelAbout, type ChannelLink as YoutubeChannelLink, type YoutubeChannelParams, type YoutubeChannelSearchParams, type YoutubeChannelTabParams, type ChannelTabResponse as YoutubeChannelTabResponse, type ChannelVideosResponse as YoutubeChannelVideosResponse, ChannelsClient as YoutubeChannelsClient, type Chapter as YoutubeChapter, YoutubeClient, type Comment as YoutubeComment, type YoutubeCommentSort, type YoutubeCommentsParams, type CommentsResponse as YoutubeCommentsResponse, CommunityClient as YoutubeCommunityClient, type CommunityPost as YoutubeCommunityPost, type CommunityResponse as YoutubeCommunityResponse, type YoutubeDuration, type Format as YoutubeFormat, type YoutubeHashtagParams, type HashtagResponse as YoutubeHashtagResponse, type HeatMarker as YoutubeHeatMarker, type YoutubeHomeParams, type HomeResponse as YoutubeHomeResponse, type LanguagesResponse as YoutubeLanguagesResponse, type LiveChatMessage as YoutubeLiveChatMessage, type YoutubeLiveChatParams, type LiveChatResponse as YoutubeLiveChatResponse, type LiveStreamingDetails as YoutubeLiveStreamingDetails, type MarketInfo$2 as YoutubeMarketInfo, type MarketsResponse$3 as YoutubeMarketsResponse, MusicClient as YoutubeMusicClient, type YoutubeMusicSearchParams, type OEmbed as YoutubeOEmbed, type YoutubeOEmbedParams, type Playlist as YoutubePlaylist, type PlaylistItem as YoutubePlaylistItem, type YoutubePlaylistItemsParams, type PlaylistItemsResponse as YoutubePlaylistItemsResponse, type YoutubePlaylistParams, PlaylistsClient as YoutubePlaylistsClient, type PollChoice as YoutubePollChoice, type YoutubePostCommentsParams, type YoutubePostParams, ReferenceClient$3 as YoutubeReferenceClient, type ReferenceRow as YoutubeReferenceRow, type YoutubeRegionParams, type RegionRestriction as YoutubeRegionRestriction, type RegionsResponse$1 as YoutubeRegionsResponse, type YoutubeRelatedParams, type RelatedResponse as YoutubeRelatedResponse, type YoutubeRepliesParams, type RepliesResponse as YoutubeRepliesResponse, type YoutubeResolveParams, type ResolveResult as YoutubeResolveResult, type SearchChip as YoutubeSearchChip, SearchClient$3 as YoutubeSearchClient, type YoutubeSearchParams, type SearchResponse$3 as YoutubeSearchResponse, type SearchResult as YoutubeSearchResult, type YoutubeSearchSort, type YoutubeSearchType, type ShoppingResult as YoutubeShoppingResult, type Short as YoutubeShort, type YoutubeShortParams, type YoutubeShortsBySoundParams, ShortsClient as YoutubeShortsClient, type StreamingData as YoutubeStreamingData, type YoutubeStreamsClient, type YoutubeStreamsParams, type SubscriberCount as YoutubeSubscriberCount, type Thumbnail as YoutubeThumbnail, type Transcript as YoutubeTranscript, type YoutubeTranscriptParams, type TranscriptSegment as YoutubeTranscriptSegment, TrendingClient as YoutubeTrendingClient, type TrendingItem as YoutubeTrendingItem, type YoutubeTrendingParams, type TrendingResponse as YoutubeTrendingResponse, type YoutubeTrendingShortsParams, type YoutubeTrendingType, type YoutubeUploadDate, type Video as YoutubeVideo, type YoutubeVideoParams, VideosClient as YoutubeVideosClient, type Address as ZillowAddress, type Agent as ZillowAgent, type AgentAttribution as ZillowAgentAttribution, AgentClient as ZillowAgentClient, type AgentLicense as ZillowAgentLicense, type ZillowAgentOptions, type AgentResponse as ZillowAgentResponse, type AgentReview as ZillowAgentReview, type AutocompleteResponse as ZillowAutocompleteResponse, type AutocompleteResult as ZillowAutocompleteResult, ZillowClient, type HomeFacts as ZillowHomeFacts, type LatLong as ZillowLatLong, type Listing as ZillowListing, type ListingSubType as ZillowListingSubType, type MapBounds as ZillowMapBounds, type MarketInfo as ZillowMarketInfo, type MarketsResponse as ZillowMarketsResponse, type MortgageRate as ZillowMortgageRate, type MortgageRates as ZillowMortgageRates, type NearbyRegion as ZillowNearbyRegion, type OpenHouse as ZillowOpenHouse, type Pagination as ZillowPagination, type PastSale as ZillowPastSale, type Photo as ZillowPhoto, type PriceHistoryEvent as ZillowPriceHistoryEvent, PropertiesClient as ZillowPropertiesClient, type Property as ZillowProperty, type PropertyResponse as ZillowPropertyResponse, ReferenceClient as ZillowReferenceClient, type RegionSelection as ZillowRegionSelection, type School as ZillowSchool, SearchClient as ZillowSearchClient, type ZillowSearchOptions, type SearchResponse as ZillowSearchResponse, type ZillowSort, type ZillowStatus, type TaxHistoryEvent as ZillowTaxHistoryEvent, type ZestimateHistoryPoint as ZillowZestimateHistoryPoint };
|