Application API Search parameters

#Search Control Parameters

This sections documents the common control parameters that nearly all search operations accept. Exceptions are noted in specific search API pages, both in terms of additional parameters and unsupported common parameters.

Most of these control parameters are only supported in POST operations (which all search calls should be using, rather than the older GET operations).

Control Parameters

• cull_age (boolean) [optional: default false] - whether to cull results that are outside the specified age range (which may be that implied by the member’s My Match criteria if the search does not accept an explicit age range).
• excludes (string or array of string) [optional: default []] - additionally exclude the specified sets of member profiles from the results:
  • pending-likes-me – members who have liked the searcher (that have not yet been accepted or declined),
  • pending-my-likes – members who have been liked by the searcher (and have not yet accepted or declined that),
  • mutual-likes – members who have a connection with with searcher,
  • declined-me – members who have declined a like from the searcher,
  • my-declines – members whose like the searcher has declined,
  • seen-not-liked – members that were shown to the searcher in the Slideshow API that the seacher skipped over (did not indicate liking),
  • blocked-me – members that have blocked the searcher,
  • my-blocks – members that have been blocked by the searcher,
  • likes – a shorthand for [pending-likes-me, pending-my-likes, mutual-likes],
  • declines – a shorthand for [declined-me my-declines],
  • blocks – a shorthand for [blocked-me my-blocks].
  • In the absence of specific excludes, each search operation has its own default value (which is typically blocks, although some search operations exclude more than that by default).
• ids_only (boolean) [optional: default false] - if true, the results include only the "id" key rather than the full User Status Information.
• includes (string or array of string) [optional: default []] - suppress the default exclusion of the specified sets of member profiles. Accepts the same values as excludes above.
• lane (numeric) [optional: default 1] - the lane indicates whether the search is for just the current site’s members (1) or for all World+ members (2). For a site that does not have search lanes, this parameter is ignored. For a search operation that doesn’t distinguish between World+ and other members, this parameter is ignored.
• omit (array of numeric) [optional: default []] - a list of member IDs to omit from the results, may be useful for clients that need to exclude the results of one search from another search that is being displayed at the same time.
• page (numeric) [optional: default 1] - in conjunction with pagesize, returns next n set of results.
• pagesize (numeric) [optional: default 15] - the number of results to return per page.
• photos (boolean) [optional: default true] - Return profiles with photos only, specify false to return profiles without approved photos.
• sortby (string) [optional: the default is typically latest or relevance – see the specific search operation for details]. Can be any one of the following:
  • activator – sort by descending activator score (this is internally calculated based on rules defined by World Singles, concerning member activity on the site),
  • activity – sort by most recent login date/time,
  • age – sort by age ascending,
  • distance (or distance-activator) triggers addition of the distance field to the search results and sorts either by distance (ascending) or distance + activator score (distance ascending, score descending)
  • newest – sort by most recent registration date/time,
  • relevance – sort by descending order of search criteria relevance (this is internally calculated as a fuzzy match score based on the criteria provided),
  • username – sort by username (nickname).