< back to index

HTTP request

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

Required Parameters

Parameter name Value Description
api_key string (from post, cookie, or get (in that order)) The unique key provided to any organization using the WeVoteServer APIs
voter_device_id string An 88 character unique identifier linked to a voter record on the server
text_for_map_search string The address text a voter enters to identify the location tied to their ballot. (Not mailing address.)
simple_save boolean Just save the address without returning a ballot with the results.


  "status": string,
  "success": boolean,
  "voter_device_id": string (88 characters long),
  "google_civic_election_id": integer,
  "text_for_map_search": string,
  "simple_save": boolean,
  "substituted_address_nearby": string,
  "ballot_found": boolean,
  "ballot_caveat": string,
  "is_from_substituted_address": boolean,
  "is_from_test_ballot": boolean,
  "ballot_item_list": list
     "ballot_item_display_name": string,
     "voter_id": integer,
     "google_civic_election_id": integer,
     "google_ballot_placement": integer,
     "local_ballot_order": integer,
     "kind_of_ballot_item": string (CANDIDATE, MEASURE),
     "id": integer,
     "we_vote_id": string,
     "candidate_list": list
        "id": integer,
        "we_vote_id": string,
        "ballot_item_display_name": string,
        "candidate_photo_url": string,
        "party": string,
        "order_on_ballot": integer,

Response Status Codes

Code Description
VALID_VOTER_DEVICE_ID_MISSING Cannot proceed. A valid voter_device_id parameter was not included.
MISSING_VOTER_ID_OR_ADDRESS_TYPE Cannot proceed. Missing variables voter_id or address_type while trying to save.
VOTER_ADDRESS_SAVED Successfully saved
MULTIPLE_MATCHING_ADDRESSES_FOUND Could not save. Multiple entries already saved.
MISSING_POST_VARIABLE-ADDRESS Could not save. POST variable 'address' is required.

Try It Now: API Variables

Save or create an address for the current voter. Then return the same results as we return with voterBallotItemsRetrieve.

Parameter name Value  
simple_save: True

(opens in new window)