regcensus (version 1.0.1)

get_endpoint: get_endpoint

Description

Get endpoint for a specific series, jurisdiction, year, document_type combo

Usage

get_endpoint(series, jurisdiction, year, document_type, summary = TRUE)

Value

Returns the endpoint, e.g. '/state-summary' for summary-level state data

Arguments

series

Series ID(s)

jurisdiction

ID for the jurisdiction

year

Year(s) of data

document_type

ID for type of document

summary

Return summary instead of document level data (only one year of data is allowed for document level data), default value is TRUE

Examples

if (FALSE) get_endpoint(
  series = c(28, 33, 36), jurisdiction = 38,
  year = c(1970, 2003, 2004, 2018), document_type = 1
)