@tapline/client 0.2.13 → 0.2.15

package/dist/cjs/services/zillow/client.js

@@ -7,26 +7,31 @@ class ZillowClient {
     constructor(base) {
         this.base = base;
     }
-    /** Zillow's search-box suggestions for a partial address or place. Region results carry `regionId` and `regionType` (`state`, `county`, `city`, `zipcode`, `neighborhood`, `borough`); address results carry the home's `zpid`, which the property routes take. Zillow returns at most 12 suggestions. No match answers an empty `items` list, which is charged. Costs 1 credit. */
+    /** Returns location suggestions for a partial address or place. Region results include `regionId` and `regionType`; address results include the property's `zpid`. Costs 1 credit. */
     async searchLocations(params) {
         return this.base.get('/v1/zillow/locations', { ...params });
     }
-    /** One home on Zillow by zpid, as Zillow's own `property` object. How much it carries depends on the home's status (`FOR_SALE`, `FOR_RENT`, `RECENTLY_SOLD`, `OTHER` for off market): rentals carry about 180 `resoFacts` (facts and features), `priceHistory` with events and sources, `nearbyHomes` and rental fees; for-sale, sold and off-market homes carry about 20 `resoFacts`, and only some for-sale homes carry `priceHistory`, as date and price pairs. Every status carries the address, Zestimate and Rent Zestimate, beds, baths, living area, lot, year built, photos, listing attribution and MLS, and coordinates. `price` is the list price for sale, the monthly rent for rentals, the last sale price when sold, and the Zestimate off market. Tax history is not on this route; the `history` route gives yearly tax paid and assessed value. `zpid` is an integer here. An unknown zpid answers 404, which is charged. Costs 3 credits. */
+    /** Returns one property by `zpid`, including its status, price, home and rent estimates, facts, features, photos, location, listing attribution, available price history, and property insight phrases. Costs 2 credits. */
     async getProperty(params) {
         const { zpid } = params;
         return this.base.get(`/v1/zillow/properties/${encodeURIComponent(zpid)}`);
     }
-    /** The comparable homes Zillow uses for a home's Zestimate, usually 5: integer zpid, address, price, beds, baths, living area, lot, status, coordinates, a photo and the listing attribution. `lotSize` is square feet; `lotAreaValue` is in `lotAreaUnits`, which Zillow spells `Acres`, `Square Feet` or `sqft`. Zillow sends no sale date or distance for comparables. An empty `items` list means Zillow lists no comparables, which is charged. An unknown zpid answers 404, or for some ids an empty `items` list. Costs 1 credit. */
+    /** Returns comparable homes used for a property's value estimate, including price, beds, baths, area, lot, status, location, photo, and listing attribution. Costs 1 credit. */
     async listComparables(params) {
         const { zpid } = params;
         return this.base.get(`/v1/zillow/properties/${encodeURIComponent(zpid)}/comparables`);
     }
-    /** A home's value and tax history as Zillow charts it: monthly Zestimate or Rent Zestimate, monthly year-over-year Zestimate change, yearly property tax paid, or yearly assessed value split into `Land` and `Structure` series. Each series is a list of points with `x` (epoch milliseconds) and `y` (USD, or a fraction for `zestimate_change`). Yearly tax points carry 1 January (UTC) of the tax year as `x` and amounts rounded to cents. `series` is empty when Zillow has no data for the metric, which is charged. An unknown zpid answers 404, or for some ids an empty `series`. Costs 1 credit. */
+    /** Returns a property's home estimate, rent estimate, value change, property tax, or assessed-value history as timestamped series. Select the series with `metric`. Costs 1 credit. */
     async getPropertyHistory(params) {
         const { zpid, ...query } = params;
         return this.base.get(`/v1/zillow/properties/${encodeURIComponent(zpid)}/history`, query);
     }
-    /** Searches Zillow homes for sale, for rent or recently sold in a state, county, city, ZIP code, neighborhood or borough, with Zillow's price, size, age, HOA, home-type and keyword filters. Name the area with `location` (free text, Zillow's first match), or with `region_id` and `region_type` from `/v1/zillow/locations` to search exactly that region. Each item is Zillow's own search card: `zpid` (a string here), address, `price` as display text with `unformattedPrice` as a number (sold cards carry `soldPrice` text instead), beds, baths (every bathroom counts as one, half baths included), area, `latLong`, status, photos, broker and `hdpData.homeInfo` with the Zestimate, Rent Zestimate, tax assessed value and days on Zillow. Rental results can be whole buildings (`isBuilding`, with `units`, no `hdpData`); a building's `zpid` is a coordinate key such as `30.43495--97.67558`, which the property routes do not take. 41 homes per page, at most 20 pages; `total_results` counts every match. A search with no matches answers an empty page, which is charged; a cursor past the last page answers 400 `invalid_cursor`, not charged. Priced per page, not per home. Costs 3 credits. */
+    /** Returns a property's price and tax history, last sale, schools, nearby homes, and listing, buyer and co-agent attribution. Costs 1 credit. */
+    async getPropertyRecords(params) {
+        const { zpid } = params;
+        return this.base.get(`/v1/zillow/properties/${encodeURIComponent(zpid)}/records`);
+    }
+    /** Searches homes for sale, rent, or recently sold by place or region ID. Returns up to 41 homes per page with price, property details, location, photos, broker, valuation data, region bounds, and available MLS or IDX disclosures. Costs 3 credits. */
     async searchHomes(params) {
         return this.base.get('/v1/zillow/search', { ...params });
     }

package/dist/cjs/services/zillow/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/zillow/client.ts"],"names":[],"mappings":";AAAA,oEAAoE;;;AAKpE,MAAa,YAAY;IACM;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD,oXAAoX;IACpX,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAkB,sBAAsB,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,i6BAAi6B;IACj6B,KAAK,CAAC,WAAW,CAAC,MAAyB;QACzC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAiB,yBAAyB,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED,4gBAA4gB;IAC5gB,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAoB,yBAAyB,kBAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3G,CAAC;IAED,ilBAAilB;IACjlB,KAAK,CAAC,kBAAkB,CAAC,MAAgC;QACvD,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAwB,yBAAyB,kBAAkB,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAClH,CAAC;IAED,gqCAAgqC;IAChqC,KAAK,CAAC,WAAW,CAAC,MAAyB;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAmB,mBAAmB,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AA9BD,oCA8BC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/zillow/client.ts"],"names":[],"mappings":";AAAA,oEAAoE;;;AAKpE,MAAa,YAAY;IACM;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD,sLAAsL;IACtL,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAkB,sBAAsB,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,4NAA4N;IAC5N,KAAK,CAAC,WAAW,CAAC,MAAyB;QACzC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAiB,yBAAyB,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED,gLAAgL;IAChL,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAoB,yBAAyB,kBAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3G,CAAC;IAED,uLAAuL;IACvL,KAAK,CAAC,kBAAkB,CAAC,MAAgC;QACvD,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAwB,yBAAyB,kBAAkB,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAClH,CAAC;IAED,iJAAiJ;IACjJ,KAAK,CAAC,kBAAkB,CAAC,MAAgC;QACvD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAwB,yBAAyB,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC3G,CAAC;IAED,2PAA2P;IAC3P,KAAK,CAAC,WAAW,CAAC,MAAyB;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAmB,mBAAmB,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AApCD,oCAoCC"}