Skip to content

GET /v3/search/subscriptions/{id}

One subscription of the organization. Another organization's subscription is 404. 503 callbacks_unavailable while this server has no callback key file or its database lacks the callback tables.

API key: required. See Authentication.

Group: Webhooks (API: callbacks)

Parameters

NameInTypeRequiredDefaultDescription
idpathstringyesThe subscription's id (sub_ and 24 hex digits).

Responses

StatusBodyDescription
200SearchSubscription (application/json)OK
400Problem (application/problem+json)Invalid or unknown parameter, or a query error (invalid_query, query_too_complex, prefix_too_broad, negative_only_query, unsupported_operator, invalid_cursor); query errors carry position and length (characters of q).
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).
403Problem (application/problem+json)The credential's scope does not cover this route (code forbidden).
404Problem (application/problem+json)Not found.
409Problem (application/problem+json)Conflict with the current state.
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 SearchSubscription object.

FieldTypeRequiredDescription
activebooleanyes
created_atdate-time (RFC 3339, UTC)yes
endpoint_idstringyescbe_ and 24 hex digits.
idstringyessub_ and 24 hex digits.
include_correctionsbooleanyes
kindstringyesFrom the query: search when q is not empty, or doctypes, primary_only=true or entityName is given; else filing when a filing-level filter is given (forms, form_types, form_families and their exclusions, ciks, tickers, sics, states, inc_states, locationCode, items); else firehose. filing and firehose deliver filing.new, search delivers search.match. A filing subscription counts against limits.filter. Text subscriptions (kind search) are not offered: a create or PATCH whose query has q, doctypes, primary_only=true or entityName is a 400 invalid_parameter naming that parameter. One of: filing, firehose, search.
min_interval_sinteger | nullyesDigest interval; null: every event is delivered alone.
namestringyes
queryobjectyesAs stored: q, syntax, match and the structured filters as /v3/search/parse normalises them, tickers resolved into ciks at save time (no tickers member), items as given, accepted_from and accepted_to always null.
query.filtersobjectyes
query.matchstringyesOne of: exact, stem.
query.qstringyes
query.syntaxstringyesOne of: sb, edgar.
updated_atdate-time (RFC 3339, UTC)yes

Example request

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

Open this route in the console

More in Webhooks (API: callbacks)

Previous: POST /v3/search/subscriptions · Next: PATCH /v3/search/subscriptions/{id}

Markdown version: /docs/reference/get-search-subscriptions-id.md