Skip to content

GET /v3/forms

Form types present (deleted filings excluded) with filing counts, most frequent first. Computed in the background, never by a request: once at start and then every few minutes (5 by default; less often when a computation is slow); computed_at says when, and the list is served until the next computation replaces it. Until the first computation after a start has finished the answer is 503 with code warming_up and Retry-After.

API key: required. See Authentication.

Group: Coverage, usage and service

Parameters

This route takes no parameters.

Responses

StatusBodyDescription
200FormList (application/json)OK
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).
503Problem (application/problem+json)Database unavailable (code db_unavailable); or the answer, which the server computes in the background, has not been computed yet since it started (code warming_up). Retry the same request after the Retry-After delay.
defaultProblem (application/problem+json)Any other error (405, 500, 504).

Response body

A 200 carries a FormList object.

FieldTypeRequiredDescription
computed_atdate-time (RFC 3339, UTC)noWhen the list was computed, UTC. It is served until a later computation replaces it.
dataarray of FormCountyes
has_morebooleanno
next_cursorstring | nullno

Example request

Shell
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
  'https://api.secblast.com/v3/forms'

Open this route in the console

More in Coverage, usage and service

Previous: GET /v3/coverage/summary · Next: GET /v3/health

Markdown version: /docs/reference/get-forms.md