< back to index

HTTP request

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

Required Parameters

Parameter name Value Description
twitter_handle string Find the kind of owner and unique id of this twitter handle.

Response

{
  "status": string,
  "success": boolean,
  "twitter_handle": string,
  "owner_found": boolean,
  "kind_of_owner": string, (POLITICIAN, CANDIDATE, ORGANIZATION, TWITTER_HANDLE_NOT_FOUND_IN_WE_VOTE, TWITTER_HANDLE_DOES_NOT_EXIST)
  "owner_we_vote_id": string,
  "owner_id": integer,
  "google_civic_election_id": integer,
  "twitter_description": string, (ONLY RETURNED FOR kind_of_owner == TWITTER_HANDLE_NOT_FOUND_IN_WE_VOTE)
  "twitter_followers_count": string, (ONLY RETURNED FOR kind_of_owner == TWITTER_HANDLE_NOT_FOUND_IN_WE_VOTE)
  "twitter_photo_url": string, (ONLY RETURNED FOR kind_of_owner == TWITTER_HANDLE_NOT_FOUND_IN_WE_VOTE)
  "we_vote_hosted_profile_image_url_large": string, (ONLY RETURNED FOR kind_of_owner == TWITTER_HANDLE_NOT_FOUND_IN_WE_VOTE)
  "we_vote_hosted_profile_image_url_medium": string, (ONLY RETURNED FOR kind_of_owner == TWITTER_HANDLE_NOT_FOUND_IN_WE_VOTE)
  "we_vote_hosted_profile_image_url_tiny": string, (ONLY RETURNED FOR kind_of_owner == TWITTER_HANDLE_NOT_FOUND_IN_WE_VOTE)
  "twitter_user_website": string, (ONLY RETURNED FOR kind_of_owner == TWITTER_HANDLE_NOT_FOUND_IN_WE_VOTE)
  "twitter_name": string, (ONLY RETURNED FOR kind_of_owner == TWITTER_HANDLE_NOT_FOUND_IN_WE_VOTE)
}

Try It Now: API Variables

Find the kind of owner and unique id of this twitter handle, whether it be a candidate, organization, or individual voter. We use this to take an incoming URI like https://wevote.guide/RepBarbaraLee and return the owner of 'RepBarbaraLee'.

Parameter name Value  
twitter_handle:

(opens in new window)