< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterPositionRetrieve (Jump to "Try It Now")

Required Parameters

Parameter name Value Description
voter_device_id string An 88 character unique identifier linked to a voter record on the server
api_key string (from post, cookie, or get (in that order)) The unique key provided to any organization using the WeVoteServer APIs
kind_of_ballot_item string What is the type of ballot item for which we need to know the voter's stance? (kind_of_ballot_item is either "CANDIDATE", "POLITICIAN" or "MEASURE")
ballot_item_we_vote_id string The unique we_vote identifier for this ballot_item (either ballot_item_id OR ballot_item_we_vote_id required -- not both. If it exists, ballot_item_id is used instead of ballot_item_we_vote_id)

Response

{
  "success": boolean,
  "status": string,
  "ballot_item_display_name": string (either measure name or candidate name),
  "position_we_vote_id": string (the position identifier that moves server-to-server),
  "is_support": boolean,
  "is_oppose": boolean,
  "is_information_only": boolean,
  "google_civic_election_id": integer,
  "office_we_vote_id": string,
  "candidate_we_vote_id": string,
  "measure_we_vote_id": string,
  "kind_of_ballot_item": string (OFFICE, CANDIDATE, MEASURE),
  "ballot_item_we_vote_id": string,
  "stance": string (SUPPORT, OPPOSE, INFO_ONLY, or NO_STANCE),
  "statement_text": string,
  "statement_html": string,
  "more_info_url": string,
  "last_updated": string,
}

Try It Now: API Variables

Retrieve the position (support/oppose) on this office, candidate or measure for the voter.

Parameter name Value  
voter_device_id:
kind_of_ballot_item:
ballot_item_we_vote_id:

(opens in new window)