--- title: "Get Listing Prices" url: "https://api-docs.centraldispatch.com/apis/market-intelligence-api-1-0-0/versions/3fc04e8d-bb56-47cd-b2e7-3130bc01a22e/operations/postGetListingPrices" --- > Full API specification: https://api-docs.centraldispatch.com/apis/market-intelligence-api-1-0-0/versions/3fc04e8d-bb56-47cd-b2e7-3130bc01a22e.md # Get Listing Prices `POST` `/market-intelligence/list-prices` Operation ID: `postGetListingPrices` Gets predicted pricing and historical data about listings, dispatches and pricing given a load with similar vehicle, origin and destination. #### 👥 Applicable Roles - Enterprise Package Customers #### 📝 Important Notes - Stops array must include two valid stops. - Stop numbers must increment sequentially starting from one. - Each stop requires either valid latitude and longitude coordinates (most accurate) or city and state. Try to include street address and country if latitude and longitude coordinates are not available. The more information provided the more accurate the results will be. - Origin and destination stops cannot be the same. - The vehicles array must include one valid vehicle entry. - Both `pickUpStopNumber` and `dropOffStopNumber` are required and must correspond to stop numbers in the stops array (typically 1 and 2). - When `enforceEnclosedOnly` is set to `true` in the request, every comparable listing returned will have `isEnclosed` set to `true`. The `isEnclosed` and `inoperable` fields are returned on every comparable listing regardless of the request flags. ## Header parameters - `Content-Type` (string, required) - The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to `application/vnd.coxauto.v1+json`. ## Request body Content types: `application/json` ## Responses - `200` - OK. Successful request. - `400` - Bad Request. Check the request payload. **Scenarios:** - Invalid JSON format in request body. - Request body has incorrect data types or structure. - `401` - Unauthorized. Authentication failed or missing. - `403` - Forbidden. The attempted action is not permitted. - `415` - Unsupported Media Type **Scenarios:** - `Content-Type` version header is missing or invalid - v1 API requires `Content-Type: application/vnd.coxauto.v1+json`. - `422` - Unprocessable Entity. Errors found in the request. **Scenarios:** - Missing required fields (vehicles, origin stop, destination stop). - Invalid postal code format (must be valid US ZIP or Canadian postal code). - Missing location data (requires city/state/postalCode OR latitude/longitude). - Invalid vehicle stop numbers (vehicle references non-existent stops). - Missing vehicle identification (requires VIN OR year/make/model). - Missing vehicle type. - Invalid limit value (limit must be between 1 and 5). - `429` - Too Many Requests. Rate limit exceeded. - `500` - Error. - `503` - Service Unavailable. Temporary service interruption. ## OpenAPI definition ```yaml openapi: 3.0.1 info: title: Market Intelligence API version: 1.0.0 servers: - url: https://api.centraldispatch.com description: Production server paths: /market-intelligence/list-prices: post: tags: - Market Itelligence summary: Get Listing Prices description: >- Gets predicted pricing and historical data about listings, dispatches and pricing given a load with similar vehicle, origin and destination. #### 👥 Applicable Roles - Enterprise Package Customers #### 📝 Important Notes - Stops array must include two valid stops. - Stop numbers must increment sequentially starting from one. - Each stop requires either valid latitude and longitude coordinates (most accurate) or city and state. Try to include street address and country if latitude and longitude coordinates are not available. The more information provided the more accurate the results will be. - Origin and destination stops cannot be the same. - The vehicles array must include one valid vehicle entry. - Both `pickUpStopNumber` and `dropOffStopNumber` are required and must correspond to stop numbers in the stops array (typically 1 and 2). - When `enforceEnclosedOnly` is set to `true` in the request, every comparable listing returned will have `isEnclosed` set to `true`. The `isEnclosed` and `inoperable` fields are returned on every comparable listing regardless of the request flags. operationId: postGetListingPrices parameters: - name: Content-Type in: header description: The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to `application/vnd.coxauto.v1+json`. required: true schema: type: string example: application/vnd.coxauto.v1+json requestBody: description: "`ListingPriceRequest`" content: application/json: schema: $ref: "#/components/schemas/ListingPriceRequest" examples: ex.: value: stops: - stopNumber: 1 streetAddress1: 345 W Elm St. city: Anaheim state: CA postalCode: "92802" country: US latitude: 33.81228788622535 longitude: -117.91836265987132 - stopNumber: 2 streetAddress1: 255 Sands Ave. city: Las Vegas state: NV postalCode: "89169" country: US latitude: 36.121343020081525 longitude: -115.16195281104913 vehicles: - vin: KL8CH6SA6NC001234 year: "2022" make: Chevrolet model: Spark isOperable: false pickupStopNumber: 1 dropOffStopNumber: 2 vehicleType: CAR isEnclosed: true enforceEnclosedOnly: true limit: 1 dateSince: 2026-03-20T00:00:00Z ex. minimal: value: stops: - stopNumber: 1 latitude: 33.81228788622535 longitude: -117.91836265987132 - stopNumber: 2 latitude: 36.121343020081525 longitude: -115.16195281104913 vehicles: - vin: KL8CH6SA6NC001234 vehicleType: CAR pickupStopNumber: 1 dropOffStopNumber: 2 responses: "200": description: OK. Successful request. headers: X-CoxAuto-Media-Type: description: Contains the major version and format information. schema: type: string example: coxauto.v1; format=json content: application/json: schema: $ref: "#/components/schemas/ListingPriceResponseCollection" "400": description: |- Bad Request. Check the request payload. **Scenarios:** - Invalid JSON format in request body. - Request body has incorrect data types or structure. content: application/json: schema: $ref: "#/components/schemas/Errors" "401": description: Unauthorized. Authentication failed or missing. "403": description: Forbidden. The attempted action is not permitted. "415": description: >- Unsupported Media Type **Scenarios:** - `Content-Type` version header is missing or invalid - v1 API requires `Content-Type: application/vnd.coxauto.v1+json`. content: application/json: schema: $ref: "#/components/schemas/Errors" "422": description: >- Unprocessable Entity. Errors found in the request. **Scenarios:** - Missing required fields (vehicles, origin stop, destination stop). - Invalid postal code format (must be valid US ZIP or Canadian postal code). - Missing location data (requires city/state/postalCode OR latitude/longitude). - Invalid vehicle stop numbers (vehicle references non-existent stops). - Missing vehicle identification (requires VIN OR year/make/model). - Missing vehicle type. - Invalid limit value (limit must be between 1 and 5). content: application/json: schema: $ref: "#/components/schemas/Errors" "429": description: Too Many Requests. Rate limit exceeded. "500": description: Error. content: application/json: schema: $ref: "#/components/schemas/Errors" "503": description: Service Unavailable. Temporary service interruption. security: - Bearer: [] security: - Bearer: [] components: schemas: ListingPriceRequest: type: object properties: stops: type: array items: $ref: "#/components/schemas/Stop" description: A collection of stops. A minimum of 2 stops (pick up and delivery) must be sent. Either address data or latitutude/longitude are required. vehicles: type: array items: $ref: "#/components/schemas/Vehicle" description: A collection of vehicles. Either `VIN` or YMM is required. isEnclosed: type: boolean description: Limit search to enclosed trailers. default: false example: true enforceEnclosedOnly: type: boolean description: When `true`, strictly limits search results to fully enclosed items only. By default, the search relaxes enclosed requirements to improve match rates, but enabling this flag ensures no non-enclosed results are returned. default: false nullable: true example: true limit: maximum: 5 minimum: 1 type: integer description: The maximum number of items to be returned in the response. format: int32 default: 5 nullable: true example: 1 dateSince: type: string description: The earliest creation date for comparable listings to include in results. Accepts any date between today and the last 365 days. If not provided, defaults to 365 days ago, in UTC/ISO 8601 format. format: date-time nullable: true example: 2026-03-20T00:00:00Z description: Details of listing prices. ListingPriceResponseCollection: type: object properties: href: type: string description: The URL used to query the current collection of the resource. nullable: true example: https://api.centraldispatch.com/list-prices count: type: integer description: The total count of resources in the collection. format: int32 example: 1 limit: type: integer description: The maximum number of items to be returned in the response. format: int32 example: 1 items: type: array items: $ref: "#/components/schemas/ListingPriceResponse" description: A collection of listing price response items. nullable: true description: A collection of listing price responses. Errors: type: object properties: errors: type: array items: $ref: "#/components/schemas/Error" description: A collection of errors. nullable: true description: An error occurred, and the request could not be completed. Stop: type: object properties: stopNumber: type: integer description: The sequential number of the stop along the route e.g. 1 is the pick up stop and 2 is the delivery stop. format: int32 example: 1 streetAddress1: type: string description: The street address. nullable: true example: 345 W Elm St. streetAddress2: type: string description: Additional street address line. nullable: true example: 2nd Floor city: type: string description: The city. Required if valid `latitude` and `longitude` are not provided. nullable: true example: Anaheim state: type: string description: The state. Required if valid `latitude` and `longitude` are not provided. nullable: true example: CA country: type: string description: The country code. US or CA. nullable: true example: US postalCode: type: string description: The ZIP code. Must be a valid United States ZIP code or Canadian postal code. nullable: true example: "92802" latitude: type: number description: The latitude of the location. Required if valid `city` and `state` are not provided. format: double nullable: true example: 33.81228788622535 longitude: type: number description: The longitude of the location. Required if valid `city` and `state` are not provided. format: double nullable: true example: -117.91836265987132 description: Details of a stop. Vehicle: type: object properties: vin: type: string description: The vehicle identification number (VIN). Required if valid `year`, `make` and `model` are not provided. nullable: true example: KL8CH6SA6NC001234 year: type: string description: The 4 digit year of the vehicle. Required if valid `vin` is not provided. nullable: true example: "2022" make: type: string description: The manufacturer's make of the vehicle. Required if valid `vin` is not provided. nullable: true example: Chevrolet model: type: string description: The manufacturer's model of the vehicle. Required if valid `vin` is not provided. nullable: true example: Spark isOperable: type: boolean description: Limit search to operable vehicles. default: false example: true pickupStopNumber: type: integer description: The stop number where the vehicle will be picked up. Origin stop number from the stops array. format: int32 example: 1 dropOffStopNumber: type: integer description: The sequential stop number where the vehicle will be delivered. Destination stop number from the stops array. format: int32 example: 2 vehicleType: type: string description: The type of vehicle e.g. CAR, PICKUP, SUV. example: CAR description: Details of a vehicle. ListingPriceResponse: type: object properties: lowPrice: type: number description: The lowest price found. format: double nullable: true example: 100 lowPriceCurrency: type: string description: The currency of `lowPrice`. nullable: true example: USD highPrice: type: number description: The highest price found. format: double nullable: true example: 200 highPriceCurrency: type: string description: The currency of `highPrice`. nullable: true example: USD meanPredictedPrice: type: number description: The mean predicted price. format: double nullable: true example: 150 meanPredictedPriceCurrency: type: string description: The currency of `meanPredictedPrice`. nullable: true example: USD originCity: type: string description: The pick up city. nullable: true example: Anaheim originState: type: string description: The pick up state. nullable: true example: CA originZipCode: type: string description: The pick up ZIP code. Must be a valid United States ZIP code or Canadian postal code. nullable: true example: "92802" destinationCity: type: string description: The delivery city. nullable: true example: Las Vegas destinationState: type: string description: The delivery state. nullable: true example: NV destinationZipCode: type: string description: The delivery ZIP code. nullable: true example: "89169" vehicleType: type: string description: The type of vehicle e.g. CAR, PICKUP, SUV. nullable: true example: CAR vehicleSize: type: string description: The size of the vehicle. nullable: true example: MEDIUM listingPrice: type: number description: The listing price. format: double example: 120 listingPriceCurrency: type: string description: The currency of `listingPrice`. nullable: true example: USD listingPricePerMile: type: number description: The listing price per mile. format: double example: 1.5 listingPricePerMileCurrency: type: string description: The currency of `listingPricePerMile`. nullable: true example: USD listingCreationDate: type: string description: The date and time the listing was created, in UTC/ISO 8601 format. format: date-time nullable: true example: 2024-08-01T00:00:00Z dispatchDistance: type: number description: The total travel distance. format: double example: 267 dispatchDistanceUnits: type: string description: The units of `dispatchDistance`. nullable: true example: MILES listingDistance: type: number description: The total travel distance. format: double example: 267 listingDistanceUnits: type: string description: The units of `listingDistance`. nullable: true example: MILES dispatchStatus: type: string description: The status of the dispatch. nullable: true example: DELIVERED dispatchPrice: type: number description: The total amount to be paid for completing the dispatch. format: double example: 180 dispatchPriceCurrency: type: string description: The currency of `dispatchPrice`. nullable: true example: USD dispatchPricePerMile: type: number description: The per mile price of the dispatch. format: double example: 0.55 dispatchPricePerMileCurrency: type: string description: The currency of `dispatchPricePerMile`. nullable: true example: USD dispatchDate: type: string description: The actual pick up date and time, in UTC/ISO 8601 format. format: date-time nullable: true example: 2024-09-10T00:00:00Z minTimeToDispatchForMeanPredictedPrice: type: number description: The shortest estimated time it will take for your dispatch to be accepted by a carrier, if listed at the predicted price. format: double nullable: true example: 2 minTimeToDispatchForMeanPredictedPriceUnits: type: string description: The unit of time for the `minTimeToDispatchForMeanPredictedPrice` value (e.g., HOURS). nullable: true example: HOURS maxTimeToDispatchForMeanPredictedPrice: type: number description: The longest estimated time it will take for your dispatch to be accepted by a carrier, if listed at the predicted price. format: double nullable: true example: 8 maxTimeToDispatchForMeanPredictedPriceUnits: type: string description: The unit of time for the `maxTimeToDispatchForMeanPredictedPrice` value (e.g., HOURS). nullable: true example: HOURS isEnclosed: type: boolean description: Indicates whether the comparable listing was transported on a fully enclosed trailer. Lets consumers using `enforceEnclosedOnly` confirm the filter has been applied, and gives all consumers visibility into the trailer type for each comparable listing. nullable: true example: true inoperable: type: boolean description: Indicates whether the vehicle on the comparable listing was inoperable (could not be driven on/off the trailer under its own power). Surfaces a key pricing factor, since inoperable vehicles typically command different rates than operable ones. nullable: true example: false description: Details of the listing price. Error: type: object properties: code: type: string description: The code used for the issue. nullable: true example: resource.issue_type message: type: string description: A detailed message. nullable: true example: The issue happened because something is wrong. property: type: string description: The property to which the issue is associated. nullable: true example: person properties: type: object additionalProperties: type: string description: Additional properties related to the issue. nullable: true example: firstName: D0nn@ lastName: Sm!th description: Details of an error or issue. securitySchemes: Bearer: type: http scheme: Bearer ```