Skip to content

SearchSubscriptionCreate

Fields

FieldTypeRequiredDescription
endpoint_idstringyesOne of your endpoints. It must take filing.new.
include_correctionsbooleanno—
min_interval_sinteger | nullno—
namestringyesA name for the subscription, 1 to 800 bytes.
queryobjectyesThe /v3/search parameters as JSON members, such as {"q": "merger", "forms": ["8-K"]}. Give a list as an array or a comma-separated string. More

Field notes

query

You can also give items: 8-K item codes. A subscription only gets new filings, so filing-date windows (filed_from, filed_to, startdt, enddt, dateRange) and status return 400. An acceptance window is not stored. An unknown ticker returns 400.

Used by

Markdown version: /docs/reference/schemas/search-subscription-create.md