The base URL for this endpoint is https://comsumapi.com/api/v1/bat12/

Demo Link

Things To Know About This Endpoint
– Generates the comment summaries and bid history chart links from the BAT 12 Project Webzine.
– Uses the submitted ‘vin_chassis’ parameter to locate the parameters in the database.
– If the ‘vin_chassis’ is not provided or cannot be located in the database it falls back to the submitted ‘auction_url’.
– If the ‘auction_url’ cannot be located in the database a new entry will be created. This can delay the normal response timing.
– The response includes broken out comment segments and a link to the bid history chart.

The /projectcommentschart/ Endpoint Request Requires The Following GET Inputs
* ‘api-token’ – posted in Header
* ‘api-secret’ – posted in Header
* ‘vin_chassis’ = the vehicle’s VIN or chassis number using capital letters only – Optional – posted as a Query String parameter
* ‘auction_url’ = the Bring a Trailer auction listing page URL – Optional – posted as a Query String parameter
– either or both the ‘vin’ and/or the ‘auction_url’ must be submitted

The /commentsummary/ Endpoint Response Parameters Are The Following
* ‘status’ = see codes below
* ‘message’ = see codes below
* ‘vin_chassis’ = the submitted VIN or chassis number
* ‘marque’ = the marque designated by Bring a Trailer
* ‘mileage’ = the mileage given at the time of the auction
* “type” = seller type dealer or private party
* ‘description’ = the vehicle’s description on Bring a Trailer
* ‘positive_comments’ = the positive comment summary block for the auction
* ‘neutral_comments’ = the neutral comment summary block for the auction
* ‘negative_comments’ = the negative comment summary block for the auction
* ‘bid_history_chart’ = the bid history chart url e.g. https://commasumma.com/bat12projectcharts?id=bat12-102805080

The /commentsummary/ Endpoint Response Codes Are The Following
* 200 = “request success”
* 400 = “syntax failure” => bad request syntax
* 401 = “invalid credentials” => unrecognized API Token and/or Secret
* 403 = “forbidden” => not authorized to request endpoint
* 404 = ‘unsupported vehicle’ => ‘vin’ was not found in the database or was not submitted and an auction URL was not submitted
* 404 = “unsupported auction” => URL submitted is not a valid Bring a Trailer auction with our without an ‘unsupported vehicle’ error
* 404 = ‘unsupported url’ => ‘auction_url’ syntax is not associated with a Bring a Trailer
* 429 = “exceeded rate limit” => exceeded per second, per day, per month or other limits
* 500 = “server error” => internal server or other error

/commentsummary/ Endpoint Pricing
– Contact us regarding your use case and volume needs.

The base URL for this endpoint is https://comsumapi.com/api/v1/

Demo Link

Things To Know About This Endpoint
– Generates a summary of the submitted content in the format ‘type’ requested.
– The ‘custom’ type generates the output based on the format language included in the ‘request’.
– The response is the summary in the format requested.

The /commentsummary/ Endpoint Request Requires The Following POST Inputs
* ‘api-token’ – posted in Header
* ‘api-secret’ – posted in Header
* ‘type’ = the comment summary method being requested – Required – posted in Body
– ‘pnn’ = fixed request for a summary containing positive, neutral and negative narrative components
– ‘general’ = fixed request for a general summary
– ‘custom’ = a custom request including the requested response format (e.g. plain text, JSON, HTML etc.)
* ‘comments’ = the content to be summarized – Required – posted in Body
– submissions must be in JSON format
– submissions are truncated at 100,000 characters for processing
* ‘request’ = the request to be used when ‘type’ = ‘custom’ – Required -posted in Body
– submissions must be in JSON format
– submissions are truncated at 2500 characters for processing
– if the response is requested in HTML format it is suggested to add the following to the ‘request’ string: ‘Format the response in basic HTML. Return raw HTML only. Do not wrap the response in markdown code blocks. Do not include “`html or “` markers. Do not include back slashes.’
– A 200,000 character limit is applied to the entire submission.

The /commentsummary/ Endpoint Response Parameters Are The Following
* ‘status’ = see codes below
* ‘message’ = see codes below
* type pnn response
– ‘positive_summary’ = a summary of the positive content in the submission formatted in plain text
– ‘neutral_summary’ = a summary of the neutral content in the submission formatted in plain text
– ‘negative_summary’ = a summary of the negative content in the submission formatted in plain text
* type general response
– ‘general_summary’ = a general summary of the submitted content formatted in plain text
* type custom response
– ‘custom_summary’ = a response guided by the request submitted including the requested format (e.g. plain text, HTML etc.)
– the response is limited to 10,000 characters

The /commentsummary/ Endpoint Response Codes Are The Following
* 200 = “request success”
* 400 = “syntax failure” => bad request syntax
* 400 = “type required” => no type submitted
* 400 = “type invalid” => type submitted not recognized
* 400 = “comments required” => no comments submitted
* 400 = “request required” => no request submitted when type is ‘custom’
* 401 = “invalid credentials” => unrecognized API Token and/or Secret
* 403 = “forbidden” => not authorized to request endpoint
* 413 = “payload too large” => 200k character limit exceeded
* 429 = “exceeded rate limit” => exceeded per second, per day, per month or other limits
* 500 = “server error” => internal server or other error

/commentsummary/ Endpoint Pricing
– Contact us regarding your use case and volume needs.

Demo Link

Things To Know About This Endpoint
– Generates an evaluation, assessment and rating of the vehicle based upon the ‘vehicle_description’ submitted.
– To generate a response it uses hundreds of thousands of comment summary segments from the BAT 12 Project database and dozens of other curated third party analytical resources as requested by the application.
– The production process allows the user to balance preciseness with robustness in the response. The more drilled down the request the more precise the response. However, this limits the number of applicable segments used which generates a less robust overall analysis.
– The analysis uses the submitted ‘vin_chassis’ parameter to locate segments which match up to the first 8 characters.
– If the ‘vin_chassis’ is not provided or cannot be matched it falls back to the submitted ‘marque’ value.
– It first creates a sublist of segments matching the ‘marque’ in the database.
– It then uses this sublist to further select only segments which contain ‘model_key_1’ in the database description.
– If ‘model_key_2’ and/or ‘year’ values are submitted these are further used to screen in only segments with these values.
– The response is multipart and includes crowdsourcing statistics.
– The rating response can vary between requests for the same vehicle as a function of the crowd responses applied.

The /crowdsourceppi/ Endpoint Request Requires The Following POST Inputs
* ‘api-token’ – posted in Header
* ‘api-secret’ – posted in Header
* ‘vin_chassis’ = the vehicle’s VIN or chassis number. If submitted this will first be used to create the crowdsourced analysis. If the it cannot be used or it is not submitted the ‘marque’, ‘model_key’ and ‘year’ as provided will be used – Optional – posted in Body
* ‘marque’ = the vehicle’s marque, make or brand e.g. BMW – Required – posted in Body
* ‘model_key_1’ = the vehicle’s model e.g. X3 – Required – posted in Body
* ‘model_key_2’ = the vehicle’s submodel or other descriptor e.g. 3.0si – Optional – posted in Body
* ‘year’ = the vehicle’s model year e.g. 2008 – Optional – posted in Body
* ‘response_format’ = designating that the response be in plain text or html – Required – posted in Body
– ‘unified’ = response in HTML with text in a single block
– ‘partitioned’ = response in HTML with text in three blocks
* ‘vehicle_description’ = the content to be analyzed – Required – posted in Body
– submissions must be in JSON format
– submissions are truncated at 10,000 characters for processing

The /crowdsourceppi Endpoint Response Parameters Are The Following
* ‘status’ = see codes below
* ‘message’ = see codes below
* ‘vin_chassis’ = the submitted VIN or chassis number – if submitted
* ‘marque’ = the submitted marque, make or brand
* ‘model_key_1’ = the submitted vehicle’s model
* ‘model_key_2’ = the submitted VIN or chassis number – if submitted
* ‘year’ = the submitted model year – if submitted
* ‘contributors’ = the number of individual crowd comments used to generate the analysis
* ‘observations’ = the number of comparable vehicles used to generate the analysis
* ‘unified’ = three sections ( evaluation+summary+rating) in one response parameter – request ‘unified’
* ‘evaluation’ = Evaluation of This Vehicle – request ‘partitioned’
* ‘summary’ = Summary Assessment of This Vehicle – request ‘partitioned’
* ‘rating’ = Rating of This Vehicle – request ‘partitioned’

The /crowdsourceppi/ Endpoint Response Codes Are The Following
* 200 = “request success”
* 400 = “syntax failure” => bad request syntax
* 400 = “marque required” => no marque submitted
* 400 = “model_key_1 required” => no model_key-1 submitted
* 400 = “response_format required” => no response_format submitted
* 400 = “response_format invalid’ => response_format submitted not recognized
* 400 = “vehicle_description required” => no vehicle_description submitted
* 400 = “no report available marque” => marque not found in marque field search when marque is used
* 400 = “no report available model_key_1” => model_key_1 not found in description field search when model_key_1 is used
* 401 = “invalid credentials” => unrecognized API Token and/or Secret
* 403 = “forbidden” => not authorized to request endpoint
* 413 = “payload too large” => 200k character limit exceeded
* 429 = “exceeded rate limit” => exceeded per second, per day, per month or other limits
* 500 = “server error” => internal server or other error

/crowdsourceppi/ Endpoint Pricing
– Contact us regarding your use case and volume needs.

For support on using our API contact us.