View Source CensysEx.API (censys_ex v1.2.3)
Base Wrapper for search.censys.io v2 APIs
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor.
Starts the CensysEx.API. Pulls in API ID & secret from the env variables CENSYS_API_ID
& CENSYS_API_SECRET
Starts the CensysEx.API process
Starts the CensysEx.API process
Link to this section Functions
Link to this function
aggregate(resource, field, query \\ nil, num_buckets \\ 50, other_params \\ Keyword.new())
View SourceReturns a specification to start this module under a supervisor.
See Supervisor
.
@spec get(String.t(), String.t(), list(), keyword()) :: CensysEx.result()
@spec get_v1(String.t(), String.t(), list(), keyword()) :: CensysEx.result()
@spec start_link() :: GenServer.on_start()
Starts the CensysEx.API. Pulls in API ID & secret from the env variables CENSYS_API_ID
& CENSYS_API_SECRET
examples
Examples
iex(1)> # CENSYS_API_ID environment var not set
iex(2)> CensysEx.API.start_link
{:error, "CENSYS_API_ID missing!"}
@spec start_link(keyword(String.t())) :: GenServer.on_start()
Starts the CensysEx.API process
examples
Examples
{:ok, _} = CensysEx.API.start_link([id: "***********", secret: "***********"])
@spec start_link(String.t(), String.t()) :: GenServer.on_start()
Starts the CensysEx.API process
examples
Examples
{:ok, _} = CensysEx.API.start_link("***********", "***********")
@spec view(String.t(), String.t(), DateTime.t() | nil) :: CensysEx.result()