Workflow directory
Choose the endpoints and workspace for the task you want to complete.
Choose the endpoint for your workflow
The browser and API share evidence, but different tools use different operations. All paths below are relative to https://api.filingsift.com/api/v1. URL fragments such as /#/search are website routes, not REST endpoints.
| Website tool | REST operation | Access and result contract |
|---|---|---|
| Search filings | POST /search/market | Public bounded search; credentials add scope, billing and history checks. Watchlist-independent. Results and the coverage receipt live in data; continuation is data.pagination. |
| Filing catalog | GET /catalog/filings | Authenticated, search:read. Historical observed metadata, not extracted text. All available indexed history is accessible across plans; indexed coverage and request limits apply. Use one ticker, comma-separated forms and filed_from/filed_to. |
| Screen filings | POST /screens/market or POST /screens/financing | Market-event screens use the first route; financing metrics use the second. Financing screens apply company/history access when authenticated. Only applicable numeric screens accept minimum/maximum bounds; maturity uses a maturity year. |
| Compare issuers | POST /screens/comparison-matrix | At most 20 tickers, 10 metrics and six forms. Evidence-status filters apply to individual metrics. A missing cell stays unavailable, never zero. |
| SEC datasets & comparisons | GET /sec-datasets/records and POST /sec-datasets/research/compare | Authenticated, search:read. Financial notes, ownership, fund holdings and private offerings with source evidence. See SEC research operations. |
| SEC supplemental research | GET /sec-datasets/supplements/records | Authenticated source search, structured fields where available, and original disclosure links. Historical coverage remains partial. |
| Saved research | GET/POST /account/saved-searches and /account/saved-screens | Browser session only. Saved-search and saved-screen alerts require explicit enablement and enabled organization Monitoring. Screen alerts go to the creator for newly indexed matches after saving. Saving alone is not a delivery guarantee. The UI reopens saved searches on Search and saved screens on Screens. |
| Monitoring | GET /coverage, POST /account/companies, GET /events.csv | Coverage and changes for the organization's configured company set; onboarding and export access have different scopes. |
POST /search remains a separate bounded, non-paginated operation used by the SDK tutorial and MCP search tool. It is not the website's market-search endpoint. GET /filings lists retained structured filings; it is not the historical metadata catalog.
Scopes for the examples
- Filing lists, comparisons and event CSV:
filings:read. - Passage search, catalog and screens:
search:read; reader:reader:read; analyst exports:exports:read. - Adding a watched company:
account:readandaccount:write, plus an owner/admin role (or platform administrator). - MCP connections:
filings:read; the search operation checkssearch:read.
Current compatibility behavior lets filings:read satisfy several older read-scope checks, including reader, search and exports. Do not assume it is a narrow filing-only credential; select explicit operation scopes where possible. It never grants account writes, browser-session access or bypasses billing and data boundaries.
Browser labels and API fields
Search, Screens and Matrix use JSON filters.forms, filters.filedFrom, filters.filedTo and filters.verificationStates. Do not substitute the catalog's query-string names. Evidence labels map to unverified (Source captured; validation pending), candidate (Review ready), machine_checked (Automated checks passed; automated checks) and verified (Reviewed; required human review completed). These are evidence states, not confidence scores or investment recommendations. Consult each operation's schema and vocabulary endpoint for supported fields; not every control belongs to every endpoint.
Choose a workflow
Use this directory to move from a product feature to its instructions and exact endpoint contract. Research operations use the scopes and coverage stated on each endpoint. Browser-only actions belong in the signed-in workspace; copying an API key does not make them programmatic APIs.
Find a company and its filings
Look up the company identifier, filter the filing catalog by the supported fields, then select an indexed accession. Open company/form/year coverage to distinguish searchable records from metadata and pending processing. Follow the operation-specific cursor; empty results are valid.
Read exhibits, tables and changed passages
Select accessions from filing results. List retained passages, tables or source inventories before choosing table IDs, cell coordinates, section IDs or source filenames. Supply those exact selections to a comparison; keep both evidence records. Table arithmetic uses explicitly selected cells and does not infer missing values.
Calendar and reporting intervals
Choose a ticker and the documented month/date selection. Inspect retained filing dates; use the calendar format option to download iCalendar. Reporting intervals describe observed period-to-filing gaps, not legal deadlines or a complete upcoming-events calendar.
Financials, notes and comparability
Start with the concept or footnote catalog. Find an available accession and fact IDs, then compare explicit compatible observations. Retain units, periods, dimensions, mapping metadata and validation state. Use the financial comparability workbench to inspect alternatives; a conflict or missing value remains unresolved.
Ownership, funds, offerings and supplemental records
Choose a dataset and company CIK, page through imported records and preserve each source version. Select exact left/right filings for changes or compatible same-date holdings for overlap. Supplemental family filters cover comment letters, proposed sales, subsidiaries and adviser history. See the SEC guide for selection fields and evidence rules.
Corporate events and financing research
Read the vocabulary before selecting categories or event views. Query indexed disclosures and check family coverage, then follow the cited filing. Financing views cover instruments, lifecycle, amendments, covenants and remediation. Recorded disclosures are not independent compliance, severity or investment conclusions.
Economic, bank, energy and credit context
Discover supported series/datasets in their catalog, select source-native identifiers and a bounded date range, then inspect units, missing values and source receipts. Retained history and request-time provider research are separate tools. The source-specific guides below cover BLS/BEA, FDIC, GLEIF, BIS, rates, EIA, CFTC and Treasury Fiscal workflows.
Models and spreadsheet formulas
Use exports:read for formula and template requests. Choose published concepts and entitled tickers; resolve VALUE, EVIDENCE or TABLE cells before building a model. Saved models and refresh schedules use the signed-in website. Inspect refresh history and refresh-review before using changed values. Install the separate Excel or Sheets package for spreadsheet use.
Saved research and reproducible snapshots
In the signed-in workspace, organize source links, saved views and cited memo drafts. Preview a supported snapshot definition, inspect its evidence, then save using the returned content hash. If sources changed, re-preview after the 409 response. Reopening checks current access. Memo review status is workflow metadata, not approval of financial facts.
Monitoring, saved matches and alert triage
Add watched companies, check available indexed history and enable Monitoring preferences. Choose supported categories, schedule and quiet hours; saved-search/screen notifications also need explicit opt-in. Review delivery history, acknowledge or dismiss alerts, and inspect source evidence. Test/retry actions can send messages; processed alerts are not immediate SEC publication notifications.
Feeds, team channels and destination exports
Use the signed-in Integrations page to inspect provider readiness. Feed rotation replaces the previous secret URL. Slack/Teams need your provider webhook; use the labeled test only when you intend to send a message. S3 requires your role/bucket and returned external ID; Sheets requires configured provider credentials and spreadsheet permission. Queue monitoring-delivery exports only after setup, then inspect exportJobs for completion or errors. This connector is separate from analyst XLSX and batch filing archives.
Dashboards, team roles and security
Save personal or team dashboards and preview supported arithmetic with explicit values. Owners/admins invite members and manage allowed domains; reviewers record task progress and audit history. Configure MFA/passkeys and sessions in Account settings. Invitation actions send email. Enterprise requirement intake does not activate SSO, SCIM, certification or an SLA.
API keys, plans and billing
Start with a free verified account, inspect coverage and create a scoped key from API keys. Use the live catalog for current capacities and purchase availability. Billing actions require the signed-in authorized account and redirect to Stripe. Review recurring charges before submitting payment; the dashboard shows activation after confirmation. Rotate or revoke keys without putting them in browser examples.