Payments
A loan payment on the advertised (or given) price, with taxes and fees for the ZIP when one is given, and a lease payment when the manufacturer publishes a money factor and residual for the model. Every figure carries its terms; none is an offer of credit.
GEThttps://api.motorsdynamic.com/api/v2/payments/{vin}
Plan and price
| Plan | Access | Price |
|---|---|---|
| Free | No | not included |
| Growth | Yes | $0.005 per call |
| Scale | Yes | $0.003 per call |
| Enterprise | Yes | contract |
A call is billed when it answers 2xx. See pricing.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
vin | path | string | yes | 17-character VIN (case-insensitive). |
price | query | number | no | Price to compute on. Default: the dealer's advertised price. |
zip | query | string | no | 5-digit ZIP code of a US state or DC. |
term | query | integer | no | Loan term in months. |
down | query | number | no | Cash down payment. |
tradeIn | query | number | no | Trade-in value. |
rebate | query | number | no | Manufacturer rebate applied to the price. |
docFee | query | number | no | Dealer documentation fee. Default: the fee crawled with the car's listing. |
creditScore | query | integer | no | Credit score; picks the credit tier. |
apr | query | number | no | APR in percent. Default: the market estimate for the credit tier. |
condition | query | new or used | no | Which rate table to read. Default: the listing's condition. |
Example request
curl "https://api.motorsdynamic.com/api/v2/payments/1HGCM82633A004352" \
-H "x-api-key: $MD_API_KEY"const res = await fetch("https://api.motorsdynamic.com/api/v2/payments/1HGCM82633A004352", {
headers: { "x-api-key": process.env.MD_API_KEY },
});
if (!res.ok) throw new Error(`${res.status} ${(await res.json()).error}`);
const data = await res.json();
console.log(data);import os, requests
res = requests.get(
"https://api.motorsdynamic.com/api/v2/payments/1HGCM82633A004352",
headers={"x-api-key": os.environ["MD_API_KEY"]},
timeout=10,
)
res.raise_for_status()
print(res.json())Response fields
| Field | Type | Description |
|---|---|---|
meta | object | |
data | object | |
data.vin | string | |
data.vehicle | object | |
data.vehicle.year | integer or null | |
data.vehicle.make | string or null | |
data.vehicle.model | string or null | |
data.vehicle.trim | string or null | |
data.zip | string or null | |
data.state | string or null | |
data.price | object | |
data.price.amount | number | |
data.price.currency | string | |
data.price.source | query or dealer_advertised | |
data.loan | object | |
data.loan.monthly_payment | number | |
data.loan.amount_financed | number | |
data.loan.total_interest | number | |
data.loan.total_of_payments | number | |
data.loan.estimate | true | |
data.loan.terms | object | |
data.taxes_and_fees | object or null | |
data.lease | object or null | |
data.lease_unavailable_reason | no_manufacturer_lease_offer or no_money_factor_published or msrp_unknown or offer_terms_do_not_fit or null | |
data.disclosure | string |
Errors
| Status | Code | When |
|---|---|---|
| 400 | invalid_parameter | A parameter is missing or malformed. The message names it. |
| 401 | invalid_api_key | The key is missing, revoked or mistyped. |
| 402 | plan_required | The endpoint is on a higher plan. The body names the plan and links to the upgrade. |
| 403 | not_entitled | The key may not read this dealer or source. |
| 404 | not_found | Nothing matches the identifier in the path. |
| 429 | rate_limited or quota_exceeded | Slow down (see Retry-After), or the Free monthly calls are used up. |
| 503 | error | See the message. |
| 504 | query_timeout | The query passed its 4 second budget. Narrow the filters. Not billed. |
Every error has the same body. Full list: errors.