Facilities

Search facilities, the user's country first

One ranked stream of matches with the preferred country's facilities ahead of every other country, cut into pages. Each page is split into facilities (preferred country) and other_facilities (everyone else). The preferred country is country when given, otherwise the player's own; an admin without country has none, and then everything is under facilities. An unknown country is a 400.

get/v1/facilities/search

Request

  • Base URL
    https://api.hify.club
  • Auth
    API key in header X-User-Token

Query parameters

qstring required
latnumber
lngnumber
countrystring
Example:AE

ISO 3166-1 alpha-2 code of the preferred country.

pageinteger
per_pageinteger

Response

A page of matches split by country; X-Total-Count and X-Total-Pages describe the whole stream

facilitiesobject[]
other_facilitiesobject[]

Changes

No recorded changes to this operation across all 1 revision of this API.