Skip to content

Errors

Errors

How the API reports problems, and what each error code means.

Every error is a JSON body of type application/problem+json, as defined by RFC 9457. It has these members:

Member What it holds
code The error code. Stable within /v1/. Branch on this.
type A link to the page for this code, on this site.
title A short summary of the code, the same every time.
status The HTTP status, repeated.
detail What went wrong this time, with the actual values. Prose: never parse it.
instance Names this request. Quote it when you contact us.
errors Validation errors only: one entry per problem, each with code, detail and a JSON pointer to the field.

Every error response also carries X-Request-Id and the RateLimit-* headers, like a success.

A 4xx status means the request needs to change; a 5xx status means the problem is on our side. Errors from the network in front of the service, such as a timeout, can arrive without a problem body. Handle those by their status.

A holding that cannot be scored is not an error: it is excluded, and the response says why in resolved_holdings.

Code Status Meaning
INVALID_REQUEST 400 The body is empty or not valid JSON.
INVALID_API_KEY 401 The API key is missing, malformed or unknown.
TIER_NOT_ENTITLED 403 The key is valid, but its plan does not include this endpoint.
NOT_FOUND 404 No endpoint exists at this path.
METHOD_NOT_ALLOWED 405 The path exists, but not for this HTTP method.
UNSUPPORTED_MEDIA_TYPE 415 The request does not declare a JSON body.
EMPTY_PORTFOLIO 422 The portfolio has no holdings.
INSUFFICIENT_COVERAGE 422 Too little of the portfolio could be scored.
INVALID_WEIGHTS 422 A weight is out of range, the weights do not sum to 1, or an identifier appears twice.
SCHEMA_VIOLATION 422 The body is valid JSON, but does not have the expected shape.
TOO_MANY_HOLDINGS 422 The portfolio has more holdings than allowed.
UNSUPPORTED_CURRENCY 422 The reporting currency is not supported.
UNSUPPORTED_IDENTIFIER_TYPE 422 The identifier type is valid, but not enabled yet.
RATE_LIMIT_EXCEEDED 429 This key has sent more requests than its limit allows.
INTERNAL_ERROR 500 Something went wrong on our side.
MARKET_DATA_UNAVAILABLE 503 Market data could not be loaded for a moment.