API Objects¶
The classes and functions documented on this page constitute the public API to the okcupyd library.
User¶
User serves as the primary entry point to the okcupyd library. Most of the objects mentioned on this page are accessible in some way or another from instances of User.
- class okcupyd.user.User(session=None)[source]¶
Encapsulate a logged in okcupid user.
- __init__(session=None)[source]¶
Parameters: session (Session) – The session which will be used for interacting with okcupid.com If none is provided, one will be instantiated automatically with the credentials in settings
- inbox = None¶
A Fetchable of MessageThread objects corresponding to messages that are currently in the user’s inbox.
- outbox = None¶
A Fetchable of MessageThread objects corresponding to messages that are currently in the user’s outbox.
- drafts = None¶
A Fetchable of MessageThread objects corresponding to messages that are currently in the user’s drafts folder.
- visitors = None¶
A Fetchable of Profile objects of okcupid.com users that have visited the user’s profile.
- attractiveness_finder = None¶
An _AttractivenessFinder object that is instantiated with the owning User instance’s session.
- photo = None¶
A PhotoUploader that is instantiated with the owning User instance’s session.
- get_profile(username)[source]¶
Get the Profile associated with the supplied username.
Parameters: username – The username of the profile to retrieve.
- message(username, message_text)[source]¶
Message an okcupid user. If an existing conversation between the logged in user and the target user can be found, reply to that thread instead of starting a new one.
Parameters:
- search(**kwargs)[source]¶
Call SearchFetchable() to get a Fetchable object that will lazily perform okcupid searches to provide Profile objects matching the search criteria.
Defaults for gender, gentation, location and radius will be provided if none are given.
Parameters: kwargs – See the SearchFetchable() docstring for details about what parameters are available.
- delete_threads(thread_ids_or_threads)[source]¶
Call delete_threads().
Parameters: thread_ids_or_threads – A list whose members are either MessageThread instances or okc_ids of message threads.
- get_user_question(question, fast=False, bust_questions_cache=False)[source]¶
Get a UserQuestion corresponding to the given Question.
HUGE CAVEATS: If the logged in user has not answered the relevant question, it will automatically be answered with whatever the first answer to the question is.
For the sake of reducing the number of requests made when this function is called repeatedly this function does not bust the cache of this User‘s okcupyd.profile.Profile.questions attribute. That means that a question that HAS been answered could still be answered by this function if this User‘s questions was populated previously (This population happens automatically – See Fetchable for details about when and how this happens).
Parameters: - question (BaseQuestion) – The question for which a UserQuestion should be retrieved.
- fast (bool) – Don’t try to look through the users existing questions to see if arbitrarily answering the question can be avoided.
- bust_questions_cache (bool) – clear the questions attribute of this users Profile before looking for an existing answer. Be aware that even this does not eliminate all race conditions.
- get_question_answer_id(question, fast=False, bust_questions_cache=False)[source]¶
Get the index of the answer that was given to question
See the documentation for get_user_question() for important caveats about the use of this function.
Parameters: - question (BaseQuestion) – The question whose answer_id should be retrieved.
- fast (bool) – Don’t try to look through the users existing questions to see if arbitrarily answering the question can be avoided.
- bust_questions_cache (bool) –
param bust_questions_cache: clear the questions attribute of this users Profile before looking for an existing answer. Be aware that even this does not eliminate all race conditions.
Profile¶
- class okcupyd.profile.Profile(session, username, **kwargs)[source]¶
Represent the profile of an okcupid user.
Many of the attributes on this object are cached_property instances which lazily load their values, and cache them once they have been accessed. This makes it so that this object avoids making unnecessary HTTP requests to retrieve the same piece of information twice.
Because of this caching behavior, care must be taken to invalidate cached attributes on the object if an up to date view of the profile is needed. It is recommended that you call refresh() to accomplish this, but it is also possible to use bust_self() to bust individual properties if necessary.
- username = None¶
The username of the user to whom this profile belongs.
- questions = None¶
A Fetchable of Question instances, each corresponding to a question that has been answered by the user to whom this profile belongs. The fetchable consists of UserQuestion instead when the profile belongs to the logged in user.
- refresh(reload=False)[source]¶
Parameters: reload – Make the request to return a new profile tree. This will result in the caching of the profile_tree attribute. The new profile_tree will be returned.
- is_logged_in_user[source]¶
Returns: True if this profile and the session it was created with belong to the same user and False otherwise.
- profile_tree[source]¶
Returns: a lxml.etree created from the html of the profile page of the account associated with the username that this profile was insantiated with.
- looking_for[source]¶
Returns: A LookingFor instance associated with this profile.
- rating[source]¶
Deprecated. Use liked() instead.
Returns: the rating that the logged in user has given this user or 0 if no rating has been given.
- contacted[source]¶
Retuns: A boolean indicating whether the logged in user has contacted the owner of this profile.
- responds[source]¶
Returns: The frequency with which the user associated with this profile responds to messages.
- match_percentage[source]¶
Returns: The match percentage of the logged in user and the user associated with this object.
- enemy_percentage[source]¶
Returns: The enemy percentage of the logged in user and the user associated with this object.
- message[source]¶
Message the user associated with this profile.
Parameters: - message – The message to send to this user.
- thread_id – The id of the thread to respond to, if any.
- attractiveness[source]¶
Returns: The average attractiveness rating given to this profile by the okcupid.com community.
- rate(rating)[source]¶
Rate this profile as the user that was logged in with the session that this object was instantiated with.
Parameters: rating – The rating to give this user.
- find_question(question_id, question_fetchable=None)[source]¶
Parameters: - question_id – The id of the question to search for
- question_fetchable – The question fetchable to iterate through if none is provided self.questions will be used.
- question_fetchable(**kwargs)[source]¶
Returns: A Fetchable instance that contains objects representing the answers that the user associated with this profile has given to okcupid.com match questions.
LookingFor¶
- class okcupyd.looking_for.LookingFor(profile)[source]¶
Represent the looking for attributes belonging to an okcupid.com profile.
- update(ages=None, single=None, near_me=None, kinds=None, gentation=None)[source]¶
Update the looking for attributes of the logged in user.
Parameters: - ages (tuple) – The ages that the logged in user is interested in.
- single (bool) – Whether or not the user is only interested in people that are single.
- near_me (bool) – Whether or not the user is only interested in people that are near them.
- kinds (list) – What kinds of relationships the user should be updated to be interested in.
- gentation (str) – The sex/orientation of people the user is interested in.
Details¶
- class okcupyd.details.Details(profile)[source]¶
Represent the details belonging to an okcupid.com profile.
- bodytype¶
The bodytype detail of an okcupid.com user’s profile.
- orientation¶
The orientation detail of an okcupid.com user’s profile.
- smokes¶
The smoking detail of an okcupid.com user’s profile.
- drugs¶
The drugs detail of an okcupid.com user’s profile.
- drinks¶
The drinking detail of an okcupid.com user’s profile.
- job¶
The job detail of an okcupid.com user’s profile.
- status¶
The status detail of an okcupid.com user’s profile.
- monogamy¶
The monogamous detail of an okcupid.com user’s profile.
- children¶
The children detail of an okcupid.com user’s profile.
- education¶
The education detail of an okcupid.com user’s profile.
- pets¶
The pets detail of an okcupid.com user’s profile.
- diet¶
The diet detail of an okcupid.com user’s profile.
- religion¶
The religion detail of an okcupid.com user’s profile.
- sign¶
The sign detail of an okcupid.com user’s profile.
- height¶
The height detail of an okcupid.com user’s profile.
Essays¶
- class okcupyd.essay.Essays(profile)[source]¶
Interface to reading and writing essays.
- self_summary¶
The contents of the essay labeled ‘Self Summary’. Write to this attribute to change its value for the logged in user.
- my_life¶
The contents of the essay labeled ‘What I’m doing with my life’. Write to this attribute to change its value for the logged in user.
- good_at¶
The contents of the essay labeled ‘I’m really good at’. Write to this attribute to change its value for the logged in user.
- people_first_notice¶
The contents of the essay labeled ‘The first thing people notice about me’. Write to this attribute to change its value for the logged in user.
- favorites¶
The contents of the essay labeled ‘Favorite books, movies, shows, music, and food’. Write to this attribute to change its value for the logged in user.
- six_things¶
The contents of the essay labeled ‘Six things I could never live without’. Write to this attribute to change its value for the logged in user.
- think_about¶
The contents of the essay labeled ‘I spend a lot of time thinking about’. Write to this attribute to change its value for the logged in user.
- friday_night¶
The contents of the essay labeled ‘On a typical friday night I am’. Write to this attribute to change its value for the logged in user.
- private_admission¶
The contents of the essay labeled ‘The most private thing I’m willing to admit’. Write to this attribute to change its value for the logged in user.
- message_me_if¶
The contents of the essay labeled ‘You should message me if’. Write to this attribute to change its value for the logged in user.
- essay_names = ['self_summary', 'my_life', 'good_at', 'people_first_notice', 'favorites', 'six_things', 'think_about', 'friday_night', 'private_admission', 'message_me_if']¶
A list of the attribute names that are used to store the text of of essays on instances of this class.
PhotoUploader¶
- class okcupyd.photo.PhotoUploader(session=None, user_id=None, authcode=None)[source]¶
Upload photos to okcupid.com.
- upload_and_confirm(incoming, **kwargs)[source]¶
Upload the file to okcupid and confirm, among other things, its thumbnail position.
Parameters: - incoming – A filepath string, Info object or a file like object to upload to okcupid.com. If an info object is provided, its thumbnail positioning will be used by default.
- caption – The caption to add to the photo.
- thumb_nail_left – For thumb nail positioning.
- thumb_nail_top – For thumb nail positioning.
- thumb_nail_right – For thumb nail positioning.
- thumb_nail_bottom – For thumb nail positioning.
Info¶
- class okcupyd.photo.Info(photo_id, tnl, tnt, tnr, tnb)[source]¶
Represent a photo that appears on a okcupid.com user’s profile.
- thumb_nail_left = None¶
The horizontal position of the left side of this photo’s thumbnail.
- thumb_nail_top = None¶
The vertical position of the top side of this photo’s thumbnail.
- thumb_nail_right = None¶
The horizontal position of the right side of this photo’s thumbnail.
- thumb_nail_bottom = None¶
The vertical position of the bottom side of this photo’s thumbnail.
MessageThread¶
- class okcupyd.messaging.MessageThread(session, thread_element)[source]¶
Represent a message thread between two users.
- classmethod delete_threads(session, thread_ids_or_threads, authcode=None)[source]¶
Parameters: - session – A logged in Session.
- thread_ids_or_threads – A list whose members are either MessageThread instances or okc_ids of message threads.
- authcode – Authcode to use for this request. If none is provided A request to the logged in user’s messages page will be made to retrieve one.
- correspondent[source]¶
Returns: The username of the user with whom the logged in user is conversing in this MessageThread.
- read[source]¶
Returns: Whether or not the user has read all the messages in this MessageThread.
- initiator[source]¶
Returns: A Profile instance belonging to the initiator of this MessageThread.
- respondent[source]¶
Returns: A Profile instance belonging to the respondent of this MessageThread.
- correspondent_profile[source]¶
Returns: The Profile of the user with whom the logged in user is conversing in this MessageThread.
- got_response[source]¶
Returns: Whether or not the MessageThread. has received a response.
Message¶
Questions¶
- class okcupyd.question.Questions(session, importances=('not_important', 'little_important', 'somewhat_important', 'very_important', 'mandatory'), user_id=None)[source]¶
Interface to accessing and answering questions belonging to the logged in user.
- mandatory¶
A Fetchable of UserQuestion instances that correspond to questions that have been answered by the logged in user and assigned the ‘mandatory’ importance.
- very_important¶
A Fetchable of UserQuestion instances that correspond to questions that have been answered by the logged in user and assigned the ‘very_important’ importance.
- somewhat_important¶
A Fetchable of UserQuestion instances that correspond to questions that have been answered by the logged in user and assigned the ‘somewhat_important’ importance.
- little_important¶
A Fetchable of UserQuestion instances that correspond to questions that have been answered by the logged in user and assigned the ‘little_important’ importance.
- not_important¶
A Fetchable of UserQuestion instances that correspond to questions that have been answered by the logged in user and assigned the ‘not_important’ importance.
- importance_name_to_number = {'not_important': 5, 'little_important': 4, 'mandatory': 0, 'very_important': 1, 'somewhat_important': 3}¶
Human readable importance name to integer used to represent them on okcupid.com
- respond_from_user_question(user_question, importance)[source]¶
Respond to a question in exactly the way that is described by the given user_question.
Parameters: - user_question (UserQuestion) – The user question to respond with.
- importance (int see importance_name_to_number) – The importance that should be used in responding to the question.
- respond_from_question(question, user_question, importance)[source]¶
Copy the answer given in question to the logged in user’s profile.
Parameters: - question – A Question instance to copy.
- user_question – An instance of UserQuestion that corresponds to the same question as question. This is needed to retrieve the answer id from the question text answer on question.
- importance – The importance to assign to the response to the answered question.
- respond(question_id, user_response_ids, match_response_ids, importance, note='', is_public=1, is_new=1)[source]¶
Respond to an okcupid.com question.
Parameters: - question_id – The okcupid id used to identify this question.
- user_response_ids – The answer id(s) to provide to this question.
- match_response_ids – The answer id(s) that the user considers acceptable.
- importance – The importance to attribute to this question. See importance_name_to_number for details.
- note – The explanation note to add to this question.
- is_public – Whether or not the question answer should be made public.
Question¶
- class okcupyd.question.Question(question_element)[source]¶
Represent a question answered by a user other than the logged in user.
Note: Because of the way that okcupid presents question data it is actually not very easy to get the index of the answer to a question that belongs to a user other than the logged in user. It is possible to retrieve this value (see okcupyd.user.User.get_question_answer_id() and get_answer_id_for_question()), but it can take quite a few requests to do so. For this reason, the answer_id is NOT included as an attribute on this object, despite its inclusion in UserQuestion.
- their_answer[source]¶
The answer that the user whose Profile this question was retrieved from provided to this Question.
- my_answer[source]¶
The answer that the user whose Session was used to create this Question provided.
- their_answer_matches[source]¶
Returns: whether or not the answer provided by the user answering the question is acceptable to the logged in user. Return type: rbool
- my_answer_matches[source]¶
Returns: bool indicating whether or not the answer provided by the logged in user is acceptable to the user answering the question.
UserQuestion¶
- class okcupyd.question.UserQuestion(question_element)[source]¶
Represent a question answered by the logged in user.
- get_answer_id_for_question(question)[source]¶
Get the answer_id corresponding to the answer given for question by looking at this UserQuestion‘s answer_options. The given Question instance must have the same id as this UserQuestion.
That this method exists is admittedly somewhat weird. Unfortunately, it seems to be the only way to retrieve this information.
- answer_options[source]¶
Returns: A list of AnswerOption instances representing the available answers to this question.
- explanation[source]¶
Returns: The explanation written by the logged in user for this question (if any).
- answer[source]¶
Returns: A AnswerOption instance corresponding to the answer the user gave to this question.
AnswerOption¶
SearchFetchable()¶
- okcupyd.search.SearchFetchable(session=None, **kwargs)[source]¶
Search okcupid.com with the given parameters. Parameters are registered to this function through register_filter_builder() of search_filters.
Returns: Parameters: - session (Session) – A logged in session.
- location – A location string which will be used to filter results.
- gender – The gender of the user performing the search.
- keywords – A list or space delimeted string of words to search for.
- order_by – The criteria to use for ordering results. expected_values: ‘match’, ‘online’, ‘special_blend’
- age_max (int) – The maximum age of returned search results.
- age_min (int) – The minimum age of returned search results.
- attractiveness_max (int) – The maximum attractiveness of returned search results.
- attractiveness_min (int) – The minimum attractiveness of returned search results.
- bodytype (str) – expected values: ‘jacked’, ‘rather not say’, ‘fit’, ‘athletic’, ‘used up’, ‘average’, ‘full figured’, ‘overweight’, ‘curvy’, ‘thin’, ‘a little extra’, ‘skinny’
- cats (str) – expected values: ‘likes cats’, ‘dislikes cats’, ‘has cats’
- diet (str) – expected values: ‘anything’, ‘vegetarian’, ‘vegan’, ‘kosher’, ‘other’, ‘halal’
- dogs (str) – expected values: ‘dislikes dogs’, ‘has dogs’, ‘likes dogs’
- drinks (str) – expected values: ‘desperately’, ‘often’, ‘socially’, ‘very often’, ‘not at all’, ‘rarely’
- drugs (str) – expected values: ‘never’, ‘often’, ‘sometimes’
- education_level (str) – expected values: ‘law school’, ‘two[- ]year college’, ‘university’, ‘space camp’, ‘high ?school’, ‘college’, ‘ph.d program’, ‘med school’, ‘masters program’
- ethnicities (str) – expected values: ‘latin’, ‘pacific islander’, ‘middle eastern’, ‘hispanic’, ‘indian’, ‘black’, ‘asian’, ‘white’, ‘other’, ‘native american’
- gentation (str) – The gentation of returned search results. expected values: ‘men and women who like bi women’, ‘gay girls only’, ‘bi guys only’, ‘gay guys only’, ‘’, ‘straight girls only’, ‘women who like men’, ‘bi men and women’, ‘guys who like girls’, ‘straight guys only’, ‘bi girls only’, ‘men and women who like bi men’, ‘guys and girls who like bi guys’, ‘both who like bi women’, ‘gay women only’, ‘gay men only’, ‘women’, ‘everybody’, ‘straight men only’, ‘girls who like girls’, ‘bi men only’, ‘both who like bi men’, ‘bi women only’, ‘guys who like guys’, ‘bi guys and girls’, ‘guys and girls who like bi girls’, ‘both who like bi guys’, ‘men who like women’, ‘girls who like guys’, ‘women who like women’, ‘both who like bi girls’, ‘straight women only’, ‘men who like men’
- has_kids – expected values: ‘has a kid’, “doesn’t have kids”, ‘has kids’
- height_max – The maximum height of returned search results. expected values: ‘A height int in inches’, ‘An imperial height string e.g. 5‘4”’, ‘A metric height string e.g. 1.54m’
- height_min – The minimum height of returned search results. expected values: ‘A height int in inches’, ‘An imperial height string e.g. 5‘4”’, ‘A metric height string e.g. 1.54m’
- income (str) – expected values: ‘$30,000-$40,000’, ‘$20,000-$30,000’, ‘$80,000-$100,000’, ‘$100,000-$150,000’, ‘$250,000-$500,000’, ‘less than $20,000’, ‘More than $1,000,000’, ‘$500,000-$1,000,000’, ‘$60,000-$70,000’, ‘$70,000-$80,000’, ‘$40,000-$50,000’, ‘$50,000-$60,000’, ‘$150,000-$250,000’
- job (str) – expected values: ‘art’, ‘sales’, ‘engineering’, ‘politics’, ‘education’, ‘technology’, ‘management’, ‘entertainment’, ‘media’, ‘administration’, ‘writing’, ‘other’, ‘music’, ‘medicine’, ‘transportation’, ‘finance’, ‘retired’, ‘government’, ‘marketing’, ‘unemployed’, ‘construction’, ‘student’, ‘hospitality’, ‘law’, ‘rather not say’, ‘science’, ‘banking’, ‘military’
- join_date (int) – expected values: ‘week’, ‘year’, ‘day’, ‘hour’, ‘month’
- language – expected values: ‘portuguese’, ‘irish’, ‘chinese’, ‘czech’, ‘slovenian’, ‘sign language’, ‘hebrew’, ‘indonesian’, ‘rotuman’, ‘spanish’, ‘maori’, ‘slovak’, ‘mongolian’, ‘basque’, ‘urdu’, ‘polish’, ‘arabic’, ‘hungarian’, ‘esperanto’, ‘breton’, ‘italian’, ‘belarusan’, ‘icelandic’, ‘estonian’, ‘gujarati’, ‘occitan’, ‘serbian’, ‘sardinian’, ‘ancient greek’, ‘german’, ‘other’, ‘chechen’, ‘dutch’, ‘sanskrit’, ‘korean’, ‘farsi’, ‘hindi’, ‘danish’, ‘bulgarian’, ‘latin’, ‘khmer’, ‘latvian’, ‘hawaiian’, ‘ukrainian’, ‘welsh’, ‘georgian’, ‘lithuanian’, ‘malay’, ‘french’, ‘japanese’, ‘catalan’, ‘armenian’, ‘yiddish’, ‘swedish’, ‘russian’, ‘vietnamese’, ‘thai’, ‘afrikaans’, ‘tamil’, ‘cebuano’, ‘tagalog’, ‘finnish’, ‘norwegian’, ‘lisp’, ‘albanian’, ‘turkish’, ‘ilongo’, ‘romanian’, ‘c++’, ‘greek’, ‘persian’, ‘tibetan’, ‘frisian’, ‘english’, ‘croatian’, ‘swahili’, ‘bengali’
- last_online (str) – expected values: ‘day’, ‘today’, ‘week’, ‘month’, ‘year’, ‘decade’
- monogamy (str) – expected values: ‘(:?[^\-]monogamous)|(:?^monogamous)’, ‘non-monogamous’
- question (UserQuestion) – A question whose answer should be used to match search results, or a question id. If a question id, question_answers must be supplied.
- question_answers (list) – A list of acceptable question answer indices.
- question_count_min (int) – The minimum number of questions answered by returned search results.
- radius (int) – The maximum distance from the specified location of returned search results.
- religion (str) – expected values: ‘judaism’, ‘catholicism’, ‘buddhism’, ‘christianity’, ‘atheism’, ‘agnosticism’, ‘other’, ‘hinduism’, ‘islam’
- sign (str) – expected values: ‘libra’, ‘sagittarius’, ‘cancer’, ‘scorpio’, ‘aquarius’, ‘taurus’, ‘leo’, ‘virgo’, ‘capricorn’, ‘gemini’, ‘aries’, ‘pisces’
- smokes (str) – expected values: ‘yes’, ‘sometimes’, ‘trying to quit’, ‘no’, ‘when drinking’
- status (str) – The relationship status of returned search results. expected values: ‘not single’, ‘married’, ‘single’, ‘any’
- wants_kids – expected values: ‘wants’, “doesn’t want”, ‘might want’
_AttractivenessFinder¶
Copy¶
- class okcupyd.profile_copy.Copy(source_profile_or_user, dest_user)[source]¶
Copy photos, essays and other attributes from one profile to another.
- __init__(source_profile_or_user, dest_user)[source]¶
Parameters: - source_profile_or_user – A User or Profile object from which to copy attributes. questions() will not will not preserve the importance of copied questions if a Profile instance is provided.
- dest_user – A User to which data will be copied
- questions()[source]¶
Copy questions to the destination user. When this class was initialized with a Profile, this will delete any existing questions answers on the destination account.
- looking_for()[source]¶
Copy looking for attributes from the source profile to the destination profile.
- all()[source]¶
Invoke all of questions(), details(), essays(), photos(), looking_for()