To save bandwidth and speed up response times, the Ipregistry API's
fields parameter can be used to limit API results to a set of fields.
This parameter is supported by all API endpoints. To use this feature, append the
fields parameter to your API request URL and specify as value the fields to return, separated by a comma.
JSONresponses only. If you set
XMLas output format, the
fieldsparameter will be ignored.
curl -s "https://api.ipregistry.co/?key=tryout&fields=location.country" | jq ".location.country.code"
Selecting a single field
For instance, returning connection information and its subfields:
Selecting multiple fields
Separate a series of fields with a comma:
Selecting a single nested field
Use the dot syntax to access a single nested field:
The dot syntax works for multi-level accesses:
Selecting multiple nested fields
You can combine the dot syntax and commas:
In the case you want to return several fields from the same level, use square brackets
%5Dare respectively the encoded version of
In order to exclude fields, you need to prefix the field name with a minus sign
Since the value of an empty field performs an empty selection, you may need to first select all fields before applying exclusions:
In case you exclude fields using the dot syntax, the exclusion applies to the last field.