SearchSubscriptionCreate
Fields
| Field | Type | Required | Description |
|---|---|---|---|
endpoint_id | string | yes | One of your endpoints. It must take filing.new. |
include_corrections | boolean | no | — |
min_interval_s | integer | null | no | — |
name | string | yes | A name for the subscription, 1 to 800 bytes. |
query | object | yes | The /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
- Sent to
POST /v3/search/subscriptions.
Markdown version: /docs/reference/schemas/search-subscription-create.md