Customize Modules

Use the params parameter to ask for exactly the extra data you need and keep responses small.

How it works#

Some methods, mainly IP Geolocation and IP Lookup, return a base set of fields and a number of optional modules. The base fields are always included. To add modules, list them in params, separated by commas.

# only the device module
curl "https://gurdx.cretip.com/api/geoip?key=YOUR_API_KEY&params=device"

# several modules
curl "https://gurdx.cretip.com/api/geoip?key=YOUR_API_KEY&params=timezone,currency,security"

The parameter name parms is also accepted as an alias. Module names are case-insensitive and unknown names are ignored.

Available modules#

The Country Lookup method has its own modules (currency, timezone, language, flag); when no params are given it returns all of them.

Plan requirements#

The security module requires the security feature on your plan. If it is missing, the request fails with error 114 security_module_not_allowed. Other modules are available on every plan that includes the method.

Example response#

{
  "data": {
    "ip": "203.0.113.7",
    "countryCode": "SA",
    "security": {
      "proxy": false,
      "vpn": false,
      "tor": false
    }
  },
  "status": "success",
  "executionTime": 18
}

Field names inside each module are listed on the page of the method that returns it.

Combining options#

params works together with the other options:

curl "https://gurdx.cretip.com/api/geoip?key=YOUR_API_KEY&params=security,timezone&lang=AR&format=JSON"

Tip: Request only the modules you use. Smaller responses are faster and cheaper to parse.