GET
/
search
/
properties
/
se
curl --request GET \
  --url https://api.tic.io/search/properties/se \
  --header 'x-api-key: <api-key>'
{
  "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>",
        "propertyDesignation": "<string>",
        "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,
        "numberOfBuildings": 123,
        "numberOfAddresses": 123,
        "safetyShelterNumbers": [
          "<string>"
        ],
        "taxationCode": 123,
        "taxationValue": 123,
        "taxationYear": 123
      },
      "geo_distance_meters": "<any>",
      "highlight": "<any>",
      "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>",
          "propertyDesignation": "<string>",
          "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,
          "numberOfBuildings": 123,
          "numberOfAddresses": 123,
          "safetyShelterNumbers": [
            "<string>"
          ],
          "taxationCode": 123,
          "taxationValue": 123,
          "taxationYear": 123
        },
        "geo_distance_meters": "<any>",
        "highlight": "<any>",
        "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
}

Check our extensive examples and description here.

You can add &view=html to your querystring and we will render an html page with explanations.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
q
string
required

The query string use * for all

Minimum length: 1
​
query_by
string
required

Query by field, for supported fields see documentation

​
filter_by
string

Filter by, for supported fields see documentation

​
sort_by
string

Sort by, for supported fields see documentation

​
view
string

Set to html if you want to render the search result to webpage

Response

200 - application/json

The search response

The response is of type object.