Query extractions | SpreadSpace

{
  "borrower_id": "9f8e7d6c5b4a3210a1b2c3d4",
  "items": [
    {
      "section": "Income",
      "group_name": null,
      "item_name": "Gross receipts or sales",
      "standard_category": "revenue",
      "amount": 2450000,
      "period": "2023",
      "fiscal_year": 2023,
      "aging_bucket": null
    },
    {
      "section": "Expenses",
      "group_name": "Operating expenses",
      "item_name": "Rent",
      "standard_category": "rent_expense",
      "amount": 96000,
      "period": "2023",
      "fiscal_year": 2023,
      "aging_bucket": null
    },
    {
      "section": "Expenses",
      "group_name": "Operating expenses",
      "item_name": "Depreciation",
      "standard_category": "depreciation_expense",
      "amount": 88400,
      "period": "2023",
      "fiscal_year": 2023,
      "aging_bucket": null
    }
  ],
  "total": 2634400
}

Searches line items across all of the borrower’s extracted documents and returns them as one flat list. Filter with category, section, year, search (case-insensitive item name match), documentId, and loanId. Every filter is optional, and the ones you send must all match. Returns at most 500 line items, with a total that sums the returned amounts.

Searches line items across all of the borrower's extracted documents and returns them as one flat list. Filter with `category`, `section`, `year`, `search` (case-insensitive item name match), `documentId`, and `loanId`. Every filter is optional, and the ones you send must all match. Returns at most 500 line items, with a `total` that sums the returned amounts.

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Bearer token. Use `ss_live_…` for live data or `ss_test_…` for the sandbox (test mode). See [Authentication](https://docs.spreadspace.app/api/authentication).

Path parameters

borrowerIdstringRequired

The borrower's id.

Query parameters

categorystringOptional

Filter to one standard category.

sectionstringOptional

Filter to one statement section.

yearintegerOptional

Filter to one fiscal year.

searchstringOptional

Case-insensitive match on the line item name.

documentIdstringOptional

Filter to one document.

loanIdstringOptional

Narrow the query to one loan.

Response headers

X-Request-IDstringOptional

Correlation ID for this request. Quote it in support tickets.

SpreadSpace-VersionstringOptional

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-07-19.

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.

Request budget of the endpoint's rate-limit policy per 60-second sliding window. See [Rate limits](https://docs.spreadspace.app/api/rate-limits).

RateLimit-Remaininginteger

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.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error