Skip to content

GET /v3/search/status

State of the full-text index, without a key: per year the document and filing counts, index version and extractor; the live indexer's lag; indexed_through; the years being rebuilt. 503 search_unavailable when sb_search cannot be reached (or this deployment has no search).

API key: not needed.

Group: Full-text search

Parameters

This route takes no parameters.

Responses

StatusBodyDescription
200SearchStatus (application/json)OK
503Problem (application/problem+json)Full-text search cannot answer now: search_unavailable (sb_search unreachable or not configured), search_busy (its queue is full), search_timeout (the query hit its time budget), ticker_resolution_unavailable; or the database is unavailable. Retry after the Retry-After delay when one is given.
defaultProblem (application/problem+json)Any other error (405, 500, 504).

Response body

A 200 carries a SearchStatus object.

FieldTypeRequiredDescription
damaged_yearsarray of integer | nullyesYears found damaged and dropped from the index until they are rebuilt; searches answer from the other years.
freshnessobject | nullyesSeconds from a filing's acceptance to its first searchable commit, over the last 15 minutes; null without a live indexer.
freshness.p50_snumber | nullno
freshness.p95_snumber | nullno
freshness.windowstring | nullno"15m".
indexed_throughdate-time (RFC 3339, UTC) | nullyesThe newest event time the live index has applied.
indexerobject | nullyes
indexer.indexed_throughdate-time (RFC 3339, UTC) | nullno
indexer.lag_eventsinteger | nullno
indexer.lag_secondsnumber | nullno
indexer_staleboolean | nullyesTrue when the live indexer has not updated its status for over 120 seconds, or reports none; null when the index service does not say.
lag_secondsnumber | nullyesHow far the live indexer is behind (0 when caught up).
partial_yearsarray of integer | nullyesYears the live indexer started (the current or next year) that no full build has replaced yet: searchable, but they hold only the filings indexed live since; state is degraded while any exist.
rebuildingarray of integer | nullyesYears being rebuilt.
statestring | nullyes
tickersobject | nullyes
tickers.file_datedate (YYYY-MM-DD) | nullno
yearsarray of objectyes
years[].built_atstring | nullno
years[].documentsinteger | nullno
years[].extractorstring | nullno
years[].filingsinteger | nullno
years[].index_versionstring | nullno
years[].yearintegerno
years_missingarray of integer | nullyesYears not searchable now: listed years that cannot be opened, and damaged_years.

Example request

Shell
curl -sS 'https://api.secblast.com/v3/search/status'

Open this route in the console

Previous: GET /v3/search/parse

Markdown version: /docs/reference/get-search-status.md