Skip to navigation
APIMarkets Companies

Add company

Adds a company to the workspace by its CIK, which must name a registrant the store knows (404 otherwise). The forms default to 10-K, 10-Q, 8-K and S-1, the from year to the earliest year the store holds a filing of the company, follow to on; a company already in the workspace is 409. Needs markets:write.

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

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 to gather, a non-empty subset of 10-K, 10-Q, 8-K and S-1 in any case; all four when absent.

from_yearinteger or nullOptional

The first year of a filing’s period end to show, 1994 to the current year; when absent, the earliest the store holds for the company, and 1994 when it holds none.

followboolean or nullOptional

Whether the company’s new filings reach the organization as events and webhooks; true 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

Created
registrantobject

The company’s registrant, with how many of its filings the store holds, its newest filing date and its logo; named by its CIK when the store holds no registrant row for it.

formslist of strings

The forms gathered, among 10-K, 10-Q, 8-K and S-1; an amendment follows its base form.

from_yearinteger
The first year of a filing's period end the workspace shows.
followboolean
True when the company's new filings reach the organization as events and webhooks.
added_atdatetime
When the company joined the workspace.
statusstring

current, or updating while the store holds a filing of the company it has fetched and not yet extracted.

compslist of objects
The comps holding the company that the caller can see, by name.
latest_perioddate or nullOptional

The newest period end among the company’s extracted filings that nothing has superseded; null when none qualifies.

status_perioddate or nullOptional

The report period of the newest such filing when the status is updating; null otherwise.

Errors

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