SecioEx.FullTextSearch (secio_ex v0.1.3)
A way to do a Full text search of SEC filings and get back a list of them.
Summary
Functions
Performs a full-text search across SEC EDGAR filings.
Helper function to search with multiple terms using OR.
Helper function to search for an exact phrase.
Helper function to search with wildcards.
Functions
Performs a full-text search across SEC EDGAR filings.
Parameters
- query: String containing the search term or phrase
- opts: Keyword list of options
- form_types: List of form types to search (e.g., ["8-K", "10-K"])
- start_date: Start date in "YYYY-MM-DD" format
- end_date: End date in "YYYY-MM-DD" format
- ciks: List of CIK numbers to search
- page: Page number for pagination (default: 1)
- api_key: Your SEC API key
Examples
iex> SecioEx.FullTextSearch.search("SpaceX",
form_types: ["8-K", "10-Q"],
start_date: "2024-01-01",
end_date: "2024-03-31",
api_key: "your_api_key"
)
{:ok, %{total: %{value: 86, relation: "eq"}, filings: [...]}}
# Search with exact phrase
iex> SecioEx.FullTextSearch.search(""substantial doubt"",
form_types: ["10-K"],
api_key: "your_api_key"
)
Helper function to search with multiple terms using OR.
Examples
iex> SecioEx.FullTextSearch.search_any_of(["qualified opinion", "except for"],
api_key: "your_api_key"
)
Helper function to search for an exact phrase.
Examples
iex> SecioEx.FullTextSearch.search_exact_phrase("substantial doubt",
api_key: "your_api_key"
)
Helper function to search with wildcards.
Examples
iex> SecioEx.FullTextSearch.search_wildcard("gas",
api_key: "your_api_key"
)