Skip to main content

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.

Project description

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

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

pip install phoneinfopy

Login

python3 -m phoneinfopy.cli -c <countryCode> -l <phoneNumber>

Example

python3 -m phoneinfopy.cli -c +91 -l 98xxxxxxxx

search-Number

You can search phone number by using below command

python3 -m phoneinfo.cli -c +91 -i 98xxxxxxxx

Module-usage

Install

You can install the phoneinfopy moudle using pip:

pip install phoneinfopy

Register

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.

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..

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:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

phoneinfopy-1.0.0.17.tar.gz (4.7 kB view hashes)

Uploaded Source

Built Distribution

phoneinfopy-1.0.0.17-py3-none-any.whl (5.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page