Create a new Search
curl --request POST \
--url https://commerce.driv.ly/api/searches \
--header 'Content-Type: application/json' \
--data '
{
"id": "src_5j3ks8d2hj3s",
"lead": "Lead ID",
"makes": [
"Toyota",
"Honda"
],
"trims": [
"SE",
"EX"
],
"models": [
"Camry",
"Civic"
],
"vehicles": [
"Vehicle ID"
],
"bodyStyles": [
"Sedan",
"SUV"
],
"minimumYear": 2015,
"maximumYear": 2021,
"drivetrains": [
"FWD",
"AWD"
],
"maximumPrice": 30000,
"vehicleSpecs": [
"Vehicle Spec ID"
],
"minimumRating": 4,
"transmissions": [
"Automatic",
"Manual"
],
"maximumOdometer": 50000
}
'import requests
url = "https://commerce.driv.ly/api/searches"
payload = {
"id": "src_5j3ks8d2hj3s",
"lead": "Lead ID",
"makes": ["Toyota", "Honda"],
"trims": ["SE", "EX"],
"models": ["Camry", "Civic"],
"vehicles": ["Vehicle ID"],
"bodyStyles": ["Sedan", "SUV"],
"minimumYear": 2015,
"maximumYear": 2021,
"drivetrains": ["FWD", "AWD"],
"maximumPrice": 30000,
"vehicleSpecs": ["Vehicle Spec ID"],
"minimumRating": 4,
"transmissions": ["Automatic", "Manual"],
"maximumOdometer": 50000
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'src_5j3ks8d2hj3s',
lead: 'Lead ID',
makes: ['Toyota', 'Honda'],
trims: ['SE', 'EX'],
models: ['Camry', 'Civic'],
vehicles: ['Vehicle ID'],
bodyStyles: ['Sedan', 'SUV'],
minimumYear: 2015,
maximumYear: 2021,
drivetrains: ['FWD', 'AWD'],
maximumPrice: 30000,
vehicleSpecs: ['Vehicle Spec ID'],
minimumRating: 4,
transmissions: ['Automatic', 'Manual'],
maximumOdometer: 50000
})
};
fetch('https://commerce.driv.ly/api/searches', 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://commerce.driv.ly/api/searches",
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([
'id' => 'src_5j3ks8d2hj3s',
'lead' => 'Lead ID',
'makes' => [
'Toyota',
'Honda'
],
'trims' => [
'SE',
'EX'
],
'models' => [
'Camry',
'Civic'
],
'vehicles' => [
'Vehicle ID'
],
'bodyStyles' => [
'Sedan',
'SUV'
],
'minimumYear' => 2015,
'maximumYear' => 2021,
'drivetrains' => [
'FWD',
'AWD'
],
'maximumPrice' => 30000,
'vehicleSpecs' => [
'Vehicle Spec ID'
],
'minimumRating' => 4,
'transmissions' => [
'Automatic',
'Manual'
],
'maximumOdometer' => 50000
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://commerce.driv.ly/api/searches"
payload := strings.NewReader("{\n \"id\": \"src_5j3ks8d2hj3s\",\n \"lead\": \"Lead ID\",\n \"makes\": [\n \"Toyota\",\n \"Honda\"\n ],\n \"trims\": [\n \"SE\",\n \"EX\"\n ],\n \"models\": [\n \"Camry\",\n \"Civic\"\n ],\n \"vehicles\": [\n \"Vehicle ID\"\n ],\n \"bodyStyles\": [\n \"Sedan\",\n \"SUV\"\n ],\n \"minimumYear\": 2015,\n \"maximumYear\": 2021,\n \"drivetrains\": [\n \"FWD\",\n \"AWD\"\n ],\n \"maximumPrice\": 30000,\n \"vehicleSpecs\": [\n \"Vehicle Spec ID\"\n ],\n \"minimumRating\": 4,\n \"transmissions\": [\n \"Automatic\",\n \"Manual\"\n ],\n \"maximumOdometer\": 50000\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/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://commerce.driv.ly/api/searches")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"src_5j3ks8d2hj3s\",\n \"lead\": \"Lead ID\",\n \"makes\": [\n \"Toyota\",\n \"Honda\"\n ],\n \"trims\": [\n \"SE\",\n \"EX\"\n ],\n \"models\": [\n \"Camry\",\n \"Civic\"\n ],\n \"vehicles\": [\n \"Vehicle ID\"\n ],\n \"bodyStyles\": [\n \"Sedan\",\n \"SUV\"\n ],\n \"minimumYear\": 2015,\n \"maximumYear\": 2021,\n \"drivetrains\": [\n \"FWD\",\n \"AWD\"\n ],\n \"maximumPrice\": 30000,\n \"vehicleSpecs\": [\n \"Vehicle Spec ID\"\n ],\n \"minimumRating\": 4,\n \"transmissions\": [\n \"Automatic\",\n \"Manual\"\n ],\n \"maximumOdometer\": 50000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://commerce.driv.ly/api/searches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"src_5j3ks8d2hj3s\",\n \"lead\": \"Lead ID\",\n \"makes\": [\n \"Toyota\",\n \"Honda\"\n ],\n \"trims\": [\n \"SE\",\n \"EX\"\n ],\n \"models\": [\n \"Camry\",\n \"Civic\"\n ],\n \"vehicles\": [\n \"Vehicle ID\"\n ],\n \"bodyStyles\": [\n \"Sedan\",\n \"SUV\"\n ],\n \"minimumYear\": 2015,\n \"maximumYear\": 2021,\n \"drivetrains\": [\n \"FWD\",\n \"AWD\"\n ],\n \"maximumPrice\": 30000,\n \"vehicleSpecs\": [\n \"Vehicle Spec ID\"\n ],\n \"minimumRating\": 4,\n \"transmissions\": [\n \"Automatic\",\n \"Manual\"\n ],\n \"maximumOdometer\": 50000\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "src_5j3ks8d2hj3s",
"lead": "Lead ID",
"makes": [
"Toyota",
"Honda"
],
"trims": [
"SE",
"EX"
],
"models": [
"Camry",
"Civic"
],
"vehicles": [
"Vehicle ID"
],
"bodyStyles": [
"Sedan",
"SUV"
],
"minimumYear": 2015,
"maximumYear": 2021,
"drivetrains": [
"FWD",
"AWD"
],
"maximumPrice": 30000,
"vehicleSpecs": [
"Vehicle Spec ID"
],
"minimumRating": 4,
"transmissions": [
"Automatic",
"Manual"
],
"maximumOdometer": 50000
},
"success": true
}{
"error": {
"code": 400,
"message": "Missing Required Information"
},
"success": false
}{
"error": {
"code": 401,
"message": "Unauthorized"
},
"success": false
}{
"error": {
"code": 429,
"message": "Too Many Requests"
},
"success": false
}Listings
Create a new Search
POST
/
searches
Create a new Search
curl --request POST \
--url https://commerce.driv.ly/api/searches \
--header 'Content-Type: application/json' \
--data '
{
"id": "src_5j3ks8d2hj3s",
"lead": "Lead ID",
"makes": [
"Toyota",
"Honda"
],
"trims": [
"SE",
"EX"
],
"models": [
"Camry",
"Civic"
],
"vehicles": [
"Vehicle ID"
],
"bodyStyles": [
"Sedan",
"SUV"
],
"minimumYear": 2015,
"maximumYear": 2021,
"drivetrains": [
"FWD",
"AWD"
],
"maximumPrice": 30000,
"vehicleSpecs": [
"Vehicle Spec ID"
],
"minimumRating": 4,
"transmissions": [
"Automatic",
"Manual"
],
"maximumOdometer": 50000
}
'import requests
url = "https://commerce.driv.ly/api/searches"
payload = {
"id": "src_5j3ks8d2hj3s",
"lead": "Lead ID",
"makes": ["Toyota", "Honda"],
"trims": ["SE", "EX"],
"models": ["Camry", "Civic"],
"vehicles": ["Vehicle ID"],
"bodyStyles": ["Sedan", "SUV"],
"minimumYear": 2015,
"maximumYear": 2021,
"drivetrains": ["FWD", "AWD"],
"maximumPrice": 30000,
"vehicleSpecs": ["Vehicle Spec ID"],
"minimumRating": 4,
"transmissions": ["Automatic", "Manual"],
"maximumOdometer": 50000
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'src_5j3ks8d2hj3s',
lead: 'Lead ID',
makes: ['Toyota', 'Honda'],
trims: ['SE', 'EX'],
models: ['Camry', 'Civic'],
vehicles: ['Vehicle ID'],
bodyStyles: ['Sedan', 'SUV'],
minimumYear: 2015,
maximumYear: 2021,
drivetrains: ['FWD', 'AWD'],
maximumPrice: 30000,
vehicleSpecs: ['Vehicle Spec ID'],
minimumRating: 4,
transmissions: ['Automatic', 'Manual'],
maximumOdometer: 50000
})
};
fetch('https://commerce.driv.ly/api/searches', 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://commerce.driv.ly/api/searches",
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([
'id' => 'src_5j3ks8d2hj3s',
'lead' => 'Lead ID',
'makes' => [
'Toyota',
'Honda'
],
'trims' => [
'SE',
'EX'
],
'models' => [
'Camry',
'Civic'
],
'vehicles' => [
'Vehicle ID'
],
'bodyStyles' => [
'Sedan',
'SUV'
],
'minimumYear' => 2015,
'maximumYear' => 2021,
'drivetrains' => [
'FWD',
'AWD'
],
'maximumPrice' => 30000,
'vehicleSpecs' => [
'Vehicle Spec ID'
],
'minimumRating' => 4,
'transmissions' => [
'Automatic',
'Manual'
],
'maximumOdometer' => 50000
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://commerce.driv.ly/api/searches"
payload := strings.NewReader("{\n \"id\": \"src_5j3ks8d2hj3s\",\n \"lead\": \"Lead ID\",\n \"makes\": [\n \"Toyota\",\n \"Honda\"\n ],\n \"trims\": [\n \"SE\",\n \"EX\"\n ],\n \"models\": [\n \"Camry\",\n \"Civic\"\n ],\n \"vehicles\": [\n \"Vehicle ID\"\n ],\n \"bodyStyles\": [\n \"Sedan\",\n \"SUV\"\n ],\n \"minimumYear\": 2015,\n \"maximumYear\": 2021,\n \"drivetrains\": [\n \"FWD\",\n \"AWD\"\n ],\n \"maximumPrice\": 30000,\n \"vehicleSpecs\": [\n \"Vehicle Spec ID\"\n ],\n \"minimumRating\": 4,\n \"transmissions\": [\n \"Automatic\",\n \"Manual\"\n ],\n \"maximumOdometer\": 50000\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/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://commerce.driv.ly/api/searches")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"src_5j3ks8d2hj3s\",\n \"lead\": \"Lead ID\",\n \"makes\": [\n \"Toyota\",\n \"Honda\"\n ],\n \"trims\": [\n \"SE\",\n \"EX\"\n ],\n \"models\": [\n \"Camry\",\n \"Civic\"\n ],\n \"vehicles\": [\n \"Vehicle ID\"\n ],\n \"bodyStyles\": [\n \"Sedan\",\n \"SUV\"\n ],\n \"minimumYear\": 2015,\n \"maximumYear\": 2021,\n \"drivetrains\": [\n \"FWD\",\n \"AWD\"\n ],\n \"maximumPrice\": 30000,\n \"vehicleSpecs\": [\n \"Vehicle Spec ID\"\n ],\n \"minimumRating\": 4,\n \"transmissions\": [\n \"Automatic\",\n \"Manual\"\n ],\n \"maximumOdometer\": 50000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://commerce.driv.ly/api/searches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"src_5j3ks8d2hj3s\",\n \"lead\": \"Lead ID\",\n \"makes\": [\n \"Toyota\",\n \"Honda\"\n ],\n \"trims\": [\n \"SE\",\n \"EX\"\n ],\n \"models\": [\n \"Camry\",\n \"Civic\"\n ],\n \"vehicles\": [\n \"Vehicle ID\"\n ],\n \"bodyStyles\": [\n \"Sedan\",\n \"SUV\"\n ],\n \"minimumYear\": 2015,\n \"maximumYear\": 2021,\n \"drivetrains\": [\n \"FWD\",\n \"AWD\"\n ],\n \"maximumPrice\": 30000,\n \"vehicleSpecs\": [\n \"Vehicle Spec ID\"\n ],\n \"minimumRating\": 4,\n \"transmissions\": [\n \"Automatic\",\n \"Manual\"\n ],\n \"maximumOdometer\": 50000\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "src_5j3ks8d2hj3s",
"lead": "Lead ID",
"makes": [
"Toyota",
"Honda"
],
"trims": [
"SE",
"EX"
],
"models": [
"Camry",
"Civic"
],
"vehicles": [
"Vehicle ID"
],
"bodyStyles": [
"Sedan",
"SUV"
],
"minimumYear": 2015,
"maximumYear": 2021,
"drivetrains": [
"FWD",
"AWD"
],
"maximumPrice": 30000,
"vehicleSpecs": [
"Vehicle Spec ID"
],
"minimumRating": 4,
"transmissions": [
"Automatic",
"Manual"
],
"maximumOdometer": 50000
},
"success": true
}{
"error": {
"code": 400,
"message": "Missing Required Information"
},
"success": false
}{
"error": {
"code": 401,
"message": "Unauthorized"
},
"success": false
}{
"error": {
"code": 429,
"message": "Too Many Requests"
},
"success": false
}Query Parameters
The number of levels of related objects to include in the response
Body
application/json
Lead performs vehicle- Search
Search is uniquely identified by id
Search has Minimum Year
Search has Minimum Rating
Required range:
0 <= x <= 5Must be a multiple of 0.1Search has Maximum Year
Search has Maximum Price
Search has Maximum Odometer reading
Required range:
x >= 0Search has Vehicle Spec
Search found Vehicle
Search has Model
Search has Transmission
Search has Drivetrain
Search has Make
Search has Body Style
Search has Trim
Response
Search Created
Show child attributes
Show child attributes
Example:
{
"id": "src_5j3ks8d2hj3s",
"lead": "Lead ID",
"makes": ["Toyota", "Honda"],
"trims": ["SE", "EX"],
"models": ["Camry", "Civic"],
"vehicles": ["Vehicle ID"],
"bodyStyles": ["Sedan", "SUV"],
"minimumYear": 2015,
"maximumYear": 2021,
"drivetrains": ["FWD", "AWD"],
"maximumPrice": 30000,
"vehicleSpecs": ["Vehicle Spec ID"],
"minimumRating": 4,
"transmissions": ["Automatic", "Manual"],
"maximumOdometer": 50000
}