Tool reference

Your AI chooses these tools on its own, so this page explains what your AI can reach and what each call costs. Tools marked Free share a daily allowance of 1,000 calls on the Free plan, 10,000 on Analyst, and 30,000 on Pro.

The Sift and ask tools (sift_filing, sift_section, ask_filing, and ask_passage) spend the same credits the SECSift reader does, from the same balance. Results carry SECSift links to the source.

Select a tool to see what the tool returns and the parameters your AI can send.

Find a company or filing

search_companies Finds a company by ticker, name, or CIK. Free

Returns up to 10 companies that have a ticker, each with a link to the company's filings.

Parameters

  • query (required): A ticker, company name, or CIK.
list_filings Lists a company's filings, with links to SECSift. Free

Returns the same filings list the reader shows, with each filing tagged as an annual, quarterly, earnings, proxy, registration, insider, or activist filing. Each filing carries the accession number the other tools take and a link that opens the filing on SECSift.

When the company has insider filings, an insider list comes back too, with up to 60 recent Forms 3, 4, and 5. Each has the filer's name, the transaction date, and a link.

Parameters

  • ident (required): The company's ticker or CIK.
  • include_all: Set to true to add every other filing since 2001, up to 1,000.

Search across all filings

search_filings Searches every filing on EDGAR for a word or phrase. Free

This is SECSift's global filings search in your chat, with the same filters as the site. Each result shows the company, exchange, ticker, form, the documents that matched, industry, headquarters, public float, period, and filing date, with a link that opens the filing on SECSift.

Searches count toward the same daily search allowance as the site.

Parameters

  • query (required): The words to find, 3 to 200 characters. The search dialog's operators work here too, like quotes for an exact phrase, OR, -word, NOT, and brackets around a choice of words. Leave the words empty and send forms to list every filing of those forms, newest first.
  • forms: Form codes such as 10-K, or a group such as reports or proxies.
  • days: How far back from today to look. The default is 365, and 0 looks back to 2001.
  • from_date: The start of a date range, in place of days.
  • to_date: The end of that range. The default is today.
  • companies: Tickers, names, or CIKs, up to 30.
  • my_companies: The companies of your saved filings, the site's Favorites, in place of companies.
  • headquarters: A state, a country, or United States, Canada, or Elsewhere.
  • word_variations: Also finds other forms of each word, so restructure finds restructuring and restructured.
  • page: Which page of results. Each page holds 100 documents, up to 10 pages.
  • group_by: Filings, companies, or documents. The default is filings.
filing_passages Finds where your search words appear in one filing. Free

Use this tool after a search. Returns the first 20 passages that carry the words, in the order they appear in the filing, each with its section and a link that opens the filing at that spot.

Also returns how many passages carry the words in all. When there are more than 20, a find link opens the filing with the words in the find bar.

Parameters

  • ident (required): The company's ticker or CIK.
  • accession (required): The filing's accession number, from list_filings.
  • query (required): The words to find.

Read a filing

filing_overview Shows a filing's sections, word count, and tables. Free

Returns the filing's sections with their ids, its word count, and how many tables the filing holds, so your AI can see the filing's shape before reading.

Parameters

  • ident (required): The company's ticker or CIK.
  • accession: The filing's accession number. Leave this off for the company's latest report.
get_section Returns one section's full text, with its tables inline. Free

Parameters

  • ident (required): The company's ticker or CIK.
  • accession (required): The filing's accession number, from list_filings.
  • section (required): An id, an item number like 1A, or part of the label.
  • offset: Where the next part of a long section starts. Sections come back 28,000 characters at a time.
  • routine: skip drops the routine text, and only returns just the routine text, graded the same way as the reader's fade. The default includes everything.
list_tables Lists every table in a filing. Free

Returns each table's number, the section it sits in, its headers, and its size.

Parameters

  • ident (required): The company's ticker or CIK.
  • accession (required): The filing's accession number, from list_filings.
get_table Returns one table as a clean grid. Free

Returns the table as a clean grid of up to 200 rows, with its scale noted.

Parameters

  • ident (required): The company's ticker or CIK.
  • accession (required): The filing's accession number, from list_filings.
  • n (required): The table's number from list_tables.
merge_tables Lines up the same table across up to 6 filings. Paid plans

Rows are lined up by their labels, so the periods sit side by side. Each filing's table is matched by content, so the match holds up when a table moves or changes shape between filings.

Merging costs no credits and needs an Analyst or Pro plan, the same as on the site.

Parameters

  • ident (required): The company's ticker or CIK.
  • accessions (required): Up to 6 filings, newest first.
  • n (required): The table's number in the first filing.

Compare filings

compare_filings Shows what changed between two filings. Free

Matches the two filings by content rather than position. Returns counts of new, changed, and removed passages, the changed passages with links, and the text of the removed ones. The lists come a page at a time.

Parameters

  • ident (required): The company's ticker or CIK.
  • accession (required): The newer filing's accession number.
  • prior_accession (required): An earlier filing of the same form.
  • changed_offset: Where the changed list continues from the last call.
  • removed_offset: Where the removed list continues from the last call.
  • changed_limit: How many changed passages come back. The default is 40, and the most is 100.
  • removed_limit: How many removed passages come back. The default is 20, and the most is 50.

Analyze and ask

sift_section Runs Sift on one section. 3 credits

Returns a read, skim, or skip verdict and why, a short synthesis, and the positive, notable, and concern flags, each anchored to an exact passage.

Sifting the same section again on the same model is free, and so is a section of a filing you already Sifted whole.

Parameters

  • ident (required): The company's ticker or CIK.
  • accession (required): The filing's accession number, from list_filings.
  • section (required): An id, an item number like 1A, or part of the label.
  • model: standard, pro, or max. The default is standard. See the note at the end of this page.
sift_filing Runs Sift on a whole filing. 3 to 10 credits

Returns every section's verdict, synthesis, and flags, with counts. The price follows length, the same as the site's Run Sift, 3 credits under 2,000 words, 6 under 15,000, and 10 for a full report. A large filing takes about a minute.

Sifting a filing again on the same model is free, whether the first run was here or on the site.

Parameters

  • ident (required): The company's ticker or CIK.
  • accession (required): The filing's accession number, from list_filings.
  • model: standard, pro, or max. The default is standard. See the note at the end of this page.
ask_passage Answers a question about one passage. 2 credits

Answers from that one passage, with a link to the passage.

Parameters

  • ident (required): The company's ticker or CIK.
  • accession (required): The filing's accession number, from list_filings.
  • question (required): The question to answer.
  • passage (required): The passage text, which your AI pastes from get_section.
  • model: standard, pro, or max. The default is standard. See the note at the end of this page.
ask_filing Answers a question from the whole filing, with citations. 3 credits

This is SECSift's Ask this filing chat. The answer comes from the whole document, with citations linked to the exact passages. Your AI can read sections itself with the free tools, so this tool is for questions that need the entire filing at once.

ask_filing has no model option. Like the reader's chat, ask_filing runs on one model at a flat 3 credits.

Parameters

  • ident (required): The company's ticker or CIK.
  • accession (required): The filing's accession number, from list_filings.
  • question (required): The question to answer.
  • history: The conversation so far, to keep it going.

Alerts

These are the same alerts as the site, from the same account, so a change in one place shows in the other at once. Setting alerts needs an Analyst or Pro plan.

list_alerts Reads your alert inbox. Free

Pinned alerts come first, then the newest. Each one shows which company filed, the form, what the alert found, whether it's unread, and a link to the filing. Reading the inbox doesn't mark anything read.

Parameters

  • kind: All, companies, owners, keywords, or screens. The default is all.
  • unread_only: Only the alerts you haven't read.
  • since_days: Only the alerts from that many days back.
  • limit: How many alerts come back. The default is 25, and the most is 200.
  • keyword_id: One keyword alert's own history.
  • screen: One screen's own history.
  • company: One company's own history.
  • query: Searches the inbox the way its search box does.
  • page: The next page of alerts.
mark_alerts_read Marks alerts read or unread. Free

Parameters

  • ids: The alerts to mark read.
  • all_unread: Marks every unread alert read, in place of ids.
  • unread: Marks the alerts in ids unread again.
delete_alerts Deletes alerts from your inbox. Free

Deleted alerts can't be brought back.

Parameters

  • ids (required): The alerts to delete.
pin_alerts Pins alerts to the top of your inbox. Free

Pinned alerts sit at the top and never get cleared out. You can pin up to 12.

Parameters

  • ids (required): The alerts to pin.
  • pin: Set to false to unpin the alerts.
list_alert_rules Lists what you track and how alerts reach you. Free

Returns:

  • Watches: The companies and owners you watch, which are paused, and each one's trade size.
  • Favorites: The companies of your saved filings, and whether each is watched.
  • Keywords and screens: Each with its filters and last match, and for a keyword, its companies and whether it's paused.
  • Delivery: How your alerts reach you.
  • Limits: What your plan allows.
  • Choices: Every screen you can turn on with its weekly volume, the watch categories, and the float, industry, and region values filters take.

This tool takes no parameters.

watch_company Watches a company or an owner, or stops. Free

A trade size is any, or minimums in buy_min and sell_min (dollars) and buy_pct and sell_pct (percent of holdings). A trade alerts when it meets the dollar or the percent minimum. Set include_outside_10pct_holders to false to leave out outside shareholders who own over 10%. An officer or director who owns over 10% always counts.

Parameters

  • ident (required): A ticker, name, or CIK.
  • on: Set to false to stop watching.
  • owner: Set to true to find a fund or a person by name and file the filer under Owners. A listed company counts only when it also files as an investor, like Berkshire Hathaway.
  • categories: Which filings count. Choose from reports, events, releases, proxies, buys, sells, insiders, ownership, registrations, and other. A company starts with reports, events, and proxies, and an owner with every category.
  • sift: Set to true to run Sift on each new filing, at 3 to 10 credits a filing.
  • paused: Set to true to pause the watch and keep its settings, or false to resume it. A paused watch still counts toward your plan's limit, and a resumed watch reports filings from that day on.
  • trade_size: Which insider buys and sells alert, as a trade size like the one above. A new watch starts at any, and a part you don't send stays as it was.
set_all_watches Changes categories or Sift for every watch at once. Free

Works like the "All companies" row in the alerts dialog, for every company you watch.

Parameters

  • categories: The categories to turn on.
  • on: Set to false to turn those categories off instead.
  • sift: Turns Sift on or off for every watch.
  • kind: Set to owners to change every owner instead.
set_keyword_alert Follows a phrase across new filings, or stops. Free

Sending the same phrase and companies again changes the alert. To change which companies an alert covers, or to choose one of several alerts on the same phrase, pass its alert_id.

Parameters

  • phrase: One exact phrase to follow, 3 to 80 characters, without operators. Needed unless you pass alert_id.
  • companies: Up to 10 companies instead of every company, by ticker, name, or CIK.
  • company: One company, the same as a one-item companies list.
  • alert_id: An existing alert's id, from list_alert_rules. Changes that alert, whatever companies it covers.
  • paused: Set to true to pause the alert and keep its settings, or false to resume it. A paused alert still counts toward your plan's limit.
  • on: Set to false to stop the alert.
  • documents: Which filings are searched. Reports and events by default.
  • floats: The public float bands to cover, for an alert on every company.
  • industries: The industries to cover, for an alert on every company. Name a group like Manufacturing, or an industry by its SIC code or name.
  • headquarters: The places to cover, for an alert on every company.
  • exclude_industries: Keeps every industry except those in industries.
  • exclude_headquarters: Keeps every place except those in headquarters.
set_screen Turns a filing screen on or off. Free

Parameters

  • screen (required): The screen's key, such as bankruptcy or auditor-change.
  • on: Set to false to turn the screen off and keep its filters for when you turn the screen on again.
  • amendments: Set to true to include amended filings.
  • floats: The public float bands to cover.
  • industries: The industries to cover. Name a group like Manufacturing, or an industry by its SIC code or name.
  • exclude_industries: Keeps every industry except those in industries.
set_alert_delivery Sets how and when your alerts arrive. Free

Send only what you want to change.

Parameters

  • cadence: instant or scheduled.
  • paused: Pauses or resumes the emails.
  • alerts_paused: Pauses or resumes every alert at once, and the emails with them.
  • hours: The hours scheduled alerts go out, up to 4 a day.
  • timezone: The time zone for those hours.
  • alert_email: Sends alerts to another address once its owner selects the link SECSift emails there. Set to account to go back to your account's address.
  • cancel_pending: Drops an address still waiting for its link.
  • late_forms: Includes forms EDGAR makes public weeks late.

Insider forms

Forms 3, 4, and 5 work with the same reading tools. When ask_filing answers about an insider filing, the answer draws on that insider's recent trades at the company too.

To see who's been buying or selling, use the insider list from list_filings, then open the filings you want with get_section. The filing's Summary section lays out each transaction and calls out open-market purchases.

Note: Costs above are per call on the Standard model. sift_section, sift_filing, and ask_passage take an optional model of standard, pro, or max, the same tiers as the reader. Pro multiplies the credit cost by 10 and Max by 30, and both need a paid plan. Every charged call returns your remaining balance.