| Name | phoneinfopy JSON |
| Version |
1.0.0.17
JSON |
| download |
| home_page | |
| Summary | phoneinfopy is a Python package that allow you to get respones from truecaller APIs. You can able to do login, OTP verification, and phone number search using Truecaller API with this package. |
| upload_time | 2023-10-21 12:54:36 |
| maintainer | |
| docs_url | None |
| author | Mr_3rr0r_501 [yuvaraj] |
| requires_python | |
| license | |
| keywords |
truecaller
phoneinfo
numberinfo
phonenumberinfo
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PhoneInfopy
PhoneInfopy is a python tool to directly make request to Truecaller API's and get response. This module will allow you to register your number, validate OTP while registering and search information about a phone number.
**Table to Contents**
- [PhoneInfoPy](#PhoneInfoPy)
- [Requirements](#requirements)
- [Command Line Usage](#Command-line)
- [Installation](#Installation)
- [Login](#Login)
- [Search Number](#search-number)
- [Module usage](#Module-usage)
- [Installation](#Install)
- [Register](#Register)
- [Validate OTP](#Validate-OTP)
- [Search phone number](#Search-number)
## Requirements
To use PhoneInfopy module you need below pre requirements.
- valid mobile number
- python
- truecaller auth token [This token will get by login/register process]
## Command Line Usage
You can install PhoneInfopy package using pip
- `phoneinfopy -h [--help]` for help
- `phoneinfopy -l [--login]` for login [Need to mention country code]
- `phoneinfopy -c [--code]` for country code
- `phoneinfopy -i [--info]` for search mobile number [Need to mention country code]
### Installation
```bash
pip install phoneinfopy
```
### Login
```bash
python3 -m phoneinfopy.cli -c <countryCode> -l <phoneNumber>
```
#### Example
```bash
python3 -m phoneinfopy.cli -c +91 -l 98xxxxxxxx
```
## search-Number
You can search phone number by using below command
```bash
python3 -m phoneinfo.cli -c +91 -i 98xxxxxxxx
```
## Module-usage
### Install
You can install the phoneinfopy moudle using pip:
```bash
pip install phoneinfopy
```
## Register
```python
from phoneinfopy import register_phone_number
number = "+9198xxxxxxxx"
response = register_phone_number(number)
# register_phone_number method will return json object
# example:
# {
# status : bool,
# message: str
# requestId: str
# }
```
## Validate-OTP:
Once you get success response from register method next you need to verify the OTP to get access token.
```python
from phoneinfopy import validate_OTP
number = "+9198xxxxxxxx"
OTP = "123456"
requestId = "<you get this ID while register process>"
response = validate_OTP(number, OTP, requestId)
# validate_OTP method will return json object
# {
# status: bool
# message: str
# access_token: str [If OTP validatino is success]
# }
```
## Search-number
You need to get user information using phone number you can use like this..
```python
from phoneinfopy import get_phone_info
target_number = "98xxxxxxxx"
country_code = "+91"
access_token = "a10--******" ["you get this token while validating OTP"]
response = get_phone_info(target_number, country_code, access_token)
# get_phone_info will return json object
#{
# status: bool
# message: str
# data: object [if user info found]
# }
```
## Contribution
Contributions to the phoneinfopy package are welcome!...
If you faced any issue or you have good idea to improve please open a issue or submit a pull request.
## Let's Connect:
- [Instagram](https://www.instagram.com/mr_3rr0r_501/)
- [LinkedIn](https://www.linkedin.com/in/yuvaraj-a-57a103171)
- [Youtube](https://youtube.com/@Mr3rr0r501)
Raw data
{
"_id": null,
"home_page": "",
"name": "phoneinfopy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "truecaller,phoneinfo,numberinfo,phonenumberinfo",
"author": "Mr_3rr0r_501 [yuvaraj]",
"author_email": "<yuvarajucet@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fd/05/e379eecb79a4fb2eb5152a52fe2ebc071d5dbe0bfa1e324340cda22bc122/phoneinfopy-1.0.0.17.tar.gz",
"platform": null,
"description": "# PhoneInfopy\n\nPhoneInfopy is a python tool to directly make request to Truecaller API's and get response. This module will allow you to register your number, validate OTP while registering and search information about a phone number.\n\n**Table to Contents**\n- [PhoneInfoPy](#PhoneInfoPy)\n - [Requirements](#requirements)\n - [Command Line Usage](#Command-line)\n - [Installation](#Installation)\n - [Login](#Login)\n - [Search Number](#search-number)\n - [Module usage](#Module-usage)\n - [Installation](#Install)\n - [Register](#Register)\n - [Validate OTP](#Validate-OTP)\n - [Search phone number](#Search-number)\n\n## Requirements\nTo use PhoneInfopy module you need below pre requirements.\n- valid mobile number\n- python\n- truecaller auth token [This token will get by login/register process]\n\n## Command Line Usage\nYou can install PhoneInfopy package using pip\n\n- `phoneinfopy -h [--help]` for help\n- `phoneinfopy -l [--login]` for login [Need to mention country code]\n- `phoneinfopy -c [--code]` for country code\n- `phoneinfopy -i [--info]` for search mobile number [Need to mention country code]\n\n### Installation\n```bash\npip install phoneinfopy\n```\n\n### Login\n```bash\npython3 -m phoneinfopy.cli -c <countryCode> -l <phoneNumber>\n```\n#### Example\n```bash\npython3 -m phoneinfopy.cli -c +91 -l 98xxxxxxxx\n```\n\n## search-Number\nYou can search phone number by using below command\n```bash\npython3 -m phoneinfo.cli -c +91 -i 98xxxxxxxx\n```\n\n## Module-usage\n\n### Install\nYou can install the phoneinfopy moudle using pip:\n```bash\npip install phoneinfopy\n```\n\n## Register\n```python\nfrom phoneinfopy import register_phone_number\n\nnumber = \"+9198xxxxxxxx\"\nresponse = register_phone_number(number)\n\n# register_phone_number method will return json object\n# example:\n# {\n# status : bool,\n# message: str\n# requestId: str\n# }\n```\n\n## Validate-OTP:\nOnce you get success response from register method next you need to verify the OTP to get access token.\n\n\n```python\nfrom phoneinfopy import validate_OTP\n\nnumber = \"+9198xxxxxxxx\"\nOTP = \"123456\"\nrequestId = \"<you get this ID while register process>\"\nresponse = validate_OTP(number, OTP, requestId)\n\n# validate_OTP method will return json object\n# {\n# status: bool\n# message: str\n# access_token: str [If OTP validatino is success]\n# }\n```\n\n## Search-number\nYou need to get user information using phone number you can use like this..\n```python\nfrom phoneinfopy import get_phone_info\n\ntarget_number = \"98xxxxxxxx\"\ncountry_code = \"+91\"\naccess_token = \"a10--******\" [\"you get this token while validating OTP\"]\n\nresponse = get_phone_info(target_number, country_code, access_token)\n\n# get_phone_info will return json object \n#{\n# status: bool\n# message: str\n# data: object [if user info found]\n# }\n```\n\n## Contribution\n\nContributions to the phoneinfopy package are welcome!...\nIf you faced any issue or you have good idea to improve please open a issue or submit a pull request.\n\n## Let's Connect:\n- [Instagram](https://www.instagram.com/mr_3rr0r_501/)\n- [LinkedIn](https://www.linkedin.com/in/yuvaraj-a-57a103171)\n- [Youtube](https://youtube.com/@Mr3rr0r501)\n\n",
"bugtrack_url": null,
"license": "",
"summary": "phoneinfopy is a Python package that allow you to get respones from truecaller APIs. You can able to do login, OTP verification, and phone number search using Truecaller API with this package.",
"version": "1.0.0.17",
"project_urls": null,
"split_keywords": [
"truecaller",
"phoneinfo",
"numberinfo",
"phonenumberinfo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8749af982403215f3cb1d30a88e3bc6854e8ade0763410a2c57cd6d6abc3b167",
"md5": "292318421eaa4a7fa174435ed49fb455",
"sha256": "7aa8e1da2cfad12cd8d777c43b4d7a28679e1fba902c423045632d40e1da3b05"
},
"downloads": -1,
"filename": "phoneinfopy-1.0.0.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "292318421eaa4a7fa174435ed49fb455",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5069,
"upload_time": "2023-10-21T12:54:34",
"upload_time_iso_8601": "2023-10-21T12:54:34.805200Z",
"url": "https://files.pythonhosted.org/packages/87/49/af982403215f3cb1d30a88e3bc6854e8ade0763410a2c57cd6d6abc3b167/phoneinfopy-1.0.0.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fd05e379eecb79a4fb2eb5152a52fe2ebc071d5dbe0bfa1e324340cda22bc122",
"md5": "712682860e968bb9229f014345003ebe",
"sha256": "23fda96851b93800bc10f1273015f3734074964e62ab149c281cec1263f28890"
},
"downloads": -1,
"filename": "phoneinfopy-1.0.0.17.tar.gz",
"has_sig": false,
"md5_digest": "712682860e968bb9229f014345003ebe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4723,
"upload_time": "2023-10-21T12:54:36",
"upload_time_iso_8601": "2023-10-21T12:54:36.696667Z",
"url": "https://files.pythonhosted.org/packages/fd/05/e379eecb79a4fb2eb5152a52fe2ebc071d5dbe0bfa1e324340cda22bc122/phoneinfopy-1.0.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-21 12:54:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "phoneinfopy"
}
