API Documentation General

Application Programming Interface

API General Documentation

HOW OUR API WORKS

The SC Sage API is managed through RapidAPI. RapidAPI is a part of Nokia. You must have a RapidAPI account to access our API.

We do not allow public API access. All of our access is private and requires invitation to gain access. Invitation is sent through RapidAPI.

API access requires agreeing to our API Terms of Service.

PRICING AND RATE LIMITS

All API pricing and rate limits are customized to the client commitment level.

For purposes of pricing and rate limiting our endpoints are grouped into ‘API’. Each API has pricing and rate limits that apply to all of the endpoints in the group as a group.

ACCESSING OUR API

The following steps are required to access our API endpoint groups.

Sign up with RapidAPI as an Organization.
Create a Team within the Organization.
Provide us with the Organization and Team names.
Accept invitations to your Team from SC Sage to the development Test Bed and your custom API Plans in order to access the API/endpoints contracted for.
Prior to the start of testing we will provide you with a SC Sage server side API Token and API Secret. These must be submitted in the header of each endpoint request.

This article may prove helpful to navigating RapidAPI. Note that SC Sage does not provide public APIs. Our API’s cannot be accessed without permission.

AUTHENTICATION

We authenticate on the server side using a simple API key token and password secret.

Only we can generate and provide an API token and secret. A user can only have a single valid API token and secret per account.

CACHING OF PROCESSED DATA AND CHART LINKS

We generally do not allow for the saving or caching of Processed Data responses, except for Chart Links, which provisions may change from time to time, with or without notice.

We allow caching of Chart Link responses for a period of up to 24 hours from the response header ‘Date’. At the expiration of the 24 hour period the Chart Link must be deleted from the client side server and a new API request made.

Because we update our data daily, cached Processed Data is stale within 24 hours. Therefore, we delete Chart Links from the server after 24 hours from the response header ‘Date’. As a result cached Chart Links should be deleted and replaced prior to the expiration of the 24 hour period.

VIN PRECHECKING

The VIN is an important parameter for many of our API endpoints as the VIN is used define the specification for the Processed Data and Chart Links. If a VIN is supported by SC Sage, and it is not present in our database at the time of an API request, we will add the VIN to the database at no charge. If a VIN is not supported by SC Sage or is not a valid VIN, the VIN will be rejected, which may result in charges.

For this reason, we do not charge for pre checking a VIN. Submitting a VIN check request allows for a VIN to be confirmed as in the database, or to be added to the database, or to fail as either invalid or not supported. If a VIN fails it should not be used in any other API endpoint requests as this will result in an error which may incur charges.

API ENDPOINT GROUPS AND API PARALLELS

Many of our endpoints in whole or in part replicate applications and charts which are available to paid subscribers of SC Sage.

The following are the API, the included endpoints and their parallel SC Sage apps and charts.

API Name

VIN Check
Vehicle Specification
Market Extended Data
Market Advanced Data
Regression Price Models
Sage Price App
Median Absolute Deviation
Distribution Range Limits
Sage Range App
Sage Rank App
Historical Statistics Single Date
Historical Statistics Multiple Dates

Endpoint Name

VIN Check
Vehicle Description
Market Basic Data
Market Extended Data
Market Price Basic Timeline
Market Advanced Data
Market Price Enhanced Timeline Dealer
Market Price Enhanced Timeline Consumer
LN Mileage Price
Normal Mileage Price
Core Mileage Value
Market Inventory Median Absolute Deviation Price
Market Inventory Median Absolute Deviation Mileage
Market Median Distribution Raw Price
Market Median Distribution Raw Mileage
Median Absolute Deviation Raw Range Locations Vehicle
Median Absolute Deviation Raw Price and Miles Rank
Historical Market Inventory Central Tendency Data
Historical Market Inventory Central Tendency Period Data

Parallel App/Chart

ENDPOINT OVERVIEW

The following are our endpoints and their descriptions.

API - ENDPOINTS

Endpoint 1 – VIN Check
Search the database to verify if a submitted VIN is present.
Endpoint 2 – Vehicle Description
Returns available basic description information for a submitted VIN.
Endpoint 3 – Market Basic Data
Returns average price and mileage, statistics for the make, model, submodel, body and year indicated by the submitted VIN.
Endpoint 4 – Market Extended Data
Returns market average and median, price and mileage, and high and low price and inventory count statistics for the make, model, submodel, body and year indicated by the submitted VIN.
Endpoint 5 – Market Advanced Data
Returns market average and median, price and mileage, high and low price, high and low mileage and inventory count statistics for the make, model, submodel, body indicated by the submitted VIN, and the year parameter for ‘all’ years or the ‘exact’ year indicated by the submitted VIN, and the transmission parameter for ‘all’ transmissions or the ‘exact’ transmission indicated by the submitted VIN.
Endpoint 6 – Market Basic Timeline
Primarily for use in an iframe, this returns a URL for the Market Price Basic Timeline Chart in a blank SC Sage web page for the make, model, submodel, body indicated by the submitted VIN. The timeline parameter can be in months ‘3’ or ‘6’ or ‘12’ or ‘24’.
Endpoint 7 – Market Enhanced Timeline Dealer
Primarily for use in an iframe, this returns a URL for the Market Price Enhanced Timeline Chart in a blank SC Sage web page for the make, model, submodel, body indicated by the submitted VIN. The timeline parameter can be in months ‘3’ or ‘6’ or ‘12’ or ‘24’. The chart’s tooltip includes ‘Days to Date’ and ‘Market Inventory’ at each observed date in the chart.
Endpoint 8 –Market Enhanced Timeline Consumer
Primarily for use in an iframe, this returns a URL for the Market Price Enhanced Timeline Chart in a blank SC Sage web page for the make, model, submodel, body indicated by the submitted VIN. The timeline parameter can be in months ‘3’ or ‘6’ or ‘12’ or ‘24’. The chart’s tooltip does not include ‘Days to Date’ and ‘Market Inventory’ at each observed date in the chart.
Endpoint 9 – LN Mileage Price
Returns a current market price estimate for a vehicle based upon the vehicle’s actual mileage. And the theoretical percentage of the vehicle’s value which can be explained solely by mileage. These are calculated using logarithmic statistical modelling of price and miles. The estimate is generated using the current market inventory of vehicles matching the vehicle indicated by the submitted VIN. It combines all transmissions and model years. In some cases it combines bodies to maintain statistical significance when there are small market inventories – follow this link to view exceptions to the general body treatment.
Endpoint 10 – Normal Mileage Price
Returns a current market price estimate for a vehicle based upon the vehicle’s actual mileage. And the theoretical percentage of the vehicle’s value which can be explained solely by mileage. These are calculated using normal statistical modelling of price and miles. The estimate is generated using the current market inventory of vehicles matching the vehicle indicated by the submitted VIN. It combines all transmissions and model years. In some cases it combines bodies to maintain statistical significance when there are small market inventories – follow this link to view exceptions to the general body treatment.
Endpoint 11 – Core Mileage Value
Returns robust mileage based price estimates using two distinct models of the current market inventory. The ‘Linear’ best fit model estimates a vehicle’s price as function of mileage using a best fit line. The ‘0 Rank’ model isolates the distributions of each of price and mileage and then postulates that where mileage fits into the market inventory’s mileage distribution should define where price fits into the market inventory’s price distribution. The ‘0 Rank’ estimate is the price where price and mileage are in equilibrium. They combine all transmissions and model years. In some cases they combine bodies to maintain statistical significance when there are small market inventories – view exceptions to the general body treatment.
Endpoint 12 – Market Inventory Median Absolute Deviation Price
Returns the median absolute deviation of the market price using price data from the current market inventory of vehicles matching the vehicle indicated by the submitted VIN. Both raw and scaled (normalized) values are generated. It combines all transmissions and model years. In some cases it combines bodies to maintain statistical significance when there are small market inventories – follow this link to view exceptions to the general body treatment.
Endpoint 13 – Market Inventory Median Absolute Deviation Mileage
Returns the median absolute deviation of the market mileage using mileage data from the current market inventory of vehicles matching the vehicle indicated by the submitted VIN. Both raw and scaled (normalized) values are generated. It combines all transmissions and model years. In some cases it combines bodies to maintain statistical significance when there are small market inventories – follow this link to view exceptions to the general body treatment.
Endpoint 14 – Market Median Distribution Raw Price
Returns the normal distribution range limits of the median absolute deviation of price for the current market inventory of vehicles matching the vehicle indicated by the submitted VIN, using raw values. Negative values return 0. It combines all transmissions and model years. In some cases it combines bodies to maintain statistical significance when there are small market inventories – follow this link to view exceptions to the general body treatment.
Endpoint 15 – Market Median Distribution Raw Mileage
Returns the normal distribution range limits of the median absolute deviation of mileage for the current market inventory of vehicles matching the vehicle indicated by the submitted VIN, using raw values. Negative values return 0. It combines all transmissions and model years. In some cases it combines bodies to maintain statistical significance when there are small market inventories – follow this link to view exceptions to the general body treatment.
Endpoint 16 – Median Absolute Deviation Raw Range Locations Vehicle
Returns the median absolute deviation range locations for a vehicle using the current market inventory of vehicles matching the vehicle indicated by the submitted VIN and the submitted price and mileage, using raw values. For both price and mileage, the response includes the numerical deviation range of the values submitted (deviations above or below the median) and a range location market interpretation. It combines all transmissions and model years. In some cases it combines bodies to maintain statistical significance when there are small market inventories – view exceptions to the general body treatment.
Endpoint 17 – Median Absolute Deviation Raw Price and Miles Rank
Returns a Venn concept value ranking of the vehicle based upon a combination of price and mileage median absolute deviation using the current market inventory of vehicles matching the vehicle indicated by the submitted VIN and the submitted price and mileage, using raw values. The response includes the numerical value rank and a value rank market interpretation. It combines all transmissions and model years. In some cases it combines bodies to maintain statistical significance when there are small market inventories – view exceptions to the general body treatment.
Endpoint 18 – Historical Market Inventory Central Tendency Data
Returns for the requested number of days back the market inventory daily historical average and median prices and mileages, and high and low prices and mileages, and the market total and priced counts, of vehicles matching the vehicle indicated by the submitted VIN. It combines all transmissions and model years. There are no combined bodies.
Endpoint 19 – Historical Market Inventory Central Tendency Period Data
Returns for the requested period days back (including today’s date) the market inventory historical average and median prices and mileages and the current average and median prices and mileages. It combines all transmissions and model years. There are no combined bodies.