> This page is for API. > 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 registrant documents GET https://api.spreadspace.app/api/public/registrants/{registrant_id}/documents Lists the store documents a registrant's annual or quarterly sheet reads, each with the fields of the filing it came with: the filings the store extracted and nothing has superseded, of the forms named in `forms`, from `from_year` on. An annual sheet reads the 10-K; a quarterly sheet reads the 10-Q, the 10-K and the 8-K. By filing date, then each filing's documents in order; not paged. Needs a Market research subscription and `markets:read`. Requires the `markets:read` scope. Rate limit: 200 requests per minute per key (the `api` lane). Reference: https://docs.spreadspace.app/api/api-reference/registrants/documents ## 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 - `registrant_id` (string, required) — The registrant's id: its SEC CIK, one to ten digits, with or without its leading zeros. ### Query parameters - `sheet` (string, optional) — The sheet the documents are for: `annual` or `quarterly`; annual when absent. - `forms` (list of string, optional) — The forms to read, one `forms` query parameter per form, among 10-K, 10-Q, 8-K and S-1 in any case, an amendment read with its base form; the sheet's forms when absent. - `from_year` (integer, optional) — The first year to read, 1993 to 2100. Omit for every year the store holds. ### Headers - `SpreadSpace-Version` (string, optional) — Pin the API version, e.g. `2026-10-07`. Omit to get the latest. See [Versioning](https://docs.spreadspace.app/api/versioning). ## Response ### 200 OK - `data` (list of PublicFilingDocumentSummary, required) - `has_more` (boolean, required) - `next_cursor` (string, optional, nullable) ## Errors ### 400 Bad Request Error Bad Request - `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. ### 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 - `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 ### PublicFilingDocumentSummary One of a research company's documents in the public filings store: a statement or a supporting table the company's annual or quarterly sheet reads, with the fields of the filing it came with. - `document_id` (string, required) — The document's id in the store. - `accession` (string, required) — The SEC accession number of the filing the document came with. - `document_category` (string, required) — The document's category, such as balance_sheet, profit_and_loss, cash_flow_statement, debt_schedule or supporting_table. - `filing_form` (string, required) — The filing's form type as filed, such as 10-K, 10-Q, 8-K, S-1 or 10-K/A. - `amendment` (boolean, required) — True when the filing amends an earlier one. - `extractor_version` (string, required) — The version the filing's documents were extracted under. - `created_at` (datetime, required) — When the document was recorded in the store. - `period_start` (date, optional, nullable) — The first day of the period the document covers; null when it states none. - `period_end` (date, optional, nullable) — The period end the document is dated to; null when it states none. - `fiscal_year` (integer, optional, nullable) — The fiscal year the document belongs to; null when unknown. - `basis` (string, optional, nullable) — The statement's basis, such as consolidated; null when unknown. - `title` (string, optional, nullable) — The document's printed title; null when it prints none. - `page_count` (integer, optional, nullable) — How many pages of the filing the document spans; null when unknown. - `filing_date` (date, optional, nullable) — The date the filing was made; null when unknown. - `report_period` (date, optional, nullable) — The period the filing reports on; null when unknown. - `filing_registrant` (string, optional, nullable) — The registrant the filing names on its cover; null when unread. - `entity_stamp_name` (string, optional, nullable) — The entity the document's own pages name; null when they name none. - `entity_split_role` (string, optional, nullable) — The document's role when a filing's statements split across entities; null otherwise. - `extraction_source` (string, optional, nullable) — `xbrl` when the document was read from the filing's XBRL facts; null otherwise. ### ApiErrorBody Inner body of the canonical API error envelope. - `type` (enum, required) — Stable error type identifier, one of the values listed. Pattern-match on this value, not the human-readable message. A later version may add a value; treat one you do not know by its HTTP status. - Allowed values: `billing_required`, `business_email_required`, `conflict`, `counterparty_not_in_plan`, `cursor_expired`, `custom_visual_limit_exceeded`, `doc_too_large`, `embed_not_in_plan`, `embed_origin_not_allowed`, `embed_scope_exceeds_key`, `embed_scope_not_allowed`, `embed_session_binding_mismatch`, `embed_session_not_found`, `embed_token_expired`, `forbidden`, `geometry_plan_denied`, `html_upload_disabled`, `idempotency_in_progress`, `idempotency_request_mismatch`, `idempotency_response_too_large`, `insufficient_credits`, `insufficient_scope`, `internal_error`, `invalid_code`, `invalid_cursor`, `invalid_embed_token`, `invalid_include`, `invalid_limit`, `invalid_request`, `invalid_session_handle`, `invalid_version`, `key_expired`, `key_revoked`, `last_item`, `license_assigned`, `license_holder_has_license`, `license_none_free`, `license_reassign_window`, `licenses_assigned`, `markets_api_required`, `memo_locked`, `memo_not_locked`, `mfa_enrollment_required`, `mode_mismatch`, `not_found`, `payload_too_large`, `payment_failed`, `pii_claim_required`, `rate_limited`, `render_failed`, `request_cancelled`, `research_not_in_plan`, `resource_gone`, `same_origin_required`, `sandbox_missing`, `sandbox_organization`, `scope_not_in_product`, `scope_state_changed`, `session_handle_already_used`, `session_handle_expired`, `session_handle_revoked`, `spend_cap_reached`, `spread_already_finalized`, `spread_limit`, `spread_locked`, `spread_not_finalized`, `spread_not_locked`, `spread_not_ready`, `spread_template_limit_exceeded`, `spreads_not_in_plan`, `spreadsheet_upload_disabled`, `statement_mapping_not_in_plan`, `subscription_required`, `surface_limit_exceeded`, `test_key_remint_required`, `unauthorized`, `unknown_factor`, `unprocessable`, `usage_throttled`, `validation_failed` - `message` (string, required) — Human-readable error message. Subject to wording changes; do not parse. - `code` (string, optional) — A finer, stable identifier within `type`, on the errors that carry one; absent otherwise. Pattern-match on it like `type`. The upload presign answers `not_found` with `loan_not_found` and `invalid_request` with `borrower_loan_mismatch`. - `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. ## Examples **Response** ```json { "data": [ { "document_id": "d0c0000000000000000000b5", "accession": "0009900077-26-000012", "document_category": "balance_sheet", "filing_form": "10-K", "amendment": false, "extractor_version": "v2026.02.21a-v2026.02.18b", "created_at": "2026-03-02T06:15:12.418210+00:00", "period_start": null, "period_end": "2025-12-31", "fiscal_year": 2025, "basis": "consolidated", "title": "Consolidated Balance Sheets", "page_count": 2, "filing_date": "2026-03-02", "report_period": "2025-12-31", "filing_registrant": "Larkspur Mills Inc", "entity_stamp_name": null, "entity_split_role": null, "extraction_source": "xbrl" }, { "document_id": "d0c0000000000000000000b6", "accession": "0009900077-26-000012", "document_category": "profit_and_loss", "filing_form": "10-K", "amendment": false, "extractor_version": "v2026.02.21a-v2026.02.18b", "created_at": "2026-03-02T06:15:12.418210+00:00", "period_start": "2025-01-01", "period_end": "2025-12-31", "fiscal_year": 2025, "basis": "consolidated", "title": "Consolidated Statements of Operations", "page_count": 1, "filing_date": "2026-03-02", "report_period": "2025-12-31", "filing_registrant": "Larkspur Mills Inc", "entity_stamp_name": null, "entity_split_role": null, "extraction_source": "xbrl" } ], "has_more": false, "next_cursor": null } ``` **SDK Code** ```typescript import { SpreadSpace } from '@spreadspace/sdk'; const client = new SpreadSpace({ apiKey: process.env.SPREADSPACE_API_KEY! }); const documents = await client.registrants.documents('9900077', { sheet: 'annual', from_year: 2025 }); for (const document of documents.data) console.log(document.document_id, document.fiscal_year); ``` ```python import os from spreadspace import SpreadSpace client = SpreadSpace(api_key=os.environ["SPREADSPACE_API_KEY"]) documents = client.registrants.documents("9900077", sheet="annual", from_year=2025) for document in documents["data"]: print(document["document_id"], document["fiscal_year"]) ``` ```csharp using SpreadSpace; using var client = new SpreadSpaceClient(Environment.GetEnvironmentVariable("SPREADSPACE_API_KEY")); var documents = await client.Registrants.DocumentsAsync("9900077", sheet: "annual", fromYear: 2025); foreach (var document in documents.Data) Console.WriteLine($"{document.DocumentId} {document.FiscalYear}"); ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.spreadspace.app/api/public/registrants/9900077/documents?sheet=annual&from_year=2025" 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/public/registrants/9900077/documents?sheet=annual&from_year=2025") 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/public/registrants/9900077/documents?sheet=annual&from_year=2025") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.spreadspace.app/api/public/registrants/9900077/documents?sheet=annual&from_year=2025', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.spreadspace.app/api/public/registrants/9900077/documents?sheet=annual&from_year=2025")! 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() ```