Count properties matching filters

Return the exact number of properties matching the given filters. Accepts the same request body as listProperties (pagination and sort are ignored). Use this when you only need a total; to get the matching properties themselves, send the same request body to listProperties.

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

advancedFilters?|||

filters?|||

flatFilters?

pagination?

sort?array<>

Response Body

`application/json`

curl -X POST "https://example.com/v1/properties/count" \  -H "Content-Type: application/json" \  -d '{}'

{
  "lenderNormalizations": [
    {
      "aliasCount": 0,
      "displayName": "string",
      "id": "string",
      "matchedVia": "id",
      "original": "string",
      "totalDocuments": 0
    }
  ],
  "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": 48213
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string",
  "limit": 0,
  "size": 0
}

Count properties matching filters

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

413application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`