https://github.com/hieyou1/phone-number-info
Get carrier and owner of a phone number quickly and easily.
https://github.com/hieyou1/phone-number-info
Last synced: 2 months ago
JSON representation
Get carrier and owner of a phone number quickly and easily.
- Host: GitHub
- URL: https://github.com/hieyou1/phone-number-info
- Owner: hieyou1
- License: gpl-3.0
- Created: 2021-07-03T23:34:49.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-27T02:40:41.000Z (over 2 years ago)
- Last Synced: 2025-08-21T04:38:36.579Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# phone-number-info
Get information on a phone number from [RevealName.com](https://revealname.com)
Just pass in a phone number, sit back & relax!
## Install
`npm i phone-number-info`
## Under the hood
We use [libphonenumber-js](https://gitlab.com/catamphetamine/libphonenumber-js#readme) to parse phone numbers. Please make sure any phone numbers you pass are compatible with their API, otherwise you might get an error.
## Usage
```js
const phoneNumberInfo = require("phone-number-info");
const phoneNumber = ""; // add your own!
(async () => {
let number = await phoneNumberInfo(phoneNumber, "US" /* default country for libphonenumber-js */);
console.log(number.ownerName);
// your name
console.log(number.carrier);
// your phone's carrier
// number is also a PhoneNumber from libphonenumber-js, so you can also use their API to convert it further
})();
```
## Morals & Disclaimer
**Please only use this on consenting users.** We aren't responsible for anything you do with this library. Again, **please be extremely careful to only use this on consenting users.** Thanks!