ver. 1958 (4e4db56)
services/apiref
services/apisrv
services/attrs
services/caches
services/caches/formatters
services/caches/map
services/caches/search
services/caches/shortcuts
services/logs
services/logs/images
services/oauth
services/replicate
services/users

Get the list of all public OKAPI installations
:: services/apisrv/installations method

Minimum Authentication: Level 0 (see Authentication Levels)
https://www.opencaching.us/okapi/services/apisrv/installations
Get the list of all public OKAPI installations. Keep in mind that OKAPI installations might differ slightly. If you plan on using multiple OKAPI installations in your application (which is a very good thing!) you should test it against the one with the lowest OKAPI version number.
format optional Standard common formatting argument.
callback optional Standard common formatting argument.
No additional authentication parameters are required.

Returned value:

A dictionary of the following structure:

  • site_url - URL of the Opencaching site which is running the OKAPI installation (usually this looks like "https://www.opencaching.xx/", where xx is a top level domain of a country).

    Once OKAPI maintainers are notified that this particular site supports HTTPS, this field will return a HTTPS URL from then on. Otherwise, HTTP URL will be returned.

  • site_name - universal name for this site (should be fine for all languages),
  • okapi_base_url - URL of the OKAPI installation (usually this is site_url with "okapi/" appended, but you should not assume that); this value is to be used as a prefix when constructing service method URLs.

    Once OKAPI maintainers are notified that this particular site supports HTTPS, this field will return a HTTPS URL from then on. Otherwise, HTTP URL will be returned.