API error codes

Every endpoint under /api/ reports failures as RFC 9457 application/problem+json. The response carries type, title, status and detail, plus a hint member where a resolution step exists. The type URL is one of the links below.

This vocabulary is closed: there are seven codes and no per-endpoint codes. Branch on the code, and read detail for the specifics. Both detail and hint are English-only — they are written for machine consumers, not for display to a person.

Every path the API serves is listed in its OpenAPI document.

invalid-parameterInvalid parameter · HTTP 400: A query or path parameter was present but its value is not one this endpoint accepts. The detail names the parameter and the accepted values. Correct the value and retry; retrying unchanged will fail identically.; https://www.stackerscan.com/errors/invalid-parameter
missing-parameterMissing parameter · HTTP 400: A required query or path parameter was not supplied. The detail names it. Supply the parameter and retry.; https://www.stackerscan.com/errors/missing-parameter
unauthorizedUnauthorized · HTTP 401: The request addressed a resource that belongs to a signed-in account. The public read-only endpoints described in the OpenAPI document never return this; if you received it, the path you called is not part of the public surface.; https://www.stackerscan.com/errors/unauthorized
not-foundNot found · HTTP 404: No resource exists at the requested path, or the identifier in the path matches nothing. For an unknown path, the OpenAPI document lists every path this API serves.; https://www.stackerscan.com/errors/not-found
rate-limitedRate limited · HTTP 429: Too many requests in too short a window, or a usage quota is exhausted. Back off and retry later.; https://www.stackerscan.com/errors/rate-limited
upstream-unavailableUpstream unavailable · HTTP 502: A service this endpoint depends on failed or timed out. The request itself was well formed, so retrying it later may succeed.; https://www.stackerscan.com/errors/upstream-unavailable
internal-errorInternal error · HTTP 500: The request failed for a reason that is not the caller's fault and is not attributable to a named upstream. Retrying may succeed.; https://www.stackerscan.com/errors/internal-error

API error codes

Every path the API serves is listed in its OpenAPI document.

invalid-parameterInvalid parameter · HTTP 400

A query or path parameter was present but its value is not one this endpoint accepts. The detail names the parameter and the accepted values. Correct the value and retry; retrying unchanged will fail identically.

https://www.stackerscan.com/errors/invalid-parameter

missing-parameterMissing parameter · HTTP 400

A required query or path parameter was not supplied. The detail names it. Supply the parameter and retry.

https://www.stackerscan.com/errors/missing-parameter

unauthorizedUnauthorized · HTTP 401

The request addressed a resource that belongs to a signed-in account. The public read-only endpoints described in the OpenAPI document never return this; if you received it, the path you called is not part of the public surface.

https://www.stackerscan.com/errors/unauthorized

not-foundNot found · HTTP 404

No resource exists at the requested path, or the identifier in the path matches nothing. For an unknown path, the OpenAPI document lists every path this API serves.

https://www.stackerscan.com/errors/not-found

rate-limitedRate limited · HTTP 429

Too many requests in too short a window, or a usage quota is exhausted. Back off and retry later.

https://www.stackerscan.com/errors/rate-limited

upstream-unavailableUpstream unavailable · HTTP 502

A service this endpoint depends on failed or timed out. The request itself was well formed, so retrying it later may succeed.

https://www.stackerscan.com/errors/upstream-unavailable

internal-errorInternal error · HTTP 500

The request failed for a reason that is not the caller's fault and is not attributable to a named upstream. Retrying may succeed.

https://www.stackerscan.com/errors/internal-error