Census v0.1.0 Census.Query

Struct representing an API query.

Summary

Functions

Create a new query

Returns the api url for a given query

Types

t :: %Census.Query{client: term, foreach: term, get: term, within: term}

Functions

new(client, params)

Specs

new(client :: Census.Client.t, params :: Keyword.t) :: Census.Query.t

Create a new query.

Usage:

iex> client = Census.Client.new("YOUR_API_KEY")
iex> Census.Query.new(client, get: "NAME,P0010001", foreach: "COUNTY:*", within: "STATE:55")
%Census.Query{
  client: %Census.Client{api_key: "YOUR_API_KEY", dataset: "SF1", vintage: "2010"},
  foreach: "COUNTY:*",
  get: "NAME,P0010001",
  within: "STATE:55"
}
url(query)

Specs

url(query :: Census.Query.t) :: String.t

Returns the api url for a given query.

Usage:

iex> client = Census.Client.new("YOUR_API_KEY")
iex> query = Census.Query.new(client, get: "NAME", foreach: "COUNTY:*", within: "STATE:55")
iex> Census.Query.url(query)
"http://api.census.gov/data/2010/sf1?key=YOUR_API_KEY&get=NAME&for=COUNTY:*&in=STATE:55"