View Source Census (Census v0.3.0)
Link to this section Summary
Link to this section Functions
@spec client(String.t(), Keyword.t()) :: Census.Client.t()
Create a new api client.
Usage:
iex> Census.client("YOUR_API_KEY")
%Census.Client{api_key: "YOUR_API_KEY", dataset: "SF1", vintage: "2010"}
Clients default to the 2010 SF1 dataset. To set an alternate dataset and vintage:
iex> Census.client("YOUR_API_KEY", dataset: "ACS5", vintage: "2005")
%Census.Client{api_key: "YOUR_API_KEY", dataset: "ACS5", program: "dec", vintage: "2005"}
Make a census api request given a client and query parameters.
Params:
get
foreach
within
(optional)
Usage:
iex> client = Census.client("YOUR_API_KEY")
iex> {:ok, response} = Census.fetch(client, get: "NAME", foreach: "COUNTY:*", within: "STATE:*")
iex> response.results
[%{}]