< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/positionLikeCount (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
position_entered_id integer The position that the voter is liking.

Optional Parameters

Parameter name Value Description
limit_to_voters_network boolean If you want the number of Likes returned to *only* be from people in the voter's network, pass the value True.

Response

{
  "status": string,
  "success": boolean,
  "voter_device_id": string (88 characters long),
  "position_entered_id": integer,
  "type_of_count": string, (is this a count based on ALL or VOTER_NETWORK)
  "number_of_likes": integer, (will be same count as all_likes and voter_network_likes values- is provided if the front end would rather work with a type_of_count switch)
  "all_likes": integer,
  "voter_network_likes": integer,
}

Response Status Codes

Code Description
VALID_VOTER_DEVICE_ID_MISSING Cannot proceed. A valid voter_device_id parameter was not included.
VALID_VOTER_ID_MISSING Cannot proceed. A valid voter_id was not found.
POSITION_LIKE_ALL_COUNT_RETRIEVED
POSITION_LIKE_VOTER_NETWORK_COUNT_RETRIEVED

Try It Now: API Variables

The total number of Likes that a position has received, either from the perspective of your network of friends, or the entire network.

Parameter name Value  
voter_device_id:
position_entered_id:
limit_to_voters_network: True
False

(opens in new window)