Error reference

Every error uses a closed code list, a human-readable fix, and a docs_url pointing at this page. The codes below are the same enum the API returns, including the non-affiliation notice on every error body.

INVALID_INPUT

The body or query does not match the tool schema. Compare it with /openapi.json.

PROGRAM_OUT_OF_SCOPE

That program is stored as out of scope. Send include_out_of_scope true, or request an in-scope program.

MISSING_REQUIRED_FIELD

A required field is missing. The OpenAPI schema lists required fields.

UNKNOWN_FIELD

The request includes a field the schema does not allow.

VALUE_OUT_OF_RANGE

A number is outside the schema minimum or maximum.

UNKNOWN_PROGRAM

The program slug is not in the rules database.

UNKNOWN_METRIC

The metric name is not one the calculators accept.

UNKNOWN_RULE_ID

The rule_id is not in the published rules.

INVALID_DATE

A date is not a valid calendar date in YYYY-MM-DD form.

DATE_RANGE_INVALID

until is earlier than since.

PAYLOAD_TOO_LARGE

The body is over 16 KB.

RATE_LIMITED

The rate limit was exceeded. Wait for the Retry-After interval.

INVALID_API_KEY

The API key does not match a stored hash. Anonymous access is available if you remove the key.

NO_RULES_AVAILABLE

No approved rules are loaded.

UNSUPPORTED_API_VERSION

Only /v1 is supported.

NOT_FOUND

The path or tool name does not exist.

METHOD_NOT_ALLOWED

Use the method named in the Allow header. Calculation tools accept POST only.

INTERNAL_ERROR

The server failed unexpectedly. Retry once.

SERVICE_UNAVAILABLE

The rate limiter or rules bundle is unavailable. Retry shortly.