GET /v3/filings/{accession}/statements/roles
The filing's roles without their statements: every role (statements, cover, notes, policies, tables, details) in position order, with its menu category, statement kind, R page, tree size and matches_sec_render, and a link to its statement. 404 not_covered for a form under which no XBRL is filed. Paged by role number: 500 a page, has_more and next_cursor.
API key: required. See Authentication.
Group: Financial data (XBRL)
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
accession | path | string | yes | Accession number, with dashes (0001829126-26-010431) or without (18 digits). | |
category | query | string | no | The role's menu category as SEC's FilingSummary states it, any letter case: Cover, Statements, Notes, Policies, Tables, Details, Other or Uncategorized (notes, policies, tables and details are served like statements). | |
limit | query | integer | no | 500 | Roles per page, 1..500. |
cursor | query | string | no | next_cursor of the previous page (same filters). |
Responses
| Status | Body | Description |
|---|---|---|
200 | XbrlFilingRoles (application/json) | OK |
400 | Problem (application/problem+json) | Invalid or unknown parameter. |
401 | Problem (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). |
404 | Problem (application/problem+json) | Not found. |
503 | Problem (application/problem+json) | Database unavailable; retry after the Retry-After delay. |
default | Problem (application/problem+json) | Any other error (405, 500, 504). |
Response body
A 200 carries a XbrlFilingRoles object.
| Field | Type | Required | Description |
|---|---|---|---|
accession | string | yes | |
category | string | null | yes | |
data | array of XbrlRole | yes | Role number order, at most 500 a page. |
extraction | Extraction | yes | |
filing | FilingRef | yes | |
has_more | boolean | yes | |
next_cursor | string | null | yes | |
snapshot | Snapshot | yes | |
xbrl_statements | object | null | yes |
Example request
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
'https://api.secblast.com/v3/filings/0001829126-26-010431/statements/roles'Open this route in the console
More in Financial data (XBRL)
Previous: GET /v3/filings/{accession}/statements · Next: GET /v3/financials/facts
Markdown version: /docs/reference/get-filings-accession-statements-roles.md