Get statements workbook
Returns a short-lived link to the loan’s statements workbook: every statement line with its derivation, then every cash flow measure. Answers 200 when a workbook is ready, with stale true while a newer one is built for data that changed; 202 on the first request after the data changed, to poll after Retry-After; and 503 render_failed when the latest build failed.
Requires the spreads:read scope. Rate limit: 200 requests per minute per key (the api lane).
Authentication
Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.
Path parameters
Headers
Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.
Response headers
The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.
Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.
Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.
Seconds until a guaranteed-fresh window.
The active policy in limit;w=window-seconds form.