Skip to navigation
APISupporting Tables

Retrieve a supporting table

Retrieves a single extracted supporting table. A supporting table is a table printed in the notes to the financial statements. Requesting a document of any other type returns a 404.

Requires the extractions:read scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

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

Path parameters

borrower_idstringRequired
The borrower's id.
doc_idstringRequired
The document's id.

Headers

SpreadSpace-VersionstringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.

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

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See 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

OK
categorystring

The note family the table belongs to, such as debt or lease.

supportsenum
The balance sheet side, or the statement, the table supports.
shapestring

The table’s layout, such as maturity_schedule or debt_composition.

statusenum

RECONCILED when every check the table allows holds, FLAGGED when one does not, PRINTED when the table allows no check.

Allowed values:
columnsinteger or list of strings or list of objects

The figure columns: a count when the table heads them by period alone, the printed heads as objects, or on a debt table the printed heads as text with the label column first.

reporting_unitenum
The unit the figures are printed in, such as ones or thousands.
Allowed values:
scale_multiplierinteger>=1

Scale of the printed figures: 1 for whole dollars, 1000 when the table is stated in thousands, 1000000 when it is stated in millions.

subjectstringOptional

What the table is about, read off its caption and rows, such as regulatory_capital.

signalslist of objectsOptional
Each check of the table that does not hold, in words, when any does not.
entitystring or nullOptional
The reporting entity's name as printed, when the page prints one.
titlestring or nullOptional
The table's caption or note heading as printed.
headingstring or nullOptional
The note heading printed over the table.
captionstring or nullOptional
The sentence printed over the table that introduces it.
periodstring or nullOptional
The period wording printed over the table, such as the years ended, when it prints one.
periodslist of objectsOptional
The table's figure columns as periods, one entry per column.
as_ofstring or nullOptionalformat: "^\d{4}-\d{2}-\d{2}$"

The as-of date the table states.

as_of_printedstring or nullOptional

The as-of date as printed.

as_of_datestringOptional

The as-of date of a debt table, as a YYYY-MM-DD date or as printed.

label_headstring or nullOptional
The printed head of the label column, when the table prints one.
column_kindslist of stringsOptional

What each column holds, in columns order, such as label, money, rate, year or text.

column_headslist of objectsOptional

The heads printed over the figure columns, in order, when the table heads them apart from columns.

classeslist of objectsOptional
The classes printed over the figure columns, in order.
plan_groupslist of objectsOptional
The bands printed over runs of columns, in order.
lineslist of objectsOptional
The table's printed rows in order, each with one figure and one print mark per column.
applicantstring or nullOptional
The reporting entity's name as printed over the debt table, when the page prints one.
label_termslist of stringsOptional

Which of interest_rate and maturity_date the rows state in their labels.

creditor_columnstringOptional
The head of the column that names each debt.
balance_columnstringOptional
The head of the column that holds the balances.
balance_column_indexintegerOptional

Position of the balance column in columns, counting from zero.

total_balancestring or nullOptionalformat: "^-?\d+\.\d{2}$"
The balance column's total.
printed_total_balancestring or nullOptionalformat: "^-?\d+\.\d{2}$"
The total the table prints under the balance column.
debt_schedulelist of objectsOptional
The debt table's printed rows in order, captions and totals included.
directionenumOptional

On a related-party table, whether the balances are owed to the company (receivable_from) or by it (payable_to).

Allowed values:
consolidated_counterpartystring or nullOptional
The related party the table is with, when it names one.
footnoteslist of objectsOptional
The footnotes printed under the table, in page order.
cpa_engagementintegerOptional0-3

The accountant’s level of assurance: 0 unaudited, 1 compiled, 2 reviewed, 3 audited.

cpa_engagement_labelstringOptional
The assurance level in words.
presentationenumOptional

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:
billing_yearsintegerOptional
Years of data billed for the table.
packetobjectOptional
Where the table sat in the financial statement packet it arrived in, when it arrived in one.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error