Package index • eesyapi

Primary API workflow tools for analysts

These are the functions we expect analysts will most likely want to use to connect to the EES API.

get_publications(): Get publications

get_data_catalogue(): Get publication specific data set catalogue

get_dataset_versions(): Get data set versions

get_meta(): Get a parsed version of the API response for a data set's meta data

preview_dataset(): Preview the raw CSV for an API data set

query_dataset(): Query a data set

Support for generating API URLs and interpreting responses

These functions are helpful for deriving urls and handling HTTP responses and are used widely by the API workflow functions.

api_url(): Generate an EES API URL

Generate example IDs and reference data

These functions are used widely to create working example code and tests

example_data_raw(): Example raw data

example_geography_query(): Create an example geography-query data frame

example_id(): Example ID

example_json_query(): Create an example json query string

geog_level_lookup: Look-up for API geographic_level shorthands