MileCheck API › Reference

How does the MileCheck API handle version changes?

The version is in the URL. Inside a version we add things and do not take them away. If we must remove or change something, you hear first.

Inside v1 (no notice needed)

New endpoints.
New optional request parameters.
New fields in a response. Code that reads JSON should ignore fields it does not know.
New values in fields that are open sets, such as event types, source names and error codes. Handle an unknown value as "other".
Faster or slower feed refresh where a state changes how it publishes.
Corrections to wrong data. See data and accuracy.

Breaking changes (a new version, or notice)

Removing or renaming an endpoint, parameter or field.
Changing the type or meaning of a field.
Making an optional parameter required.
Changing a status code for the same situation.

Breaking changes ship as /v2, not inside /v1.

Notice

What	Notice	How you hear
Deprecating a field or endpoint inside v1	90 days before it is removed	Email to the address on the key, a line in the changelog, and `Deprecation` and `Sunset` headers on affected responses
Retiring a whole version	12 months after the next version is announced	The same three
Security or legal removal of a source	As much as we can give. A state can withdraw a feed.	Email, and `state_not_available` on the affected state

A source can also go away because the agency that publishes it withdraws it. We keep a per-source switch for that. When it happens, only that state or source is affected, and the response says so.

Our mission

Become the trusted source for road information across North America, from today’s closures to next season’s roadwork.

What we do

We put every state’s Department of Transportation data in one place, on your phone, in your car and in your browser.

Our values

No ads in the app. Our website is free to use, so it has a clearly marked sponsor slot to help pay for it, without pop-ups.
Road data, not your data. We collect road data from state DOTs, not data about you. You don’t need an account, your mile marker is calculated on your phone, your trip history stays there, and we never sell your data.
Only what’s needed. Weather sends your approximate location to the National Weather Service, route planning sends your location and destination to Google, and wildfire alerts send a location rounded to about 7 miles only if you turn them on. Sentry receives anonymous crash reports, we count feature use without location or identity, and Apple or Google handles subscriptions.
Built for real roads. Nearly every feature exists because someone on a real road asked for it.

More in our privacy policy and our story.