Skip to navigation
APIMarkets Comps

Update comp

Renames a comp; a field left out stays as it is. The name is trimmed, 1 to 200 characters, and unique among the caller’s comps ignoring case (409 otherwise). 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.

Path parameters

comp_idstringRequired
The comp'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.
namestring or nullOptional

The new name, 1 to 200 characters after trimming; unique among the caller’s comps, ignoring case.

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
idstring
The comp's id.
namestring
The comp's name, unique among its owner's comps, ignoring case.
company_countinteger
How many companies the comp holds.
followed_countinteger
How many of them the organization follows for new filings.
ownedboolean

True when the caller may rename, delete and change the comp: the seat that made it, or any API key of the organization for an organization-owned one.

created_atdatetime
When the comp was created.
updated_atdatetime
When the comp or its companies last changed.
logo_urlslist of strings

The logo addresses of up to four of the comp’s companies, by company name; a company with neither a stored logo nor a ticker is left out, so the list is empty when none has one.

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