EasyAPI (1.0.0)

Explore a versatile platform that not only decodes IP addresses but also offers geolocation insights, detailed address data, timezone references, and a future roadmap packed with validators for IBAN, emails, phone numbers, and more.

Welcome to EasyAPI's documentation. Our platform serves as a powerful tool to not only gather in-depth details about IP addresses but also to delve into geolocation insights, fetch detailed address information, and reference timezones. As we constantly evolve, our roadmap promises the introduction of validators for IBANs, emails, phone numbers, and a plethora of other functionalities. This document is designed to be your comprehensive guide, walking you through API authentication, rate limits, and more. Catering to both veteran developers and newcomers alike, we aim to provide all the resources you'll need to maximize the benefits of the EasyAPI service.

The use of EasyAPI requires authentication to ensure secure and efficient data retrieval.

How to obtain an API key

1. Navigate to EasyAPI's Dashboard.
2. If you're not already a member, create an account and select an appropriate membership. Each membership has its unique set of credits.
3. Once logged in, you'll find your API key on the dashboard. This unique identifier is necessary for making requests to the EasyAPI endpoints.

Note: Keep your API key secure. If you believe your key has been compromised, you can regenerate a new key from the dashboard at any time.

How to use API key to make requests

To use the API key in making requests, simply append it to your GET query by using the api_key parameter.

Example Request:

GET https://api.easyapi.io/v1.0/ip?api_key=YOUR_API_KEY_HERE

Example Response:

{
   "class":"ip_info",
   "properties":{
      "ip":"82.84.2.2",
      "location":"45.4317,10.9859",
      "postal":"37138",
      "city":"Verona",
      "country":"Italy",
      "country_code":"IT",
      "state":"Province of Verona",
      "state_code":"VR",
      "datetime":{
         "date":"08/17/2023",
         "date_time":"08/17/2023 17:24:03",
         "date_time_txt":"Thursday, August 17, 2023 17:24:03",
         "date_time_wti":"Thu, 17 Aug 2023 17:24:03 +0200",
         "date_time_ymd":"2023-08-17T17:24:03+0200",
         "day":"17",
         "day_abbr":"Thu",
         "day_full":"Thursday",
         "day_wilz":"17",
         "hour_12_wilz":"05",
         "hour_12_wolz":"5",
         "hour_24_wilz":"17",
         "hour_24_wolz":"17",
         "hour_am_pm":"pm",
         "minutes":"24",
         "month":"08",
         "month_abbr":"Aug",
         "month_days":"17",
         "month_full":"August",
         "month_wilz":"08",
         "seconds":"03",
         "time":"17:24:03",
         "week":"33",
         "year":"2023",
         "year_abbr":"23"
      },
      "timezone":{
         "capital":"Rome",
         "continent":"EU",
         "country":"Italy",
         "country_code":"IT",
         "currency_alpha_code":"EUR",
         "currency_code":"978",
         "currency_country_minor_unit":"2",
         "currency_country_name":"ITALY",
         "currency_name":"Euro",
         "ds":"I",
         "edgar":"L6",
         "fifa":"ITA",
         "fips":"IT",
         "gaul":"122",
         "geoname_id":"3175395",
         "id":"Europe/Rome",
         "independent":true,
         "ioc":"ITA",
         "iso3166_1_alpha_2":"IT",
         "iso3166_1_alpha_3":"ITA",
         "itu":"I",
         "languages":"it-IT,de-IT,fr-IT,sc,ca,co,sl",
         "location":"41.9, 12.483333333333333",
         "marc":"it",
         "phone_prefix":"39",
         "tld":".it",
         "un_m49_code":"380",
         "wmo":"IY"
      }
   }
}

Remember to replace YOUR_API_KEY_HERE with your actual API key.

To maintain the integrity and performance of the EasyAPI service, we've implemented a rate limit. This ensures that the service remains available to all users without any hitches.

• Rate Limit: 500 requests/minute/ip address

If you exceed the rate limit, the API will respond with a 428 status. Please adhere to this limit to ensure uninterrupted service.

Thank you for choosing EasyAPI. For further assistance or queries, don't hesitate to reach out. Visit our detailed documentation at docs.easyapi.io.