Response Modules

Learn more about how to leverage modules to customize responses.

The Geolocated.io API supports a modules parameter across all three of its API endpoints, allowing you to specify which parts of the geolocation data you wish to receive. This feature is particularly useful for applications requiring only specific information about a geolocated IP address. This helps to save bandwidth and improve response times.

Instead of receiving the entire dataset, you can specify the exact pieces of information relevant to your application's needs. For example, if your application only needs the timezone information for a user, you can request just the time module, excluding other details like the country or city. This selective data retrieval not only makes your responses more concise but also enhances the overall performance of your application by minimizing the amount of data transferred.

Requesting a Specific Module

ParameterDescription
endpointAny of the three endpoints.
module_nameThe name of the module to be retrieved. Available module names are:
  • essential
  • location
  • currency
  • language
  • time
  • connection

Supported Modules

The following modules are supported by Geolocated.io APIs.

  • essential: Returns only the absolutely minimum fields necessary for geolocating an IP. The response includes the fields demonstrated in the following example:
  • location: Provides comprehensive information about the country identified from the geolocated IP address. The response includes the fields demonstrated in the following example:
  • currency: Delivers currency information related to the country identified from the IP address.
  • language: Provides the primary list of languages spoken in the geolocated country, with their corresponding ISO 639-1 & ISO 639-2 codes.
  • time: Returns timezone information for the area geolocated using the IP.
  • connection: Provides details about the ISP of the IP address.
Contents