Get latest attributes

{
  "loan_id": "9f8b7c6d5e4a3b2c1d0e4f5a",
  "snapshot": {
    "snapshot_id": "8a7b6c5d4e3f2a1b0c9d8e7f",
    "version": 2,
    "status": "final",
    "created_at": "2024-04-10T14:45:02.684432+00:00",
    "payload": {
      "schema_version": "attributes.v1",
      "periods": [
        "2022",
        "2023"
      ],
      "attributes": {
        "tax_return_tax_gross_receipts": {
          "label": "Gross receipts",
          "unit": "money",
          "basis": "tax",
          "values": {
            "2022": "2210500.00",
            "2023": "2450000.00"
          },
          "documents": {
            "2022": [
              {
                "document_id": "7b6a59483726150493827160",
                "extraction_version": 1
              }
            ],
            "2023": [
              {
                "document_id": "123abc456def7890a1b2c3d4",
                "extraction_version": 1
              }
            ]
          }
        },
        "tax_return_tax_ebitda": {
          "label": "EBITDA (tax basis)",
          "unit": "money",
          "basis": "tax",
          "values": {
            "2022": "372800.00",
            "2023": "410250.00"
          },
          "documents": {
            "2022": [
              {
                "document_id": "7b6a59483726150493827160",
                "extraction_version": 1
              }
            ],
            "2023": [
              {
                "document_id": "123abc456def7890a1b2c3d4",
                "extraction_version": 1
              }
            ]
          }
        }
      },
      "ratios": {
        "tax_return_current_ratio": {
          "label": "Current ratio (Schedule L)",
          "unit": "ratio",
          "basis": "tax_return_tax",
          "values": {
            "2022": "1.6120",
            "2023": "1.7345"
          }
        }
      },
      "tables": {},
      "inputs": {
        "addbacks": [
          {
            "label": "Officer compensation",
            "direction": "add",
            "years": [
              "2023"
            ],
            "amount": {
              "2023": "185000.00"
            }
          }
        ],
        "dscr_configs": [
          {
            "name": "Standard DSCR",
            "numerator": "Adjusted EBITDA"
          }
        ],
        "hidden_rows": 0,
        "custom_visuals": 0,
        "custom_tables": 0
      }
    },
    "manifest": {
      "documents": [
        {
          "document_id": "7b6a59483726150493827160",
          "document_type": "1120s",
          "fiscal_year": 2022,
          "period_end": "2022-12-31",
          "extraction_version": 1
        },
        {
          "document_id": "123abc456def7890a1b2c3d4",
          "document_type": "1120s",
          "fiscal_year": 2023,
          "period_end": "2023-12-31",
          "extraction_version": 1
        }
      ],
      "inputs_summary": {
        "addbacks": 1,
        "dscr_configs": 1,
        "hidden_rows": 0,
        "custom_visuals": 0,
        "custom_tables": 0
      },
      "entity": {
        "key": "business:acme corporation",
        "name": "Acme Corporation"
      },
      "built_at": "2024-04-10T14:45:00Z",
      "builder_version": "8cb1de79f"
    },
    "spread_board_id": "0c9d8e7f6a5b4c3d2e1f0a9b",
    "finalized_at": "2024-04-10T14:45:02.684432+00:00",
    "finalized_by": "Avery Morgan",
    "finalized_by_external_user_id": null
  }
}

Retrieves the loan’s latest attribute snapshot of one status. snapshot is null when the loan has none of that status yet.

Requires the spreads: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

loan_idstringRequired

The loan's id.

Query parameters

statusenumOptional

Which status to read: final, machine or draft; any other value is rejected with 400. Defaults to final.

Allowed values:

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

loan_idstring

snapshotobject or null

One snapshot of a loan's attribute values, with its payload and manifest.

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