Search Swedish properties (GET)

Max+ tier

GEThttps://lens-api.tic.io/search-public/properties

Authorization

x-api-keystringheaderrequired

Your API key, sent in the x-api-key header.

Responses

Typesense search response · application/json

facet_countsTypesenseFacetCounts[] | null

Hide child attributes

countsTypesenseFacetCountDetails[] | null

Show child attributes

countinteger

format: int64

highlightedstring | null

valuestring | null

field_namestring | null

sampledboolean

statsTypesenseFacetCountsStats

Show child attributes

total_valuesinteger

format: int64

localizedFieldNamestring | nullread-only

foundinteger

format: int32

hitsTypesenseLantmaterietFastighetDocumentHit[] | null

Hide child attributes

documentTypesenseLantmaterietFastighetDocument

Show child attributes

idstring | null

propertyIdinteger | null

format: int32

propertyDesignationstring | null

propertySlugstring | null

propertyTypestring

One of: fastighet samfallighet

statusTypestring

One of: avregistrerad levande

buildingNamesstring[] | null

centroidArea1number[] | null

municipalityCodeinteger | null

format: int32

countyCodeinteger | null

format: int32

landAreanumber | null

format: double

waterAreanumber | null

format: double

totalAreanumber | null

format: double

streetAddressstring | null

postalCodeinteger | null

format: int32

citystring | null

buildingTypesstring[] | null

buildingPurposesstring[] | null

numberOfAreasinteger | null

format: int32

areasTypesenseLantmaterietOmrade[] | null

Show child attributes

areaIdinteger | null

format: int32

surfacenumber[][][] | null

centroidnumber[] | null

lastOwnerRegistrationDateinteger | null

format: int64

ownersTypesenseLantmaterietOwner[] | null

Show child attributes

companyIdinteger | null

format: int32

personIdinteger | null

format: int32

numeratorinteger | null

format: int64

denominatorinteger | null

format: int64

registrationDateinteger | null

format: int64

numberOfBuildingsinteger | null

format: int32

numberOfAddressesinteger | null

format: int32

safetyShelterNumbersstring[] | null

taxationCodeinteger | null

format: int32

taxationValueinteger | null

format: int64

taxationYearinteger | null

format: int32

taxationPropertiesstring[] | null

taxationValuePartsTypesenseTaxeringDelvarde[] | null

Show child attributes

partstring | null

amountinteger | null

format: int64

geo_distance_metersany

highlightany

highlightsHighlightElement[] | null

Show child attributes

fieldstring | null

matched_tokensstring[] | null

snippetstring | null

text_matchnumber | null

format: double

text_match_infoTextMatchInfo

Show child attributes

best_field_scorestring | null

best_field_weightinteger | null

format: int64

fields_matchedinteger | null

format: int64

num_tokens_droppedinteger | null

format: int64

scorestring | null

tokens_matchedinteger | null

format: int64

typo_prefix_scoreinteger | null

format: int64

grouped_hitsTypesenseLantmaterietFastighetDocumentGroupedHits

Hide child attributes

group_keystring[] | null

hitsTypesenseLantmaterietFastighetDocumentHit[] | null

Show child attributes

documentTypesenseLantmaterietFastighetDocument

Show child attributes

idstring | null

propertyIdinteger | null

format: int32

propertyDesignationstring | null

propertySlugstring | null

propertyTypestring

One of: fastighet samfallighet

statusTypestring

One of: avregistrerad levande

buildingNamesstring[] | null

centroidArea1number[] | null

municipalityCodeinteger | null

format: int32

countyCodeinteger | null

format: int32

landAreanumber | null

format: double

waterAreanumber | null

format: double

totalAreanumber | null

format: double

streetAddressstring | null

postalCodeinteger | null

format: int32

citystring | null

buildingTypesstring[] | null

buildingPurposesstring[] | null

numberOfAreasinteger | null

format: int32

areasTypesenseLantmaterietOmrade[] | null

Show child attributes

areaIdinteger | null

format: int32

surfacenumber[][][] | null

centroidnumber[] | null

lastOwnerRegistrationDateinteger | null

format: int64

ownersTypesenseLantmaterietOwner[] | null

Show child attributes

companyIdinteger | null

format: int32

personIdinteger | null

format: int32

numeratorinteger | null

format: int64

denominatorinteger | null

format: int64

registrationDateinteger | null

format: int64

numberOfBuildingsinteger | null

format: int32

numberOfAddressesinteger | null

format: int32

safetyShelterNumbersstring[] | null

taxationCodeinteger | null

format: int32

taxationValueinteger | null

format: int64

taxationYearinteger | null

format: int32

taxationPropertiesstring[] | null

taxationValuePartsTypesenseTaxeringDelvarde[] | null

Show child attributes

partstring | null

amountinteger | null

format: int64

geo_distance_metersany

highlightany

highlightsHighlightElement[] | null

Show child attributes

fieldstring | null

matched_tokensstring[] | null

snippetstring | null

text_matchnumber | null

format: double

text_match_infoTextMatchInfo

Show child attributes

best_field_scorestring | null

best_field_weightinteger | null

format: int64

fields_matchedinteger | null

format: int64

num_tokens_droppedinteger | null

format: int64

scorestring | null

tokens_matchedinteger | null

format: int64

typo_prefix_scoreinteger | null

format: int64

out_ofinteger

format: int32

pageinteger

format: int32

request_paramsRequestParams

Hide child attributes

collection_namestring | null

first_qstring | null

per_pageinteger | null

format: int64

qstring | null

search_cutoffboolean | null

search_time_msinteger

format: int32

Query builder

Compose query_by, filter_by and sort_by from the collection's fields and run the search through the proxy.

Authorization

Stored in this browser only (until you forget it) and sent as the x-api-key header through the documentation proxy.

q query text, * for all

query_by fields searched

filter_by

sort_by

per_page

page

include_fields comma separated

exclude_fields

Request

curl "https://lens-api.tic.io/search-public/properties?q=*&query_by=id&per_page=10&page=1" \
  -H "x-api-key: YOUR_API_KEY"

Enter your API key to run.

{ "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.45 ], "municipalityCode": 123, "countyCode": 123, "landArea": 123.45, "waterArea": 123.45, "totalArea": 123.45, "streetAddress": "<string>", "postalCode": 123, "city": "<string>", "buildingTypes": [ "<string>" ], "buildingPurposes": [ "<string>" ], "numberOfAreas": 123, "areas": [ {} ], "lastOwnerRegistrationDate": 123, "owners": [ {} ], "numberOfBuildings": 123, "numberOfAddresses": 123, "safetyShelterNumbers": [ "<string>" ], "taxationCode": 123, "taxationValue": 123, "taxationYear": 123, "taxationProperties": [ "<string>" ], "taxationValueParts": [ {} ] }, "geo_distance_meters": null, "highlight": null, "highlights": [ { "field": "<string>", "matched_tokens": [ "<string>" ], "snippet": "<string>" } ], "text_match": 123.45, "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": {}, "geo_distance_meters": null, "highlight": null, "highlights": [ {} ], "text_match": 123.45, "text_match_info": {} } ] }, "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 }