Services
curl --request GET \
--url https://commerce.driv.ly/api/listings{
"data": [
{
"id": "<string>",
"odometer": 1,
"initialOfferDate": "2023-12-25",
"vehicle": "<string>",
"ownerCount": 1,
"dealer": "<string>",
"wholesaleBuyNowPrice": 123,
"accidentCount": 1,
"retailBuyNowPrice": 123,
"vehicleRating": 2.5,
"retailAskingPrice": 123,
"wholesaleMinimumBidPrice": 123,
"wholesaleMaximumBidPrice": 123,
"attachments": [
"<string>"
],
"vhrUrls": [
"<string>"
]
}
],
"success": true,
"page": 123,
"nextPage": 123,
"prevPage": 123,
"totalPages": 123,
"totalCount": 123,
"limit": 123,
"pagingCounter": 123,
"hasPrevPage": true,
"hasNextPage": true
}Get Listings
curl --request GET \
--url https://commerce.driv.ly/api/listings{
"data": [
{
"id": "<string>",
"odometer": 1,
"initialOfferDate": "2023-12-25",
"vehicle": "<string>",
"ownerCount": 1,
"dealer": "<string>",
"wholesaleBuyNowPrice": 123,
"accidentCount": 1,
"retailBuyNowPrice": 123,
"vehicleRating": 2.5,
"retailAskingPrice": 123,
"wholesaleMinimumBidPrice": 123,
"wholesaleMaximumBidPrice": 123,
"attachments": [
"<string>"
],
"vhrUrls": [
"<string>"
]
}
],
"success": true,
"page": 123,
"nextPage": 123,
"prevPage": 123,
"totalPages": 123,
"totalCount": 123,
"limit": 123,
"pagingCounter": 123,
"hasPrevPage": true,
"hasNextPage": true
}Query Parameters
Pass the name of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol ("-") to sort in descending order.
Limit number of results, default 10
Search for results fitting criteria, uses qs library for query string parsing
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
The value must be greater than.
The value must be greater than or equal.
The value must be less than.
The value must be less than or equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
The value must be greater than.
The value must be greater than or equal.
The value must be less than.
The value must be less than or equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
The value must be greater than.
The value must be greater than or equal.
The value must be less than.
The value must be less than or equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
The number of levels of related objects to include in the response
Response
Listings Found
Show child attributes
Show child attributes
Listing is uniquely identified by id
Listing has Odometer reading
x >= 0Listing has Initial Offer Date
Listing offers Vehicle for sale
Listing has Owner Count
x >= 0Listing is sold by Dealer
Listing has Wholesale Buy Now Price
Listing records Accident Count
x >= 0Listing has Retail Buy Now Price
Listing has Vehicle Rating
0 <= x <= 5Must be a multiple of 0.1Listing has Retail Asking Price
Listing has Wholesale Minimum Bid Price
Listing has Wholesale Maximum Bid Price
Listing has Attachment
Listing has condition details at VHR URL
Current page number
number of next page, null if it doesn't exist
number of previous page, null if it doesn't exist
Total pages available, based upon the limit
Total available records within the database
Limit query parameter, defaults to 10
number of the first record on the current page
true/false if previous page exists
true/false if next page exists