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

== Parameters ==

The following parameters are available to the query function:

* <code>test</code> - an array of IP addresses and/or IP ranges to test for sensitivity. IP addresses and ranges can be [[IPv4]] or [[IPv6]], and ranges must be in [[CIDR notation]].
* <code>entities</code> - an array of entity IDs to get information about. An ''entity'' is a country or organization which is considered sensitive, and for which blocks should be handled with care. Entity IDs are defined in [[Module:Sensitive IP addresses/list]] along with the rest of the sensitive IP data. For example, <code>ushr</code> is the ID for the [[United States House of Representatives]]. If the special ID <code>all</code> is contained in the array, information about all entities will be included in the result.
* <code>format</code> - the format to return results in. Use <code>json</code> to return a [[JSON]]-formatted string, and use <code>lua</code> to return a Lua table. If this option is not specified, a Lua table is returned by default.