Kadrin Docs Kadrin Batch

Errors and warnings

When something goes wrong, the answer says what happened, that you weren't charged, and what to do next. Failed requests, and places that fail, never cost anything.

An error comes back with an HTTP status (a standard number for the kind of problem, such as 422) and a body like this one. When one place in a request fails, the others still come back, and the failed place carries the same kind of error.

{
  "type": "https://docs.kadrindata.com/errors#invalid_geometry",
  "title": "We couldn't read a shape",
  "status": 422,
  "code": "invalid_geometry",
  "detail": "We couldn't read the shape for \"store-12\" because its outline crosses itself. You weren't charged. Fix the outline and try again.",
  "area_id": "store-12",
  "request_id": "req_7c1e9a2b40d64f1f8a3e"
}

Send the request_id when you ask us about a problem. The fields are described under Problem.

Error codes

invalid_request · Something in the request needs fixing

Something in the request needs fixing, such as broken JSON, no places, more than 100 places, or an option we don't recognize. The detail names it.

invalid_geometry · We couldn't read a shape

We couldn't read a shape, for example because its outline crosses itself.

unknown_topic · We don't recognize that topic

We don't recognize that topic or measure ID. Check the catalog.

unknown_variable · We don't recognize that measure

We don't recognize that topic or measure ID. Check the catalog.

topic_unavailable · That topic isn't available yet

That topic isn't available yet.

invalid_key · The API key is missing or wrong

The API key is missing or wrong.

insufficient_credits · Not enough credits

Not enough credits, or the cost is over your Kadrin-Max-Credits limit.

scope_denied

Your key isn't allowed to do this.

geometry_too_large · A shape is too large

A shape is bigger than the limit.

unavailable_combination · That isn't available here

That measure isn't available for that kind of area or those years.

rate_limited · Too many requests

Too many requests too quickly. Wait a moment and try again.

routing_unavailable · We can't draw drive-time areas right now

We can't draw drive-time areas right now. Try again shortly.

not_found · There's nothing with that ID

There's nothing with that ID.

internal_error · Something broke on our side

Something broke on our side. Try again, and contact support with the request_id if it keeps happening.

address_not_found · We couldn't find an address

In a /jobs file, we couldn't find a row's address. Check it for typos, or give lat and lon instead.

Warnings

A warning comes with a number that you can use, but should know something about first. Each has a code, the measure it's about, and a message in plain words.

high_cv

Less reliable, because few households were surveyed here. Treat it as a rough guide.

coarser_resolution

Only published for larger areas, such as counties, so it's worked out from them and is less precise for your shape.

partial_coverage

Data is missing for part of your shape or for some years (for building permits and oil and gas wells, coverage says how much is there).

suppressed

The source withheld this number, usually to protect people's privacy.

approximate_moe

The margin of error comes from a standard shortcut formula, so treat it as close rather than exact.

top_coded

The middle value is above the highest amount the source reports separately, so the true median is this number or more (for example, $250,000 or more).

bottom_coded

The middle value is below the lowest amount the source reports separately, so the true median is this number or less.

method_disagreement

This number depends heavily on where people live inside the areas your shape cuts through, so treat it as approximate.

no_base

There were none at the start of the period (such as no jobs in 2018), so there's no percent change.

no_roads

There are no major roads in the area, so there's no number.

estimated_traffic

This road's traffic wasn't counted this year, or its state doesn't say when it was, so it's the state's estimate from an earlier count.