Skip to content

README.md

Latest commit

 

History

History
94 lines (59 loc) · 3.15 KB

README.md

File metadata and controls

94 lines (59 loc) · 3.15 KB

GitHub language
GitHub language

OpenIP API - IP to Country Resolver

Welcome to the OpenIP API, a free and unlimited IP to Country resolver that empowers developers to seamlessly retrieve e country and city information based on a given IP address. This API is built using the Flask web framework in Python, offering a robust and efficient solution for geolocation needs.

Features

  • Free and Unlimited Access: OpenIP API provides free and unrestricted access to its IP to Country resolution service, allowing developers to integrate geolocation functionality without worrying about usage limits.

  • Fast and Reliable: Built on the Flask web framework, the OpenIP API ensures speedy and reliable responses, making it suitable for real-time applications and services.

  • Simple Integration: With a RESTful design, the API is easy to integrate into a variety of applications, including web, mobile, and desktop platforms. The use of standard HTTP methods and JSON responses simplifies the integration process.

Table of Contents

Usage

Simply make a GET request to the API endpoint with the desired IP address as a parameter, and the API will respond with detailed information about the corresponding country and city.

API Endpoint

  • Endpoint: https://openipapi.cloudshield.club/api
  • Method: GET
  • Parameters:
    • ip (required): The IP address for which you want to resolve the country and city.

Example Request

curl https://openipapi.cloudshield.club/api?ip=1.1.1.1

Example Response

{
  "ip": "1.1.1.1",
  "country": "United States",
  "city": "Buffalo, NY"
}

Handling Errors

If the ip parameter is missing, the API will respond with a 400 status code and an error message:

{
  "error": "IP parameter is missing"
}

Code Examples

Python

Node.JS

Go

License

This project is licensed under the MIT License. See the LICENSE file for details.

Issues

If you encounter any issues or have questions, feel free to open an open an issue on this repository. We appreciate your feedback and contributions!

Discussion

Join the Discussion and collaborate with the community. Whether you have questions, ideas, or just want to connect, this is the space to engage. We encourage an open and inclusive environment for sharing experiences and helping each other make the most out of the OpenIP API.