Properties

Get property by ID (with mm_property_id fallback)

GET
/v1/properties/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

id*string

Property document ID

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/properties/string"
{
  "alternates": [
    "string"
  ],
  "ambiguousRef": true,
  "data": {
    "activeLoanCount": 0,
    "activeLoanCountKnown": true,
    "address": "string",
    "apn": "string",
    "avm": {
      "confidence": 0,
      "high": 0,
      "low": 0,
      "mid": 0
    },
    "baths": 0,
    "beds": 0,
    "borrowerStatus": "string",
    "city": "string",
    "coordinates": {
      "lat": 0,
      "lon": 0
    },
    "equity": {
      "pct": 0,
      "value": 0
    },
    "fips": "string",
    "foreclosure": {
      "matched": true,
      "scheduledAuctionDate": "string",
      "status": "string"
    },
    "id": "string",
    "loanCount": 0,
    "loanType": "string",
    "loans": [
      {
        "amount": 0,
        "borrowerStatus": "string",
        "brokerNmls": "string",
        "companyNmls": "string",
        "currentBalance": 0,
        "interestRate": 0,
        "lenderId": "string",
        "lenderName": "string",
        "lenderNmls": "string",
        "loanType": "string",
        "ltv": 0,
        "originatorName": "string",
        "originatorNmls": "string",
        "recordedInterestRate": 0,
        "recordingDate": "string",
        "transactionType": "string"
      }
    ],
    "lotSquareFeet": 0,
    "mmPropertyId": "string",
    "mortgageBalance": 0,
    "ownerFirstName": "string",
    "ownerLastName": "string",
    "ownerName": "string",
    "partialBaths": 0,
    "preSaleLoanCount": 0,
    "recordedInterestRate": 0,
    "saleCount": 0,
    "salePropensity": {
      "category": "string",
      "score": 0
    },
    "sales": {
      "count": 0,
      "firstDate": "string",
      "lastDate": "string",
      "lastPrice": 0
    },
    "scoredAt": "string",
    "squareFeet": 0,
    "state": "string",
    "stories": 0,
    "yearBuilt": 0,
    "zip": "string",
    "communityLending": {
      "affordableHousingTract": true,
      "difficultDevelopmentArea": true,
      "distressedTract": true,
      "floodHazardTract": true,
      "lowModIncomeTract": true,
      "majorityMinorityTract": true,
      "milesToCollege": 0,
      "milesToSchool": 0,
      "milesToWorship": 0,
      "opportunityZone": true,
      "ruralTract": true,
      "tractApplications": 0,
      "tractAsianPct": 0,
      "tractBlackPct": 0,
      "tractCountyCode": "string",
      "tractDenialRate": 0,
      "tractFamilyIncome": 0,
      "tractFloodZone": "string",
      "tractHispanicPct": 0,
      "tractHomeownershipRate": 0,
      "tractHouseholdIncome": 0,
      "tractId": "string",
      "tractIncomeLevel": "low",
      "tractIncomeVsMetroPct": 0,
      "tractLoanVolume": 0,
      "tractMedianAge": 0,
      "tractMedianHomeValue": 0,
      "tractMinorityPct": 0,
      "tractOriginations": 0,
      "tractPopulation": 0,
      "tractPovertyRate": 0,
      "tractRuralGradient": 0,
      "tractStateCode": "string",
      "tractWhiteNonHispanicPct": 0,
      "usdaEligibleTract": true
    },
    "enrichment": {
      "enrichedAt": "string",
      "persons": [
        {
          "death": {
            "deceased": true,
            "property1": null,
            "property2": null
          },
          "dnc": {
            "tcpa": true,
            "property1": null,
            "property2": null
          },
          "emails": [
            {
              "email": "string",
              "tested": true
            }
          ],
          "litigator": true,
          "mailingAddress": {
            "addressValidity": "string",
            "city": "string",
            "county": "string",
            "formattedStreet": "string",
            "hash": "string",
            "houseNumber": "string",
            "state": "string",
            "street": "string",
            "streetNoUnit": "string",
            "zip": "string",
            "zipPlus4": "string",
            "property1": null,
            "property2": null
          },
          "meta": {
            "error": "string",
            "matched": true,
            "property1": null,
            "property2": null
          },
          "name": {
            "first": "string",
            "full": "string",
            "last": "string",
            "middle": "string"
          },
          "phoneNumbers": [
            {
              "carrier": "string",
              "dnc": true,
              "lastReportedDate": "string",
              "number": "string",
              "reachable": true,
              "score": 0,
              "tested": true,
              "type": "string"
            }
          ],
          "propertyAddress": {
            "addressValidity": "string",
            "city": "string",
            "county": "string",
            "formattedStreet": "string",
            "hash": "string",
            "houseNumber": "string",
            "state": "string",
            "street": "string",
            "streetNoUnit": "string",
            "zip": "string",
            "zipPlus4": "string",
            "property1": null,
            "property2": null
          },
          "property1": null,
          "property2": null
        }
      ],
      "source": "string"
    },
    "foreclosureDetail": {
      "beneficiaryLender": "string",
      "count": 0,
      "latestCode": "string",
      "latestDate": "string",
      "trusteeSaleNumber": "string",
      "unpaidBalance": 0
    },
    "ownerMailingAddress": {
      "city": "string",
      "state": "string",
      "street": "string",
      "zip": "string"
    },
    "owners": [
      {
        "firstName": "string",
        "fullName": "string",
        "lastName": "string",
        "middleName": "string"
      }
    ],
    "parties": {
      "active": {
        "brokers": [
          "string"
        ],
        "companies": [
          "string"
        ],
        "lenders": [
          "string"
        ],
        "originators": [
          "string"
        ]
      },
      "alltime": {
        "brokers": [
          "string"
        ],
        "companies": [
          "string"
        ],
        "lenders": [
          "string"
        ],
        "originators": [
          "string"
        ]
      },
      "last": {
        "originators": [
          "string"
        ]
      },
      "matched": {
        "brokers": [
          "string"
        ],
        "companies": [
          "string"
        ],
        "lenders": [
          "string"
        ],
        "originators": [
          "string"
        ]
      }
    },
    "position": {
      "activeOverFive": true,
      "loanCountActive": 0,
      "loanCountAll": 0,
      "loanCountPaidOff": 0,
      "loanCountPreSale": 0,
      "loanCountReleased": 0,
      "sumOutstanding": 0
    },
    "relationships": {
      "agents": [
        "string"
      ],
      "brokers": [
        "string"
      ],
      "companies": [
        "string"
      ],
      "lenders": [
        "string"
      ],
      "originators": [
        "string"
      ]
    }
  }
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}