Editing Module:Sensitive IP addresses/API/doc (section)

=== Sensitive IPs object ===

If the query was successful, the <code>sensitiveips</code> child object will be present and can contain the following objects and arrays:
* <code>matches</code> - an array of [[#IP address objects|IP address objects]] or [[#IP range objects|IP range objects]], where the corresponding IP address or IP range string was specified in the <code>test</code> query option, and where Wikipedia regards that IP address or IP range as being sensitive. If no IPs or ranges were tested for, or if no matches were found, this array will not be present in the results.
* <code>matched-ranges</code> - an object with [[CIDR]] IP range strings as keys, and matched-range objects as values, where the IP range matches one of the IP addresses or IP ranges tested for with the <code>test</code> query option. If no IPs or ranges were tested for, or if no matches were found, this object will not be present.
* <code>entities</code> - an object with entity IDs as keys, and [[#Entity objects|entity objects]] as values. An entity is a country or organization which has IP addresses that Wikipedia considers sensitive. Entity IDs are defined in [[Module:Sensitive IP addresses/list]]; for example, <code>ushr</code> is the ID for the [[United States House of Representatives]]. Entities will be included in this object if an IP range belonging to them is matched by one of the IP addresses or IP ranges tested for with the <code>test</code> query option, or if their entity ID is specified in the <code>entities</code> query option.
* <code>entity-ids</code> - an array of entity ID strings, in the order they are defined in [[Module:Sensitive IP addresses/list]]. The entity IDs in this array correspond one-to-one with the entity ID keys of the <code>entities</code> result object. This array can be useful for outputting the IDs in the same order that they were defined in the list.