README.md

IPY

A simple ip api !

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact
7. Acknowledgements

About The Project

A simple open-source api that allows you to get the ip from the front client

Built With

• Express
• Nodejs

Installation

1. Clone the repo

   git clone https://github.com/furycodz/ipy.git

2. Install NPM packages

   npm install

3. Change the port in app.js(line 6)

   const PORT = 2004;

4. Run the api

   npm run dev

Usage

This api can be used in order to get a user ip from front client.

https://furycodz.me/api/ipy/isUp #To check if the api is up

https://furycodz.me/api/ipy/getIp #To get the client ip in json format

https://furycodz.me/api/ipy/getIp?format=json #To get the client ip in json format

https://furycodz.me/api/ipy/getIp?format=jsonp #To get the client ip in jsonp(JSON with padding) format

https://furycodz.me/api/ipy/getIp?format=jsonp&callback=getIp #To get the client ip in jsonp(JSON with padding) format with getIp callback

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @FuryCodz - [email protected]

Project Link: https://github.com/furycodz/ipy/

Acknowledgements

• Express