SecioEx.QueryApi (secio_ex v0.1.3)
The query api for working with SEC filings
Summary
Functions
Performs a search query against the SEC Filings API.
Helper function to search filings within a date range.
Helper function to search filings by ticker symbol.
Helper function to search for specific form types.
Functions
Performs a search query against the SEC Filings API.
Parameters
- query: String containing the Lucene query syntax
- opts: Keyword list of options
- from: Starting position for pagination (default: 0)
- size: Number of results per page (default: 50, max: 50)
- sort: List of sort criteria (default: [%{"filedAt" => %{"order" => "desc"}}])
- api_key: Your SEC API key
Examples
iex> SecioEx.QueryApi.search("formType:"10-Q"", api_key: "your_api_key")
{:ok, %{"total" => %{"value" => 10000, "relation" => "gte"}, "filings" => [...]}}
Helper function to search filings within a date range.
Examples
iex> SecioEx.QueryApi.search_by_date_range("2024-01-01", "2024-01-31", api_key: "your_api_key")
{:ok, %{"total" => %{"value" => 3000, "relation" => "eq"}, "filings" => [...]}}
Helper function to search filings by ticker symbol.
Examples
iex> SecioEx.QueryApi.search_by_ticker("AAPL", api_key: "your_api_key")
{:ok, %{"total" => %{"value" => 5000, "relation" => "eq"}, "filings" => [...]}}
Helper function to search for specific form types.
Examples
iex> SecioEx.QueryApi.search_form_type("10-K", api_key: "your_api_key")
{:ok, %{"total" => %{"value" => 10000, "relation" => "gte"}, "filings" => [...]}}