GET
/
listings
Get Listings
curl --request GET \
  --url https://commerce.driv.ly/api/listings
{
  "data": [
    {
      "id": "lst_k3j5s9qj3w0d",
      "dealer": "dlr_4dk39dkl3d93",
      "vehicle": "veh_3k12j9qksdf0",
      "vhrUrls": [
        "https://example.com/vhr.pdf"
      ],
      "odometer": 15000,
      "ownerCount": 1,
      "attachments": [],
      "accidentCount": 0,
      "vehicleRating": 8,
      "initialOfferDate": "2022-05-10",
      "retailBuyNowPrice": 35000,
      "retailAskingPrice": 34000,
      "wholesaleBuyNowPrice": 30000,
      "wholesaleMinimumBidPrice": 28000,
      "wholesaleMaximumBidPrice": 32000
    }
  ],
  "success": true,
  "page": 2,
  "nextPage": 3,
  "prevPage": 1,
  "totalPages": 3,
  "totalCount": 25,
  "limit": 10,
  "pagingCounter": 11,
  "hasPrevPage": true,
  "hasNextPage": true
}

Query Parameters

depth
integer

The number of levels of related objects to include in the response

sort
string

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

Limit number of results, default 10

where
object

Search for results fitting criteria, uses qs library for query string parsing

Response

200
application/json

Listings Found

data
Listing · object[]
success
boolean
page
number

Current page number

Examples:

2

nextPage
number | null

number of next page, null if it doesn't exist

Examples:

3

prevPage
number | null

number of previous page, null if it doesn't exist

Examples:

1

totalPages
number

Total pages available, based upon the limit

Examples:

3

totalCount
number

Total available records within the database

Examples:

25

limit
number

Limit query parameter, defaults to 10

Examples:

10

pagingCounter
number

number of the first record on the current page

Examples:

11

hasPrevPage
boolean

true/false if previous page exists

Examples:

true

hasNextPage
boolean

true/false if next page exists

Examples:

true