scrapebadger 0.26.1 → 0.27.0

package/dist/index.js

@@ -4045,6 +4045,55 @@ var RedditClient = class {
   }
 };
 
+// src/apartments/client.ts
+var ApartmentsClient = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Search rental listings in a location.
+   *
+   * @param location - apartments.com slug (`"kansas-city-mo"`) or a ZIP.
+   * @param params - Optional page and bed/price filters.
+   *
+   * @remarks
+   * Cards are summaries with a rent/bed rollup. For per-unit rent and
+   * availability, pass a card's `url` to {@link getProperty}.
+   */
+  async search(location, params = {}) {
+    const query = {
+      location,
+      page: params.page ?? 1
+    };
+    if (params.beds !== void 0) query.beds = params.beds;
+    if (params.minPrice !== void 0) query.min_price = params.minPrice;
+    if (params.maxPrice !== void 0) query.max_price = params.maxPrice;
+    return this.client.request("/v1/apartments/search", { params: query });
+  }
+  /**
+   * Get one property with floor plans and per-unit inventory.
+   *
+   * @param url - Full property URL. Omit to look up by `slug` + `propertyId`.
+   * @param params - `slug` and `propertyId` alternative to a URL.
+   *
+   * @remarks
+   * Use `unit.rent` (the advertised price), not `unit.max_term_rent` — the
+   * latter is the site's raw `data-maxrent`, roughly double the advertised
+   * rent.
+   */
+  async getProperty(url, params = {}) {
+    if (url) {
+      return this.client.request("/v1/apartments/property", { params: { url } });
+    }
+    if (params.slug && params.propertyId) {
+      return this.client.request(
+        `/v1/apartments/properties/${params.slug}/${params.propertyId}`
+      );
+    }
+    throw new Error("Provide either url, or both slug and propertyId");
+  }
+};
+
 // src/redfin/client.ts
 var RedfinClient = class {
   client;
@@ -6983,6 +7032,8 @@ var ScrapeBadger = class {
   google;
   /** Reddit scraper API client */
   reddit;
+  /** Apartments.com scraper API client — search + property with unit-level pricing (US) */
+  apartments;
   /** Redfin scraper API client — search, property, agent, autocomplete, markets (redfin.com, US) */
   redfin;
   /** Amazon scraper API client — 14 endpoints */
@@ -7050,6 +7101,7 @@ var ScrapeBadger = class {
     this.vinted = new VintedClient(this.baseClient);
     this.google = new GoogleClient(this.baseClient);
     this.reddit = new RedditClient(this.baseClient);
+    this.apartments = new ApartmentsClient(this.baseClient);
     this.redfin = new RedfinClient(this.baseClient);
     this.amazon = new AmazonClient(this.baseClient);
     this.shopee = new ShopeeClient(this.baseClient);
@@ -7074,6 +7126,7 @@ exports.AmazonProductsClient = ProductsClient2;
 exports.AmazonReferenceClient = ReferenceClient2;
 exports.AmazonSearchClient = SearchClient4;
 exports.AmazonSellersClient = SellersClient;
+exports.ApartmentsClient = ApartmentsClient;
 exports.AuthenticationError = AuthenticationError;
 exports.ChatGPTAskClient = AskClient;
 exports.ChatGPTBrandClient = BrandClient;