Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pruvonet/countryipspoofer
Generates random ips that belongs to a desired country
https://github.com/pruvonet/countryipspoofer
country geo geolocation ip javascript js node reverse spoof spoofing ts typescript
Last synced: 21 days ago
JSON representation
Generates random ips that belongs to a desired country
- Host: GitHub
- URL: https://github.com/pruvonet/countryipspoofer
- Owner: PruvoNet
- License: gpl-3.0
- Created: 2019-08-20T08:22:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T18:27:19.000Z (almost 2 years ago)
- Last Synced: 2024-11-11T21:54:52.500Z (about 1 month ago)
- Topics: country, geo, geolocation, ip, javascript, js, node, reverse, spoof, spoofing, ts, typescript
- Language: TypeScript
- Size: 302 KB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/country-ip-spoofer)
[](https://travis-ci.org/PruvoNet/countryIpSpoofer)
[](https://codeclimate.com/github/PruvoNet/countryIpSpoofer/test_coverage)
[](https://codeclimate.com/github/PruvoNet/countryIpSpoofer/maintainability)
[](https://snyk.io/test/github/PruvoNet/countryIpSpoofer?targetFile=package.json)
[](https://david-dm.org/PruvoNet/countryIpSpoofer)
[](https://david-dm.org/PruvoNet/countryIpSpoofer?type=dev)
# country-ip-spoofer
A fully typed Node.js module that generates a random IP address that is associated with a desired country.
This module is especially useful if you use an API that requires an IP address to be passed to it in order to realize
the country of a user, and you want to spoof the user country.
## Important notes
This module leverages the [IP2Location™](https://lite.ip2location.com/database/ip-country) data set, which is
licensed under [Creative Commons Attribution-ShareAlike 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
As such, the module does not package the actual data, and you are responsible to load it to the module while not
infringing with said licence.
* For better results, refresh your data set once in a while.
## Installation
```sh
npm install country-ip-spoofer
```
Or
```sh
yarn add country-ip-spoofer
```
## Setup
Before you begin, you need to prepare the data set to be used by the module (only perform once).
Please download the `IPV4 CSV` file from [IP2Location™](https://lite.ip2location.com/database/ip-country) and run
the following temp script (install the `csv` package if it is missing - you can delete it later):
```typescript
import {createDataTable} from 'country-ip-spoofer/dist/dataTableCreator';
const csfFile = 'path to the downloaded csv file';
const outputFile = 'path to output the data set';
createDataTable(csfFile, outputFile)
.then(() => {
console.log('done');
});
```
Then save the output file to your project.
## Usage
```typescript
import * as request from 'request'; // We only use this to test the resulting ips
import { getIpOfCountry, setDataTable, DataTable } from 'country-ip-spoofer';
import * as dataSet from 'path to your json data set form previous step';
// Load the data set before yuo begin
setDataTable(dataSet as DataTable);
const countryCode = 'AU';
const ip = getIpOfCountry(countryCode);
console.log(ip); // prints '103.246.130.28' for example
// Test out the ip location
const requestParams = {
url: `http://ip-api.com/json/${ip}`,
json: true,
};
request(requestParams, (err, result) => {
const realCountryCode = result.toJSON().body.countryCode;
console.log(realCountryCode); // Should print 'AU'
console.log(realCountryCode === countryCode ? 'Success' : 'Fail'); // Should print 'Success'
});
```