Skip to main content
POST
/
search-public
/
vehicles
Search vehicles (POST)
curl --request POST \
  --url https://lens-api.tic.io/search-public/vehicles \
  --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
}
'
import requests

url = "https://lens-api.tic.io/search-public/vehicles"

payload = {
    "collection": "<string>",
    "q": "<string>",
    "query_by": "<string>",
    "filter_by": "<string>",
    "sort_by": "<string>",
    "per_page": 123,
    "page": 123
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    collection: '<string>',
    q: '<string>',
    query_by: '<string>',
    filter_by: '<string>',
    sort_by: '<string>',
    per_page: 123,
    page: 123
  })
};

fetch('https://lens-api.tic.io/search-public/vehicles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://lens-api.tic.io/search-public/vehicles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'collection' => '<string>',
    'q' => '<string>',
    'query_by' => '<string>',
    'filter_by' => '<string>',
    'sort_by' => '<string>',
    'per_page' => 123,
    'page' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://lens-api.tic.io/search-public/vehicles"

	payload := strings.NewReader("{\n  \"collection\": \"<string>\",\n  \"q\": \"<string>\",\n  \"query_by\": \"<string>\",\n  \"filter_by\": \"<string>\",\n  \"sort_by\": \"<string>\",\n  \"per_page\": 123,\n  \"page\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://lens-api.tic.io/search-public/vehicles")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"collection\": \"<string>\",\n  \"q\": \"<string>\",\n  \"query_by\": \"<string>\",\n  \"filter_by\": \"<string>\",\n  \"sort_by\": \"<string>\",\n  \"per_page\": 123,\n  \"page\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://lens-api.tic.io/search-public/vehicles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"collection\": \"<string>\",\n  \"q\": \"<string>\",\n  \"query_by\": \"<string>\",\n  \"filter_by\": \"<string>\",\n  \"sort_by\": \"<string>\",\n  \"per_page\": 123,\n  \"page\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "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>",
            "currentOwnerCompanyId": "<string>",
            "currentUserCompanyId": "<string>",
            "lastMileageDate": 123,
            "mileageKm": 123,
            "wanted": true,
            "fabric": [
              "<string>"
            ],
            "fuelCombination": "<string>",
            "colorHex": "<string>",
            "color": "<string>",
            "name": "<string>",
            "licencePlate": "<string>",
            "deregistered": 123,
            "deregisteredText": "<string>",
            "deregisteredCause": "<string>",
            "vehicleType": "<string>",
            "vehicleCategoryEU": "<string>",
            "vehicleName": "<string>",
            "tradeName": "<string>",
            "modelYear": 123,
            "vehicleYear": 123,
            "vin": "<string>",
            "fabricCode": "<string>",
            "modelNumber": "<string>",
            "groupNumber": "<string>",
            "manufacturingYearAndMonth": 123,
            "manufactured": 123,
            "reusedLicencePlate": true,
            "registered": 123,
            "vehicleClass": "<string>",
            "doodlebug": true,
            "manufacturer": "<string>",
            "manfacturerBasicVehicle": "<string>",
            "acquiredDate": 123,
            "address": "<string>",
            "postalCode": "<string>",
            "city": "<string>",
            "municipalityCode": "<string>",
            "numberOfOwners": 123,
            "acquiredByOwner": 123,
            "registrationType": "<string>",
            "status": "<string>",
            "statusDate": 123,
            "statusCause": "<string>",
            "onLease": true,
            "areaOfUse1": "<string>",
            "areaOfUse2": "<string>",
            "areaOfUse3": "<string>",
            "areaOfUse4": "<string>",
            "areaOfUse5": "<string>",
            "insuranceType": "<string>",
            "insuranceCompany": "<string>",
            "onCredit": true,
            "importer": "<string>",
            "originCode": "<string>",
            "originCause": "<string>",
            "preregistered": 123,
            "earlierRegistration": 123,
            "directImport": true,
            "variety": "<string>",
            "version": "<string>",
            "type": "<string>",
            "bodyworkCode1": "<string>",
            "bodyworkCode2": "<string>",
            "bodyworkCodeAddition": "<string>",
            "busClass": "<string>",
            "numberOfPassengers": 123,
            "numberOfSeats": 123,
            "eeg": "<string>",
            "cylinderVolume": 123,
            "gearbox": "<string>",
            "coupling1": "<string>",
            "coupling2": "<string>",
            "curbWeight": 123,
            "weightInDrivingCondition": 123,
            "totalWeight": 123,
            "fuelCode1": "<string>",
            "fuelCode2": "<string>",
            "fuelCode3": "<string>",
            "enginePowerHk1": 123,
            "enginePowerHk2": 123,
            "enginePowerHk3": 123,
            "enginePowerUnit1": "<string>",
            "enginePowerUnit2": "<string>",
            "enginePowerUnit3": "<string>",
            "fuelTankSize1": 123,
            "fuelTankSize2": 123,
            "fuelTankSize3": 123,
            "width": 123,
            "length": 123,
            "height": 123,
            "maxTrailerWeightKg": 123,
            "maxTrailerWeightB": 123,
            "maxTrailerWeightBExtB": 123,
            "maxWeightTrailer": 123,
            "maxWeightUnbreakedTrailer": 123,
            "maxTrailerSpeed": 123,
            "maxLoadWeight": 123,
            "fourWheelDrive": true,
            "maximumPowerForElectricVehicle": 123,
            "powerDuring30Minutes": 123,
            "powerDuring15Minutes": 123,
            "averagePayload": 123,
            "workVehicle": true,
            "environmentalClass": "<string>",
            "environmentalVehicle": "<string>",
            "environmentalClassEURO": "<string>",
            "emissionClass": "<string>",
            "superEnvironmentalVehicle": true,
            "co2Driv1": 123,
            "co2Driv2": 123,
            "co2Driv3": 123,
            "consumption1": 123,
            "consumption2": 123,
            "consumption3": 123,
            "energyConsumption": 123,
            "soundLevel1": 123,
            "soundLevel2": 123,
            "soundLevel3": 123,
            "consumptionWeightedMixed": 123,
            "co2WeightedMixed": 123,
            "wltp_C02Low1": 123,
            "wltp_C02Low2": 123,
            "wltp_C02Low3": 123,
            "wltp_C02Med1": 123,
            "wltp_C02Med2": 123,
            "wltp_C02Med3": 123,
            "wltp_C02High1": 123,
            "wltp_C02High2": 123,
            "wltp_C02High3": 123,
            "wltp_C02ExtraHigh1": 123,
            "wltp_C02ExtraHigh2": 123,
            "wltp_C02ExtraHigh3": 123,
            "wltp_C02Mixed1": 123,
            "wltp_C02Mixed2": 123,
            "wltp_C02Mixed3": 123,
            "wltp_CO2Weighted1": 123,
            "wltp_CO2Weighted2": 123,
            "wltp_CO2Weighted3": 123,
            "wltp_FuelConsumptionLow1": 123,
            "wltp_FuelConsumptionLow2": 123,
            "wltp_FuelConsumptionLow3": 123,
            "wltp_FuelConsumptionMed1": 123,
            "wltp_FuelConsumptionMed2": 123,
            "wltp_FuelConsumptionMed3": 123,
            "wltp_FuelConsumptionHigh1": 123,
            "wltp_FuelConsumptionHigh2": 123,
            "wltp_FuelConsumptionHigh3": 123,
            "wltp_FuelConsumptionExtraHigh1": 123,
            "wltp_FuelConsumptionExtraHigh2": 123,
            "wltp_FuelConsumptionExtraHigh3": 123,
            "wltp_FuelConsumptionMixed1": 123,
            "wltp_FuelConsumptionMixed2": 123,
            "wltp_FuelConsumptionMixed3": 123,
            "wltp_FuelConsumptionWeighted1": 123,
            "wltp_FuelConsumptionWeighted2": 123,
            "wltp_FuelConsumptionWeighted3": 123,
            "wltp_EnergyConsumption1": 123,
            "wltp_EnergyConsumption2": 123,
            "wltp_EnergyConsumption3": 123,
            "wltp_EnergyConsumptionWeighted1": 123,
            "wltp_EnergyConsumptionWeighted2": 123,
            "wltp_EnergyConsumptionWeighted3": 123,
            "wltp_Range1": 123,
            "wltp_Range2": 123,
            "wltp_RangeCity1": 123,
            "wltp_RangeCity2": 123,
            "wltp_CO2TypI_1": 123,
            "wltp_CO2TypI_2": 123,
            "wltp_CO2TypI_3": 123,
            "nedc_FuelConsumptionCity1": 123,
            "nedc_FuelConsumptionCity2": 123,
            "nedc_FuelConsumptionCity3": 123,
            "nedc_FuelConsumptionCountryRoad1": 123,
            "nedc_FuelConsumptionCountryRoad2": 123,
            "nedc_FuelConsumptionCountryRoad3": 123,
            "nedc_Range": 123,
            "eletricVehicleConfiguration": "<string>",
            "electricOrHybrid": "<string>",
            "numberOfAxles": 123,
            "wheelbase1": 123,
            "wheelbase2": 123,
            "wheelbase3": 123,
            "tireDimensionFront": "<string>",
            "tireDimensionRear": "<string>",
            "rimDimensionFront": "<string>",
            "rimDimensionRear": "<string>",
            "doubleCommand": true,
            "passengerAirbag": true,
            "rallyVehicle": true,
            "equipment1": "<string>",
            "equipment2": "<string>",
            "equipment3": "<string>",
            "wheelbase1Miminum": 123,
            "wheelbase2Miminum": 123,
            "wheelbase3Miminum": 123,
            "maxSpeed": 123,
            "limitedSpeed": "<string>",
            "advancedBreakingsystemMC": "<string>",
            "lastInspection": 123,
            "inspectionStatus": "<string>"
          },
          "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>",
              "currentOwnerCompanyId": "<string>",
              "currentUserCompanyId": "<string>",
              "lastMileageDate": 123,
              "mileageKm": 123,
              "wanted": true,
              "fabric": [
                "<string>"
              ],
              "fuelCombination": "<string>",
              "colorHex": "<string>",
              "color": "<string>",
              "name": "<string>",
              "licencePlate": "<string>",
              "deregistered": 123,
              "deregisteredText": "<string>",
              "deregisteredCause": "<string>",
              "vehicleType": "<string>",
              "vehicleCategoryEU": "<string>",
              "vehicleName": "<string>",
              "tradeName": "<string>",
              "modelYear": 123,
              "vehicleYear": 123,
              "vin": "<string>",
              "fabricCode": "<string>",
              "modelNumber": "<string>",
              "groupNumber": "<string>",
              "manufacturingYearAndMonth": 123,
              "manufactured": 123,
              "reusedLicencePlate": true,
              "registered": 123,
              "vehicleClass": "<string>",
              "doodlebug": true,
              "manufacturer": "<string>",
              "manfacturerBasicVehicle": "<string>",
              "acquiredDate": 123,
              "address": "<string>",
              "postalCode": "<string>",
              "city": "<string>",
              "municipalityCode": "<string>",
              "numberOfOwners": 123,
              "acquiredByOwner": 123,
              "registrationType": "<string>",
              "status": "<string>",
              "statusDate": 123,
              "statusCause": "<string>",
              "onLease": true,
              "areaOfUse1": "<string>",
              "areaOfUse2": "<string>",
              "areaOfUse3": "<string>",
              "areaOfUse4": "<string>",
              "areaOfUse5": "<string>",
              "insuranceType": "<string>",
              "insuranceCompany": "<string>",
              "onCredit": true,
              "importer": "<string>",
              "originCode": "<string>",
              "originCause": "<string>",
              "preregistered": 123,
              "earlierRegistration": 123,
              "directImport": true,
              "variety": "<string>",
              "version": "<string>",
              "type": "<string>",
              "bodyworkCode1": "<string>",
              "bodyworkCode2": "<string>",
              "bodyworkCodeAddition": "<string>",
              "busClass": "<string>",
              "numberOfPassengers": 123,
              "numberOfSeats": 123,
              "eeg": "<string>",
              "cylinderVolume": 123,
              "gearbox": "<string>",
              "coupling1": "<string>",
              "coupling2": "<string>",
              "curbWeight": 123,
              "weightInDrivingCondition": 123,
              "totalWeight": 123,
              "fuelCode1": "<string>",
              "fuelCode2": "<string>",
              "fuelCode3": "<string>",
              "enginePowerHk1": 123,
              "enginePowerHk2": 123,
              "enginePowerHk3": 123,
              "enginePowerUnit1": "<string>",
              "enginePowerUnit2": "<string>",
              "enginePowerUnit3": "<string>",
              "fuelTankSize1": 123,
              "fuelTankSize2": 123,
              "fuelTankSize3": 123,
              "width": 123,
              "length": 123,
              "height": 123,
              "maxTrailerWeightKg": 123,
              "maxTrailerWeightB": 123,
              "maxTrailerWeightBExtB": 123,
              "maxWeightTrailer": 123,
              "maxWeightUnbreakedTrailer": 123,
              "maxTrailerSpeed": 123,
              "maxLoadWeight": 123,
              "fourWheelDrive": true,
              "maximumPowerForElectricVehicle": 123,
              "powerDuring30Minutes": 123,
              "powerDuring15Minutes": 123,
              "averagePayload": 123,
              "workVehicle": true,
              "environmentalClass": "<string>",
              "environmentalVehicle": "<string>",
              "environmentalClassEURO": "<string>",
              "emissionClass": "<string>",
              "superEnvironmentalVehicle": true,
              "co2Driv1": 123,
              "co2Driv2": 123,
              "co2Driv3": 123,
              "consumption1": 123,
              "consumption2": 123,
              "consumption3": 123,
              "energyConsumption": 123,
              "soundLevel1": 123,
              "soundLevel2": 123,
              "soundLevel3": 123,
              "consumptionWeightedMixed": 123,
              "co2WeightedMixed": 123,
              "wltp_C02Low1": 123,
              "wltp_C02Low2": 123,
              "wltp_C02Low3": 123,
              "wltp_C02Med1": 123,
              "wltp_C02Med2": 123,
              "wltp_C02Med3": 123,
              "wltp_C02High1": 123,
              "wltp_C02High2": 123,
              "wltp_C02High3": 123,
              "wltp_C02ExtraHigh1": 123,
              "wltp_C02ExtraHigh2": 123,
              "wltp_C02ExtraHigh3": 123,
              "wltp_C02Mixed1": 123,
              "wltp_C02Mixed2": 123,
              "wltp_C02Mixed3": 123,
              "wltp_CO2Weighted1": 123,
              "wltp_CO2Weighted2": 123,
              "wltp_CO2Weighted3": 123,
              "wltp_FuelConsumptionLow1": 123,
              "wltp_FuelConsumptionLow2": 123,
              "wltp_FuelConsumptionLow3": 123,
              "wltp_FuelConsumptionMed1": 123,
              "wltp_FuelConsumptionMed2": 123,
              "wltp_FuelConsumptionMed3": 123,
              "wltp_FuelConsumptionHigh1": 123,
              "wltp_FuelConsumptionHigh2": 123,
              "wltp_FuelConsumptionHigh3": 123,
              "wltp_FuelConsumptionExtraHigh1": 123,
              "wltp_FuelConsumptionExtraHigh2": 123,
              "wltp_FuelConsumptionExtraHigh3": 123,
              "wltp_FuelConsumptionMixed1": 123,
              "wltp_FuelConsumptionMixed2": 123,
              "wltp_FuelConsumptionMixed3": 123,
              "wltp_FuelConsumptionWeighted1": 123,
              "wltp_FuelConsumptionWeighted2": 123,
              "wltp_FuelConsumptionWeighted3": 123,
              "wltp_EnergyConsumption1": 123,
              "wltp_EnergyConsumption2": 123,
              "wltp_EnergyConsumption3": 123,
              "wltp_EnergyConsumptionWeighted1": 123,
              "wltp_EnergyConsumptionWeighted2": 123,
              "wltp_EnergyConsumptionWeighted3": 123,
              "wltp_Range1": 123,
              "wltp_Range2": 123,
              "wltp_RangeCity1": 123,
              "wltp_RangeCity2": 123,
              "wltp_CO2TypI_1": 123,
              "wltp_CO2TypI_2": 123,
              "wltp_CO2TypI_3": 123,
              "nedc_FuelConsumptionCity1": 123,
              "nedc_FuelConsumptionCity2": 123,
              "nedc_FuelConsumptionCity3": 123,
              "nedc_FuelConsumptionCountryRoad1": 123,
              "nedc_FuelConsumptionCountryRoad2": 123,
              "nedc_FuelConsumptionCountryRoad3": 123,
              "nedc_Range": 123,
              "eletricVehicleConfiguration": "<string>",
              "electricOrHybrid": "<string>",
              "numberOfAxles": 123,
              "wheelbase1": 123,
              "wheelbase2": 123,
              "wheelbase3": 123,
              "tireDimensionFront": "<string>",
              "tireDimensionRear": "<string>",
              "rimDimensionFront": "<string>",
              "rimDimensionRear": "<string>",
              "doubleCommand": true,
              "passengerAirbag": true,
              "rallyVehicle": true,
              "equipment1": "<string>",
              "equipment2": "<string>",
              "equipment3": "<string>",
              "wheelbase1Miminum": 123,
              "wheelbase2Miminum": 123,
              "wheelbase3Miminum": 123,
              "maxSpeed": 123,
              "limitedSpeed": "<string>",
              "advancedBreakingsystemMC": "<string>",
              "lastInspection": 123,
              "inspectionStatus": "<string>"
            },
            "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
    }
  ]
}
Pro+ 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[]