> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.spreadspace.app/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.spreadspace.app/_mcp/server. # List all equity statements GET https://api.spreadspace.app/api/borrowers/{borrower_id}/extractions/equity-statements Lists every usable equity statement on the borrower's file. Duplicates and failed extractions are left out, and you can pass `loan_id` to narrow the list to one loan. Requires the `extractions:read` scope. Rate limit: 200 requests per minute per key (the `api` lane). Reference: https://docs.spreadspace.app/api/api-reference/equity-statements/get-equity-statements ## Authentication - `Authorization` header (bearer token, required) — Bearer token. Use `ss_live_…` for live data or `ss_test_…` for the sandbox (test mode). See [Authentication](https://docs.spreadspace.app/api/authentication). ## Request ### Path parameters - `borrower_id` (string, required) — The borrower's id. ### Query parameters - `loan_id` (string, optional) — Narrow the list to one loan. ### Headers - `SpreadSpace-Version` (string, optional) — Pin the API version, e.g. `2026-07-19`. Omit to get the latest. See [Versioning](https://docs.spreadspace.app/api/versioning). ## Response ### 200 OK - `borrower_id` (string, required) — The borrower the documents belong to. - `statements` (list of EquityStatementReportDataListItem, required) — One row per document. ## Errors ### 400 Bad Request Error Bad request: validation failed, the cursor is malformed, or the API version is unknown. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 401 Unauthorized Error Unauthorized: the bearer token or API key is missing or invalid. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 402 Payment Required Error Payment required: the standard error envelope with `type` `subscription_required` when the workspace has no active or trialing subscription, or `billing_required` where a plan entitlement applies. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 403 Forbidden Error Forbidden: authentication succeeded but the caller is not permitted to perform this action, for example an API key missing the required scope, an embed session reaching a loan it was not minted for, or a feature outside the workspace's plan. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 404 Not Found Error Not found: the resource does not exist or is not visible to the calling tenant. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 429 Too Many Requests Error Too many requests: the rate limit was hit, or an idempotency-key replay is still in progress. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ### 500 Internal Server Error Internal server error: an unexpected failure. Quote the `request_id` in support tickets. A mutation sent with an `Idempotency-Key` replays this fault under that key rather than re-running; confirm the resource state before resending with a new key. - `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope. ## Types ### EquityStatementReportDataListItem One row of the Equity Statement list: the document's identity and its extracted object. - `extracted_document_id` (string, required) — Identifier of the extracted document. - `document_category` (string, required) — The document category the extraction is stored under. - `report_data` (EquityStatementReportData, required) — The extracted object, in the family's shape. ### ApiErrorBody Inner body of the canonical API error envelope. - `type` (string, required) — Stable error type identifier. Pattern-match on this value, not the human-readable message. - `message` (string, required) — Human-readable error message. Subject to wording changes; do not parse. - `request_id` (string, optional, nullable) — Per-request correlation ID (matches `X-Request-ID` response header). Quote in support tickets. - `details` (map from string to string, optional, nullable) — Structured detail. Some error types populate documented keys in every environment: a version conflict (409) carries `current_version`, the version the resource is actually at, so the client can reload and re-apply. Free-form diagnostic detail beyond those keys appears in development environments only. An `insufficient_credits` 402 carries `balance_usd`, `reserved_usd`, `in_flight_docs`, `incoming_docs` and `per_doc_reservation_usd` as decimal strings. ### EquityStatementReportData A statement of changes in equity: the equity components across as columns, the balances and each period's movements down as rows, with one figure per column. A figure printed as money is a decimal string with two decimals, in dollars, except under a par value column, which keeps its printed figure; a share count is a whole number as text. - `entity` (string, required, nullable) — The reporting entity's name as printed. - `title` (string, required, nullable) — The statement's printed title. - `layout` (enum, required) — How the statement is laid out: `matrix` when the equity components run across as columns and the balances and movements run down as rows; `vertical` when the periods run across as columns. - Allowed values: `matrix`, `vertical` - `period_header` (string, required) — The period wording printed over the statement, such as the years ended; empty when the statement prints none. - `cpa_engagement` (integer, required) — The accountant's level of assurance: 0 unaudited, 1 compiled, 2 reviewed, 3 audited. - `cpa_engagement_label` (string, required) — The assurance level in words. - `periods` (list of EquityStatementReportData_EquityPeriod, required) — The periods the statement covers, one entry per period. - `billing_years` (integer, required) — Years of data billed for the statement. - `reporting_unit` (enum, required) — The unit the figures are printed in, such as ones or thousands. - Allowed values: `ones`, `thousands`, `millions`, `billions` - `scale_multiplier` (integer, required) — Scale of the printed figures: 1 for whole dollars, 1000 when the statement is stated in thousands, 1000000 when it is stated in millions. - `unit_exceptions` (list of string, required) — The carve-outs the statement's unit declaration lists, such as share data, which keep their printed figures; empty when it lists none. - `unit_source` (enum, required) — Where the statement states its unit: `printed` when the statement header, a column header or a heading line prints it; `none` when nothing is printed and the figures are whole dollars as printed. - Allowed values: `printed`, `none` - `columns` (list of EquityStatementReportData_EquityColumn, required) — The statement's figure columns in print order. - `total_column` (integer, required, nullable) — Position in `columns`, counting from zero, of the column that prints the total of the components; null when the statement has none. - `rows` (list of EquityStatementReportData_EquityRow, required) — The statement's rows in print order. - `status` (enum, required) — `RECONCILED` when every row's components add to its printed total and every opening balance plus the period's movements equals the closing balance; `FLAGGED` otherwise. - Allowed values: `RECONCILED`, `FLAGGED` - `presentation` (enum, optional) — How the statement is presented: `formal` when it is presented as issued financial statements; `free_form` when it is a report out of the books (accounting software or a spreadsheet). - Allowed values: `formal`, `free_form` - `signals` (list of EquityStatementReportData_StatementSignal, optional) — Each check of the statement that does not hold, in words, when any does not. - `packet` (EquityStatementReportData_PacketProvenance, optional) — Where the statement sat in the financial statement packet it arrived in, when it arrived in one. ### EquityStatementReportData_EquityPeriod One period the statement covers. - `label` (string, required, nullable) — The period as printed, such as a year. - `start` (string, required, nullable) — First day of the period, when the statement states one. - `end` (string, required, nullable) — Last day of the period, when the statement states one. ### EquityStatementReportData_EquityColumn One figure column. - `label` (string, required, nullable) — The column heading as printed. - `group` (string, required, nullable) — The heading printed over a group of columns, such as a class of stock, when the column sits under one. - `kind` (enum, required) — What the column holds: `money` for an equity component in dollars, `total` for the total of the components, `shares` for a share count, `par` for a par value per share as printed, `period` for a period's figures on a vertical statement. - Allowed values: `money`, `total`, `shares`, `par`, `period` ### EquityStatementReportData_EquityRow One printed row. - `kind` (enum, required) — `balance` for a balance at a date, `movement` for a change during a period, `header` for a caption that prints no figures, `note` for a sentence printed among the rows. - Allowed values: `balance`, `movement`, `header`, `note` - `label` (string, required) — The row's caption as printed. - `date` (string, required, nullable) — The date a balance row states, when it states one; null on every other row. - `block` (integer, required, nullable) — The roll-forward the row belongs to, numbered from zero in print order: an opening balance, the period's movements and the closing balance share one number. Null on a row outside every roll-forward. - `opens` (integer, required, nullable) — On a balance row, the number of the roll-forward it opens; null otherwise. - `closes` (integer, required, nullable) — On a balance row, the number of the roll-forward it closes; null otherwise. - `component` (string, required, nullable) — On a vertical statement, the equity component the row belongs to, as its caption prints it; null otherwise. - `values` (list of string, required) — The row's figure per column, in `columns` order; null where the cell is blank. A cell printed as money is a decimal string with exactly two decimals, in dollars, except under a par value column, which keeps its printed figure. A share count is a whole number as text, and a printed dash reads `0`. - `printed` (list of enum, required) — How each cell is printed, in `columns` order: `money`, `shares` for a share count, `dash` for a printed dash, `blank` for an empty cell. - Allowed values: `money`, `dash`, `shares`, `blank` ### EquityStatementReportData_StatementSignal A check of the statement that does not hold, or a note about its reporting period. - `severity` (enum, required) — How much weight the note carries: info or warn. - Allowed values: `info`, `warn` - `code` (enum, required) — The note's identifier. - Allowed values: `coverage_unreadable`, `equity_rollforward_mismatch`, `equity_row_footing_mismatch`, `no_reporting_period`, `year_from_file_metadata`, `year_from_filename`, `year_from_page_image`, `year_matches_print_stamp` - `detail` (string, required) — The note in words. ### EquityStatementReportData_PacketProvenance Where a statement sat in the financial statement packet it arrived in, when it arrived in one. - `section_index` (integer, required) — Position of the statement among the packet's statements, counting from zero. - `pages` (list of integer, required) — First and last page of the statement within the packet, counting from one. - `letter_date` (string, required, nullable) — Date of the accountant's letter that accompanied the packet, when the letter printed one. - `letter_page` (integer, required, nullable) — Page of the packet the accountant's letter is on, when the packet carries one. - `page_list` (list of integer, optional) — Every page of the packet the statement is printed on, counting from one, when they are not one unbroken run; absent otherwise. ## Examples **Response** ```json { "borrower_id": "3f9c2b1e8d7a4c5b9e0f1a2b", "statements": [ { "extracted_document_id": "7a1d4e9c2b3f4a5d8e6c1b0f", "document_category": "equity_statement", "report_data": { "entity": "ACME WIDGET COMPANY, INC.", "title": "STATEMENTS OF STOCKHOLDERS' EQUITY", "layout": "matrix", "period_header": "Years Ended December 31, 2024 and 2023", "cpa_engagement": 0, "cpa_engagement_label": "Unaudited", "periods": [ { "label": "2023", "start": "2023-01-01", "end": "2023-12-31" }, { "label": "2024", "start": "2024-01-01", "end": "2024-12-31" } ], "billing_years": 2, "reporting_unit": "ones", "scale_multiplier": 1, "unit_exceptions": [], "unit_source": "none", "columns": [ { "label": "Common stock", "group": null, "kind": "money" }, { "label": "Additional paid-in capital", "group": null, "kind": "money" }, { "label": "Retained earnings", "group": null, "kind": "money" }, { "label": "Accumulated other comprehensive income", "group": null, "kind": "money" }, { "label": "Total", "group": null, "kind": "total" } ], "total_column": 4, "rows": [ { "kind": "balance", "label": "Balance, December 31, 2022", "date": "2022-12-31", "block": null, "opens": 0, "closes": null, "component": null, "values": [ "1000.00", "100000.00", "500000.00", "10000.00", "611000.00" ], "printed": [ "money", "money", "money", "money", "money" ] }, { "kind": "movement", "label": "Net income", "date": null, "block": 0, "opens": null, "closes": null, "component": null, "values": [ "0", "0", "150000.00", "0", "150000.00" ], "printed": [ "dash", "dash", "money", "dash", "money" ] }, { "kind": "movement", "label": "Other comprehensive loss", "date": null, "block": 0, "opens": null, "closes": null, "component": null, "values": [ "0", "0", "0", "-4000.00", "-4000.00" ], "printed": [ "dash", "dash", "dash", "money", "money" ] }, { "kind": "movement", "label": "Distributions to stockholders", "date": null, "block": 0, "opens": null, "closes": null, "component": null, "values": [ "0", "0", "-50000.00", "0", "-50000.00" ], "printed": [ "dash", "dash", "money", "dash", "money" ] }, { "kind": "balance", "label": "Balance, December 31, 2023", "date": "2023-12-31", "block": null, "opens": 1, "closes": 0, "component": null, "values": [ "1000.00", "100000.00", "600000.00", "6000.00", "707000.00" ], "printed": [ "money", "money", "money", "money", "money" ] }, { "kind": "movement", "label": "Net income", "date": null, "block": 1, "opens": null, "closes": null, "component": null, "values": [ "0", "0", "180000.00", "0", "180000.00" ], "printed": [ "dash", "dash", "money", "dash", "money" ] }, { "kind": "movement", "label": "Other comprehensive income", "date": null, "block": 1, "opens": null, "closes": null, "component": null, "values": [ "0", "0", "0", "2500.00", "2500.00" ], "printed": [ "dash", "dash", "dash", "money", "money" ] }, { "kind": "movement", "label": "Distributions to stockholders", "date": null, "block": 1, "opens": null, "closes": null, "component": null, "values": [ "0", "0", "-80000.00", "0", "-80000.00" ], "printed": [ "dash", "dash", "money", "dash", "money" ] }, { "kind": "balance", "label": "Balance, December 31, 2024", "date": "2024-12-31", "block": null, "opens": null, "closes": 1, "component": null, "values": [ "1000.00", "100000.00", "700000.00", "8500.00", "809500.00" ], "printed": [ "money", "money", "money", "money", "money" ] } ], "status": "RECONCILED" } } ] } ``` **SDK Code** ```python import requests url = "https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/equity-statements" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/equity-statements'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/equity-statements" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/equity-statements") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/equity-statements") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/equity-statements', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/equity-statements"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/equity-statements")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```