Market

Search aggregated market data with filters

POST
/v1/market

Search aggregated loan origination market data. Filterable dimensions cover geography (state, county, zip), product (loan purpose / type / amortization), borrower demographics, and loan numerics.

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/market" \  -H "Content-Type: application/json" \  -d '{}'
{
  "cursor": "string",
  "data": [
    {
      "amortizationType": "string",
      "appraisedValue": 0,
      "borrowerGeneration": "string",
      "channel": "string",
      "closingDate": "string",
      "combinedLtv": 0,
      "county": "string",
      "creditScore": 0,
      "currentHomeOwner": true,
      "dti": 0,
      "dtifront": 0,
      "firstTimeHomebuyer": true,
      "fundingDate": "string",
      "hmdaActionTaken": "string",
      "id": "string",
      "income": 0,
      "loanAmount": 0,
      "loanApplicationDate": "string",
      "loanPurpose": "string",
      "loanTerm": 0,
      "loanType": "string",
      "ltv": 0,
      "noteRate": 0,
      "occupancyType": "string",
      "propertyType": "string",
      "purchasePrice": 0,
      "selfEmployed": true,
      "state": "string",
      "veteranIndicator": true,
      "zip": "string"
    }
  ],
  "locationNormalizations": [
    {
      "candidates": [
        "string"
      ],
      "confidence": "normalized",
      "displayName": "Saint Louis, MO",
      "field": "city",
      "id": "city_mo_saint-louis",
      "normalized": "Saint Louis",
      "original": "St. Louis",
      "variants": [
        "string"
      ]
    }
  ],
  "total": 0
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Autocomplete location search GET

Autocomplete location search. Cities and counties come from Model Match's own location dictionary and carry an `id` (e.g. `city_mo_saint-louis`) that city / county filters accept — including for places our data spells differently than a mapping provider does. Street addresses come from Mapbox. Use the `mapbox_id` from any suggestion with `retrieveLocation` to get normalized geographic details and coordinates.

Market measure by dimension breakdown POST

Next Page