Islands on the Air - API - Group Information Lookup
banner

Status

The following method is under test. You are welcome to use it for development work, but it should not be considered stable enough for production use at present.

Public API Method for IOTA Group Information

Introduction

This page contains documentation for obtaining IOTA Group information via the public API. This is a search function; the full Group Enumeration can also be downloaded (Full list: IOTA XML; Short list: CSV). Before using this API method, please ensure that you are familiar with the explanatory notes about the IOTA list.

All public methods

Use

The API is located at http://www.rsgbiota.org/api/grp.xml. It takes queries as GET requests. The following queries are valid:

  • refno - An IOTA reference number (Format: AF-001)
  • cont - Only return results from a specific continent (Valid values: AF, AN, AS, EU, NA, OC, SA)
  • not-cont - Do not return results from a specific continent (Valid values as for the cont query)
  • wanted - If set to binary 1, limits results to groups which are defined as rare in the rules (currently those which have been claimed by 15% of participants of a score greater than 100). (Valid values: 0, 1. If omitted, '0' is default.)
  • max-worked - If set, only returns groups which have been claimed by fewer than this percentage of participants, with a score greater than 100). (Valid values: Integer between 1 and 100. If omitted, 100 is default.)
  • region - Only return groups which are valid for the specified IOTA regional award. (Valid values: AI, BI, WI)
  • newone - If set to binary 1, limits results to groups which have not yet been activated. (Valid values: 0, 1. If omitted '0' is default.)
  • prefix - If set, only returns groups which are listed for this prefix.

Data Format and Cacheing

The method returns data in IOTA XML. Please cache results for six months after fetching.

Examples