---

This SDK provides convenient access to the Price Engine REST API from TypeScript or JavaScript.

Stable v1

Documentation

📲 Installation

npm install pe-sdk

yarn add pe-sdk

pnpm i pe-sdk

Usage

Importing the SDK

To use the SDK, import the Appraisal and Metric classes from the SDK:

import{Appraisal,Metric}from'pe-sdk'

Configuration

import{Appraisal,Metric}from'pe-sdk'constclientOptions={apiKey: 'your_api_key',// Or via env variable PRICE_ENGINE_API_KEYbaseURL: 'https://api.dd360.mx',// Or via env variable PRICE_ENGINE_BASE_URLversion: 'v9',timeout: 5000,maxRetries: 2}constappraisalClient=newAppraisal(clientOptions)constmetricClient=newMetric(clientOptions)

Appraisal API

Getting Appraisal Coverage

Input:

import{CommonRequestInput}from'pe-sdk'constrequest: CommonRequestInput={latitude: 19.4326,longitude: -99.1332}

Usage:

constappraisal=newAppraisal()constcoverage: AppraisalOutputCoverage=awaitappraisal.getAppraisalCoverage(request)

Output:

{hasCoverage: true,cvegeo: "090010001"}

Getting Appraisal

Input:

import{AppraisalRequestInput}from'pe-sdk'constrequest: AppraisalRequestInput={latitude: 19.4326,longitude: -99.1332,lotSurface: 200,constructionArea: 150}

Usage:

constappraisal=newAppraisal()constappraisalResult: AppraisalRequestOutput=awaitappraisal.getAppraisal(request)

Output:

{value: 5000000,valuePerSqm: 25000,upperValueRangePerSqm: 27000,lowerValueRangePerSqm: 23000,upperValueRange: 5400000,lowerValueRange: 4600000,comparables: [{id: "123",urlAd: "http://example.com",surfaceTotal: 200,terrainSurface: 150,builtYear: 2015,numBedrooms: 3,numBathrooms: 2,numParkingLots: 1,isNewPropertyProb: 0.8,pricePerSquareMeter: 26000,dissimilarityToTarget: 0.1}]}

Getting Appraisal for Apartment Rent

Input:

import{AppraisalRequestInputVariable}from'pe-sdk'constrequest: AppraisalRequestInputVariable={latitude: 19.4326,longitude: -99.1332,lotSurface: 200,constructionArea: 150}

Usage:

constappraisal=newAppraisal()constrentResult: AppraisalRequestOutput=awaitappraisal.getAppraisalApartmentRent(request)

Output:

{value: 20000,valuePerSqm: 100,upperValueRangePerSqm: 110,lowerValueRangePerSqm: 90,upperValueRange: 22000,lowerValueRange: 18000,comparables: [{id: "124",urlAd: "http://example.com",surfaceTotal: 200,terrainSurface: 150,builtYear: 2018,numBedrooms: 2,numBathrooms: 1,numParkingLots: 1,isNewPropertyProb: 0.9,pricePerSquareMeter: 105,dissimilarityToTarget: 0.05}]}

Getting Appraisal for Apartment Sale

Input:

import{AppraisalRequestInputVariable}from'pe-sdk'constrequest: AppraisalRequestInputVariable={latitude: 19.4326,longitude: -99.1332,lotSurface: 200,constructionArea: 150}

Usage:

constappraisal=newAppraisal()constsaleResult: AppraisalRequestOutput=awaitappraisal.getAppraisalApartmentSale(request)

Output:

{value: 3000000,valuePerSqm: 15000,upperValueRangePerSqm: 16000,lowerValueRangePerSqm: 14000,upperValueRange: 3200000,lowerValueRange: 2800000,comparables: [{id: "125",urlAd: "http://example.com",surfaceTotal: 200,terrainSurface: 150,builtYear: 2020,numBedrooms: 2,numBathrooms: 1,numParkingLots: 1,isNewPropertyProb: 0.95,pricePerSquareMeter: 15500,dissimilarityToTarget: 0.02}]}

Getting Appraisal for House Rent

Input:

import{AppraisalRequestInputVariable}from'pe-sdk'constrequest: AppraisalRequestInputVariable={latitude: 19.4326,longitude: -99.1332,lotSurface: 200,constructionArea: 150}

Usage:

constappraisal=newAppraisal()consthouseRentResult: AppraisalRequestOutput=awaitappraisal.getAppraisalHouseRent(request)

Output:

{value: 25000,valuePerSqm: 125,upperValueRangePerSqm: 135,lowerValueRangePerSqm: 115,upperValueRange: 27000,lowerValueRange: 23000,comparables: [{id: "126",urlAd: "http://example.com",surfaceTotal: 200,terrainSurface: 150,builtYear: 2017,numBedrooms: 3,numBathrooms: 2,numParkingLots: 1,isNewPropertyProb: 0.85,pricePerSquareMeter: 130,dissimilarityToTarget: 0.04}]}

Getting Appraisal for House Sale

Input:

import{AppraisalRequestInputVariable}from'pe-sdk'constrequest: AppraisalRequestInputVariable={latitude: 19.4326,longitude: -99.1332,lotSurface: 200,constructionArea: 150}

Usage:

constappraisal=newAppraisal()consthouseSaleResult: AppraisalRequestOutput=awaitappraisal.getAppraisalHouseSale(request)

Output:

{value: 3500000,valuePerSqm: 17500,upperValueRangePerSqm: 18500,lowerValueRangePerSqm: 16500,upperValueRange: 3700000,lowerValueRange: 3300000,comparables: [{id: "127",urlAd: "http://example.com",surfaceTotal: 200,terrainSurface: 150,builtYear: 2016,numBedrooms: 3,numBathrooms: 2,numParkingLots: 1,isNewPropertyProb: 0.8,pricePerSquareMeter: 18000,dissimilarityToTarget: 0.03}]}

Getting Appraisal Report

Input:

import{AppraisalReportRequestInput}from'pe-sdk'constrequest: AppraisalReportRequestInput={latitude: 19.4326,longitude: -99.1332,lotSurface: 200,constructionArea: 150}

Usage:

constappraisal=newAppraisal()constreport: AppraisalReportRequestOutput=awaitappraisal.getAppraisalReport(request)

Output:

{appraisalRent: {value: 25000,valuePerSqm: 125,upperValueRangePerSqm: 135,lowerValueRangePerSqm: 115,upperValueRange: 27000,lowerValueRange: 23000,comparables: [{id: "126",urlAd: "http://example.com",surfaceTotal: 200,terrainSurface: 150,builtYear: 2017,numBedrooms: 3,numBathrooms: 2,numParkingLots: 1,isNewPropertyProb: 0.85,pricePerSquareMeter: 130,dissimilarityToTarget: 0.04}]},appraisalSale: {value: 3500000,valuePerSqm: 17500,upperValueRangePerSqm: 18500,lowerValueRangePerSqm: 16500,upperValueRange: 3700000,lowerValueRange: 3300000,comparables: [{id: "127",urlAd: "http://example.com",surfaceTotal: 200,terrainSurface: 150,builtYear: 2016,numBedrooms: 3,numBathrooms: 2,numParkingLots: 1,isNewPropertyProb: 0.8,pricePerSquareMeter: 18000,dissimilarityToTarget: 0.03}]},property: {latitude: 19.4326,longitude: -99.1332,lotSurface: 200,constructionArea: 150},capitalGain: {currentCapGain: 0.059994292088481505,capGainTimeSeries: {"2019-04": 0.766111483639908,,"2019-05": 0.7732951742516028,"2019-06": 0.776088687570223},currentPrice: 3500000,m2PricePerQuarter: {"2019 T2": 44676.65447976637,"2019-T3": 45095.57949290333,"2019-T4": 45258.4863700169,}}}

Metric API

Getting Traffic Metrics

Input:

import{CommonRequestInput}from'pe-sdk'constrequest: CommonRequestInput={latitude: 19.4326,longitude: -99.1332}

Usage:

constmetric=newMetric()consttrafficData: TrafficResponse=awaitmetric.getTraffic(request)

Output:

{traffic: TrafficLevel,score: 75,trafficIndex: [{label: "9:00",score: 0.5704178149565791,level: TrafficLevel},{label: "13:30",score: 0.5704178149565791,level: TrafficLevel}]}typeTrafficLevel="very_high"|"high"|"moderate"|"low"

Getting Capital Gain Metrics

Input:

import{CommonRequestInput}from'pe-sdk'constrequest: CommonRequestInput={latitude: 19.4326,longitude: -99.1332}

Usage:

constmetric=newMetric()constcapitalGainData: CapitalGainResponse=awaitmetric.getCapitalGain(request)

Output:

{currentCapGain: 0.059994292088481505,capGainTimeSeries: {"2019-04": 0.059994292088481505,"2019-05": 0.059994292088481505,"2019-06": 0.059994292088481505},m2PricePerQuarter: {"2019-04": 0.059994292088481505,"2019-05": 0.059994292088481505,"2019-06": 0.059994292088481505}}

Getting Cost of Living Metrics

Input:

import{CommonRequestInput}from'pe-sdk'constrequest: CommonRequestInput={latitude: 19.4326,longitude: -99.1332}

Usage:

constmetric=newMetric()constcostOfLivingData: CostOfLivingResponse=awaitmetric.getCostOfLiving(request)

Output:

{costOfLiving: CostLevel,score: 77}typeCostLevel="very_high"|"high"|"moderate"|"low"

Getting Walkability Metrics

Input:

import{CommonRequestInput}from'pe-sdk'constrequest: CommonRequestInput={latitude: 19.4326,longitude: -99.1332}

Usage:

constmetric=newMetric()constwalkabilityData: WalkabilityResponse=awaitmetric.getWalkability(request)

Output:

{walkability: WalkabilityLevel,score: 85}typeWalkabilityLevel="walkers_paradise"|"walkable"|"somewhat_walkable"|"car_dependent"

Getting Current Price Metrics

Input:

import{CommonRequestInput}from'pe-sdk'constrequest: CommonRequestInput={latitude: 19.4326,longitude: -99.1332}

Usage:

constmetric=newMetric()constcurrentPriceData: CurrentPriceResponse=awaitmetric.getCurrentPrice(request)

Output:

{currentPrice: 3500000}

Getting Proximity to Work Metrics

Input:

import{CommonRequestInput}from'pe-sdk'constrequest: CommonRequestInput={latitude: 19.4326,longitude: -99.1332}

Usage:

constmetric=newMetric()constproximityToWorkData: ProximityToWorkResponse=awaitmetric.getProximityToWork(request)

Output:

{proximityToWork: ProximityLevel,score: 90}typeProximityLevel="high"|"low"|"medium"

Types

The SDK uses the following types for request and response objects:

Appraisal Types

• AppraisalReportRequestInput
• AppraisalReportRequestOutput
• AppraisalRequestInput
• AppraisalRequestInputVariable
• AppraisalRequestOutput
• AppraisalOutputCoverage
• CommonRequestInput

Metric Types

• CapitalGainResponse
• CostOfLivingResponse
• CurrentPriceResponse
• ProximityToWorkResponse
• TrafficResponse
• WalkabilityResponse
• CommonRequestInput

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.