Skip to main content
POST
/
search-public
/
properties
Search Swedish properties (POST)
curl --request POST \
  --url https://lens-api.tic.io/search-public/properties \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "collection": "<string>",
  "q": "<string>",
  "query_by": "<string>",
  "filter_by": "<string>",
  "sort_by": "<string>",
  "per_page": 123,
  "page": 123
}
'
{
  "results": [
    {
      "facet_counts": [
        {
          "counts": [
            {
              "count": 123,
              "highlighted": "<string>",
              "value": "<string>"
            }
          ],
          "field_name": "<string>",
          "sampled": true,
          "stats": {
            "total_values": 123
          },
          "localizedFieldName": "<string>"
        }
      ],
      "found": 123,
      "hits": [
        {
          "document": {
            "id": "<string>",
            "propertyId": 123,
            "propertyDesignation": "<string>",
            "propertySlug": "<string>",
            "propertyType": "fastighet",
            "statusType": "avregistrerad",
            "buildingNames": [
              "<string>"
            ],
            "centroidArea1": [
              123
            ],
            "municipalityCode": 123,
            "countyCode": 123,
            "landArea": 123,
            "waterArea": 123,
            "totalArea": 123,
            "streetAddress": "<string>",
            "postalCode": 123,
            "city": "<string>",
            "buildingTypes": [
              "<string>"
            ],
            "buildingPurposes": [
              "<string>"
            ],
            "numberOfAreas": 123,
            "areas": [
              {
                "areaId": 123,
                "surface": [
                  [
                    [
                      123
                    ]
                  ]
                ],
                "centroid": [
                  123
                ]
              }
            ],
            "lastOwnerRegistrationDate": 123,
            "owners": [
              {
                "companyId": 123,
                "personId": 123,
                "numerator": 123,
                "denominator": 123,
                "registrationDate": 123
              }
            ],
            "numberOfBuildings": 123,
            "numberOfAddresses": 123,
            "safetyShelterNumbers": [
              "<string>"
            ],
            "taxationCode": 123,
            "taxationValue": 123,
            "taxationYear": 123,
            "taxationProperties": [
              "<string>"
            ],
            "taxationValueParts": [
              {
                "part": "<string>",
                "amount": 123
              }
            ]
          },
          "geo_distance_meters": null,
          "highlight": null,
          "highlights": [
            {
              "field": "<string>",
              "matched_tokens": [
                "<string>"
              ],
              "snippet": "<string>"
            }
          ],
          "text_match": 123,
          "text_match_info": {
            "best_field_score": "<string>",
            "best_field_weight": 123,
            "fields_matched": 123,
            "num_tokens_dropped": 123,
            "score": "<string>",
            "tokens_matched": 123,
            "typo_prefix_score": 123
          }
        }
      ],
      "grouped_hits": {
        "group_key": [
          "<string>"
        ],
        "hits": [
          {
            "document": {
              "id": "<string>",
              "propertyId": 123,
              "propertyDesignation": "<string>",
              "propertySlug": "<string>",
              "propertyType": "fastighet",
              "statusType": "avregistrerad",
              "buildingNames": [
                "<string>"
              ],
              "centroidArea1": [
                123
              ],
              "municipalityCode": 123,
              "countyCode": 123,
              "landArea": 123,
              "waterArea": 123,
              "totalArea": 123,
              "streetAddress": "<string>",
              "postalCode": 123,
              "city": "<string>",
              "buildingTypes": [
                "<string>"
              ],
              "buildingPurposes": [
                "<string>"
              ],
              "numberOfAreas": 123,
              "areas": [
                {
                  "areaId": 123,
                  "surface": [
                    [
                      [
                        123
                      ]
                    ]
                  ],
                  "centroid": [
                    123
                  ]
                }
              ],
              "lastOwnerRegistrationDate": 123,
              "owners": [
                {
                  "companyId": 123,
                  "personId": 123,
                  "numerator": 123,
                  "denominator": 123,
                  "registrationDate": 123
                }
              ],
              "numberOfBuildings": 123,
              "numberOfAddresses": 123,
              "safetyShelterNumbers": [
                "<string>"
              ],
              "taxationCode": 123,
              "taxationValue": 123,
              "taxationYear": 123,
              "taxationProperties": [
                "<string>"
              ],
              "taxationValueParts": [
                {
                  "part": "<string>",
                  "amount": 123
                }
              ]
            },
            "geo_distance_meters": null,
            "highlight": null,
            "highlights": [
              {
                "field": "<string>",
                "matched_tokens": [
                  "<string>"
                ],
                "snippet": "<string>"
              }
            ],
            "text_match": 123,
            "text_match_info": {
              "best_field_score": "<string>",
              "best_field_weight": 123,
              "fields_matched": 123,
              "num_tokens_dropped": 123,
              "score": "<string>",
              "tokens_matched": 123,
              "typo_prefix_score": 123
            }
          }
        ]
      },
      "out_of": 123,
      "page": 123,
      "request_params": {
        "collection_name": "<string>",
        "first_q": "<string>",
        "per_page": 123,
        "q": "<string>"
      },
      "search_cutoff": true,
      "search_time_ms": 123
    }
  ]
}
Max+ tier

Authorizations

x-api-key
string
header
required

Body

collection
null | string
q
null | string
query_by
null | string
filter_by
null | string
sort_by
null | string
per_page
null | integer<int32>
page
null | integer<int32>

Response

Typesense multi-search response

results
null | object[]