Skip to main content

Anatomy of an error (RFC 9457)

Errors are returned with Content-Type: application/problem+json and exactly these fields:

{
"type": "https://api.orbitum.io/problems/CEX_NO_STOCK",
"title": "Insufficient ORBIS stock to reserve",
"status": 400,
"code": "CEX_NO_STOCK",
"detail": "No ORBIS available on the CEX stock Safe",
"instance": "/api/v1/cex/orders",
"requestId": "req_8f3c1a"
}
FieldUse
codeStable machine identifier — branch on this.
typeProblem-type URI: https://api.orbitum.io/problems/{code}.
title / detailHuman text — for logs only; may change; never render verbatim.
statusHTTP status.
instanceThe request path.
requestIdCorrelation id (also the X-Request-Id header).

There is no errors[] array.