Residual by YMMT · ALG Residual API

Input

Pass parameters in the request query string.

URL Parameter	Default	Required	Description
`modelYear`	—	✓	The vehicle model year.
`make`	—	✓	The vehicle manufacturer.
`model`	—	✓	The vehicle model.
`trim`	—	✓	The vehicle trim.
`dataSetId`	`1`	Data set ID is optional	Selects the US data set. May be omitted to use data set 1.
`term`	`36`	Term is optional	The residual term in months.
`effectiveDate`	`2026-11-01`	Effective date is optional	The ALG edition used for the residual calculation.
`condition`	`AVERAGE`	Condition is optional	The vehicle condition. Other supported values are `ROUGH` and `CLEAN`.
`annualMileage`	15000	Annual mileage is optional	The expected distance driven per year.
`initialMileage`	Calculated	Initial mileage is optional	Defaults to zero when the model year is the effective-date year or newer; otherwise calculated from April 1 of the model year through the effective date using standard annual mileage.

Examples

curl -X POST 'https://api.alg.com/product/residual/byYMMT?modelYear=2026&make=HONDA&model=ACCORD&trim=Touring' \
  -H 'Authorization: Bearer YOUR_API_KEY'
curl -X POST 'https://api.alg.com/product/residual/byYMMT?modelYear=2026&make=HONDA&model=ACCORD&trim=Touring&term=48' \
  -H 'Authorization: Bearer YOUR_API_KEY'
curl -X POST 'https://api.alg.com/product/residual/byYMMT?modelYear=2026&make=HONDA&model=ACCORD&trim=Touring&term=60&condition=CLEAN&annualMileage=12000&initialMileage=500' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Output

The response includes the resolved vehicle and every value applied to the residual calculation, including defaults.

Property	Type	Description
`modelYear`	Integer	The vehicle model year.
`make`	String	The vehicle make.
`model`	String	The vehicle model.
`trim`	String	The vehicle trim.
`dataSetId`	Integer	The data set used for the residual calculation.
`term`	Integer	The term in months that was applied. Returns `36` when omitted from the input.
`effectiveDate`	Date	The ALG edition that was applied. Returns the resolved most-recent date when omitted.
`condition`	String	The condition that was applied. Returns `AVERAGE` when omitted.
`annualMileage`	Integer	The annual mileage that was applied, whether supplied or defaulted.
`initialMileage`	Integer	The initial mileage that was applied, whether supplied or calculated.
`mileageUnit`	String	The mileage unit applied to mileage values: `MI` or `KM`.
`value`	Number	The calculated residual value in the market currency: USD for `dataSetId` 1, CAD for 2.
`valuePercent`	Number	The calculated residual percentage as a numeric percentage-point value. For example, `8.49` means 8.49%.

Examples

curl -X POST 'https://api.alg.com/product/residual/byYMMT?modelYear=2026&make=HONDA&model=ACCORD&trim=Touring' \
  -H 'Authorization: Bearer YOUR_API_KEY'
{
  "modelYear": 2026,
  "make": "HONDA",
  "model": "ACCORD",
  "trim": "Touring",
  "dataSetId": 1,
  "term": 36,
  "effectiveDate": "2026-11-01",
  "condition": "AVERAGE",
  "annualMileage": 15000,
  "initialMileage": 0,
  "mileageUnit": "MI",
  "value": 150,
  "valuePercent": 1
}

curl -X POST 'https://api.alg.com/product/residual/byYMMT?modelYear=2026&make=HONDA&model=ACCORD&trim=Touring&term=48' \
  -H 'Authorization: Bearer YOUR_API_KEY'
{
  "modelYear": 2026,
  "make": "HONDA",
  "model": "ACCORD",
  "trim": "Touring",
  "dataSetId": 1,
  "term": 48,
  "effectiveDate": "2026-11-01",
  "condition": "AVERAGE",
  "annualMileage": 15000,
  "initialMileage": 0,
  "mileageUnit": "MI",
  "value": 135,
  "valuePercent": 0.9
}

curl -X POST 'https://api.alg.com/product/residual/byYMMT?modelYear=2026&make=HONDA&model=ACCORD&trim=Touring&term=60&condition=CLEAN&annualMileage=12000&initialMileage=500' \
  -H 'Authorization: Bearer YOUR_API_KEY'
{
  "modelYear": 2026,
  "make": "HONDA",
  "model": "ACCORD",
  "trim": "Touring",
  "dataSetId": 1,
  "term": 60,
  "effectiveDate": "2026-11-01",
  "condition": "CLEAN",
  "annualMileage": 12000,
  "initialMileage": 500,
  "mileageUnit": "MI",
  "value": 145,
  "valuePercent": 1
}

Authentication

Every request must be authenticated with an API key issued to you by ALG, sent as a bearer token.

Header	Value	Description
`Authorization`	`Bearer YOUR_API_KEY`	An API key issued to you by ALG. Tied to your company. Keep it server-side.

Examples

curl -X POST 'https://api.alg.com/product/residual/byYMMT?modelYear=2026&make=HONDA&model=ACCORD&trim=Touring' \
  -H 'Authorization: Bearer YOUR_API_KEY'

curl -X POST 'https://api.alg.com/product/residual/byYMMT?modelYear=2026&make=HONDA&model=ACCORD&trim=Touring'
{
  "errors": [
    {
      "status": 401,
      "code": null,
      "message": "Please provide a Bearer token in the Authorization header"
    }
  ]
}