Skip to navigation
APILoans

Pull a public company

Copies a public company’s extracted filings onto the loan as documents, one charge per company. Pulling a company already on the loan answers its documents again and charges nothing.

The copies are the company’s financial statements from the filings it filed as the primary registrant, of the named forms from the named year on: one upload per filing, one document per statement, read on the loan as any other document. A fresh pull answers 201; a company already on the loan answers 200 whatever forms and year are named. A fresh pull without the credit to cover it answers 402, and 409 when the store holds no statement of the company for those forms and years.

Requires the loans:write 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.

Headers

Idempotency-KeystringOptional<=255 characters

Idempotency token. Retries that reuse the key within 24h replay the original response. Up to 255 characters; a UUID is typical. See Idempotency.

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

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

Request

The request's cancellation token.
registrant_idstringRequired

The registrant’s id: its SEC CIK, one to ten digits, with or without its leading zeros.

formslist of strings or nullOptional

The forms the copied statements may come from, among 10-K, 10-Q, 8-K and S-1 in any case, an amendment read with its base form; all four when absent.

from_yearinteger or nullOptional

The first year the copied statements may come from, 1993 to 2100, a filing’s year being its report period’s, else its filing date’s; every year the store holds when absent.

Response headers

X-Request-IDstringOptional
Correlation ID for this request. Quote it in support tickets.
Idempotency-Replayboolean

Set to true when the response is replayed from the idempotency cache for a request that re-presented an Idempotency-Key it had already used. Absent on the original (winner) response. A replay repeats the original status and body. When the original could not be stored (an unhandled server fault, or a body over the 1 MiB replay cap) the replay is an error envelope that says so; the operation is never re-run under the same key.

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
registrantobject
The company's registrant, with how many of its filings the store holds, its newest filing date and its logo.
formslist of strings

The forms of the copied filings, 10-K, then 10-Q, then 8-K, then S-1; an amendment counts as its base form.

from_yearinteger

The earliest year among the copied documents: a document’s fiscal year, else its period end’s year, else its filing’s filing year.

pulled_atdatetime
When the earliest of the copies was made.
document_countinteger
How many documents the copies make on the loan.
filingslist of objects
The copied filings, by filing date, then accession.

Errors

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