API reference

Base URL, auth, errors, and headers. Endpoints below are generated from the OpenAPI spec.

Base URL

https://api.farofinance.app

Every request needs a bearer token:

Authorization: Bearer <your-key>

Requests without a valid key get a 401 with the standard error envelope.

Header	Meaning
X-Request-ID	Unique id for the request — quote it in bug reports.
X-Faro-Cache	`hit` or `miss` — whether the verdict was served from cache.

Every non-2xx response is the same envelope — never a leaked stack trace:

{
  "error": "unauthorized",
  "message": "Invalid API key.",
  "request_id": "b1946ac92492d2347c6235b4d2611184"
}

Status	error	When
401	unauthorized	Missing or invalid API key.
422	invalid_request	Request body failed validation.
429	rate_limited	Too many requests — slow down.
500	internal_error	Something went wrong on our side.

The full request and response schemas for each endpoint are generated from the OpenAPI spec and listed below.

Loading API reference…