get_candidates_in_race: Get Candidates in Race

View source: R/get_candidates_in_race.R

get_candidates_in_raceR Documentation

Get Candidates in Race

Description

Get Candidates in Race

Usage

get_candidates_in_race(
  state,
  chamber,
  district,
  cycle = 2018,
  return_value = c("results", "query"),
  page = 1,
  myAPI_Key
)

Arguments

state

State abbreviation

chamber

house or senate

district

house district

cycle

The election cycle in question, e.g. 2018

return_value

should results be retrieved, or query string returned.

page

Results come in batches of 20. The page parameter specifies which one to retrieve.

myAPI_Key

API key from Propublica To use the congress API, you must sign up for an API key.

Value

The result of the API call (list), unless return_value=query (mostly for debugging), in which case the query string is returned.

Examples

## Not run: 
get_candidates_in_race('MI', 'house', 11)

## End(Not run)

ProPublicaR documentation built on Sept. 8, 2023, 5:53 p.m.