Retrieve Observations from Data Commons
dc_get_observations(
date,
variable_dcids = NULL,
entity_dcids = NULL,
entity_expression = NULL,
parent_entity = NULL,
entity_type = NULL,
select = c("date", "entity", "value", "variable"),
filter_domains = NULL,
filter_facet_ids = NULL,
api_key = Sys.getenv("DATACOMMONS_API_KEY"),
base_url = Sys.getenv("DATACOMMONS_BASE_URL", unset =
"https://api.datacommons.org/v2/"),
return_type = "json"
)A date string, "latest", or "all" to return observations for
all dates.
Optional. Vector of statistical variable DCIDs.
Optional. Vector of entity DCIDs (e.g., places). One of
entity_dcids, entity_expression, or the combination of parent_entity
and entity_type is required.
Optional. A relation expression string (used in
place of entity_dcids). One of entity_dcids, entity_expression, or the
combination of parent_entity and entity_type is required.
Optional. A parent entity DCID to be used in combination
with entity_type to construct an entity expression.
Optional. A child entity type (e.g., "County") to be
used with parent_entity to construct an entity expression.
Required. Character vector of fields to select. Must include
"entity" and "variable". Defaults to
c("date", "entity", "value", "variable").
Optional. Vector of domain names to filter facets.
Optional. Vector of facet IDs to filter observations.
Your Data Commons API key. If not provided, uses the
environment variable DATACOMMONS_API_KEY.
The base URL of the Data Commons API. Defaults to the public
endpoint. For custom deployments, must end with /core/api/v2/.
Either "list" (parsed R object), "json" (JSON string),
or "data.frame".
A list (if return_type = "list"), JSON string (if
return_type = "json"), or data frame (if return_type = "data.frame")