Skip to content

GET /v3/filings/{accession}/items/{code}/text

One 8-K item's canonical text (not the filed HTML), cut from the stored primary document only when the document model and the exact bytes are at hand; otherwise text_status says why. Pages of at most 4 MiB on UTF-8 boundaries (offset, length; next_offset). Strong ETag over the whole response; If-None-Match answers 304 before the document is read. A document is converted once and its text kept in a cache while it is used; a conversion that does not finish within the request's time answers 503 conversion_timeout with Retry-After (it goes on, and the retry is served from the cache).

API key: required. See Authentication.

Group: 8-K items

Parameters

NameInTypeRequiredDefaultDescription
accessionpathstringyesAccession number, with dashes (0001829126-26-010431) or without (18 digits).
codepathstringyesAn item code (5.02) or its section key (8k.5.02).
offsetqueryintegerno0Byte offset in the item's text, 0..text_total_bytes.
lengthqueryintegerno4194304Bytes per page, 1..4194304.

Responses

StatusBodyDescription
200SpanText (application/json)OK
304noneNot modified: If-None-Match named this page's ETag (answered before the document is read).
400Problem (application/problem+json)Invalid or unknown parameter.
401Problem (application/problem+json)Missing, invalid or inactive API key (code unauthorized), or a refused access token (code invalid_token: malformed, unknown key, bad signature, expired, wrong issuer or audience, revoked grant). WWW-Authenticate names the protected-resource metadata (RFC 9728).
404Problem (application/problem+json)No filing with this accession (code not_found); the filing's form is not covered by this route's dataset (code not_covered, with members form_type, dataset and routes: the routes that cover it); for a text route, no such item or section in the parsed filing (code not_found).
422Problem (application/problem+json)The stored document is larger than this server converts to text (code document_too_large, with members document_bytes, limit and document: the document's URL, whose span_start..span_end Range holds the filed bytes of the passage). Nothing was read.
503Problem (application/problem+json)Database unavailable (code db_unavailable); or the document's conversion to text did not finish within the request's time (code conversion_timeout, with Retry-After): it goes on, and the same request after the delay is answered from the converted text.
504Problem (application/problem+json)The request's time ran out (code timeout), e.g. while it waited for the server's conversion budget; nothing was converted for it.
defaultProblem (application/problem+json)Any other error (405, 500, 504).

Response body

A 200 carries a SpanText object.

FieldTypeRequiredDescription
accessionstringno
docmodel_versionstring | nullno
documentobject | nullno
extractionExtractionno
next_offsetinteger | nullno
sectionstringno
served_model_versionstringno
textstring | nullno
text_bytesinteger | nullno
text_offsetinteger | nullno
text_reasonstring | nullnoOne of: model_changed, bytes_unavailable, null.
text_statusstringnoOne of: current, from_version, reparse_pending, no_text, parse_pending.
text_total_bytesinteger | nullno
text_truncatedbooleanno

Example request

Shell
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
  'https://api.secblast.com/v3/filings/0001829126-26-010431/items/5.02/text'

Open this route in the console

More in 8-K items

Previous: GET /v3/filings/{accession}/items

Markdown version: /docs/reference/get-filings-accession-items-code-text.md