Package: truecallerpy
TruecallerpyTruecallerPy is a Python package that provides functionalities to interact with the Truecaller API. It allows you to perform login, OTP verification, and phone number search using Truecaller.Table of Contents:TruecallerpyRequirementsCommand Line UsageInstallationLoginInstallationIdSearching a NumberBulk Phone Number Search with cliBasic UsageLogin FunctionOTP VerificationPhone Number SearchBulk Phone Number SearchContributingLicenseSupportRequirementsTo use the TruecallerPy package, you need to meet the following requirements:Valid Mobile Number (Phone number verification for Truecaller)Truecaller InstallationIdCommand Line UsageInstallationYou can install the TruecallerPy package using pip:pipinstalltruecallerpyLoginTo log in to your Truecaller account, use the following command:truecallerpyloginIf you encounter any errors, try running the command with administrative privilege (e.g.,sudo truecallerpy loginon Linux or running the command prompt as administrator on Windows).InstallationIdTo retrieve your Truecaller InstallationId, use the following command:truecallerpy--installationidYou can also specify the-iflag to print only the InstallationId:truecallerpy-i-rSearching a NumberTo search for a phone number using Truecaller, use the following command:truecallerpy-s[number]For example:truecallerpy-s1234567890The command will return a JSON response containing information about the phone number.You can use the-rflag to get the raw output (JSON) instead of the formatted output. For example:truecallerpy-s1234567890-rYou can also use additional flags to extract specific information. For example, to print only the name associated with the phone number, use the--nameflag:truecallerpy-s1234567890--nameSimilarly, you can use the--emailflag to print only the email associated with the phone number.Bulk Phone Number Search with cliTo perform a bulk search for multiple phone numbers, use the--bsflag followed by the numbers separated by commas. For example:truecallerpy--bs9912345678,+14051234567,+919987654321In addition to the CLI, you can also use the TruecallerPy package in your Python code. The package provides various functions such aslogin,verify_otp,search_phonenumber, andbulk_search.Basic UsageLogin FunctionTheloginfunction is used to log in to the Truecaller service. It takes a phone number in international format as a parameter and returns a dictionary containing the login response details.importasynciofromtruecallerpyimportloginphone_number="+1234567890"response=asyncio.run(login(phone_number))print(response)Theloginfunction returns a dictionary with the following keys:status_code(int): The status code of the  request.status(int): The status code of the truecaller login request.message(str): A message indicating the status of the login request.domain(str): The domain associated with the phone number.parsedPhoneNumber(int): The phone number without the country code.parsedCountryCode(str): The country code associated with the phone number.requestId(str): The unique identifier for the login request.method(str): The method used for sending the OTP.tokenTtl(int): The time-to-live (TTL) value for the OTP token in seconds.OTP VerificationTheverify_otpfunction is used to verify the mobile number with the OTP (One-Time Password) received.importasynciofromtruecallerpyimportverify_otpphone_number="+1234567890"json_data={# JSON response from the login function}otp="123456"response=asyncio.run(verify_otp(phone_number,json_data,otp))print(response)Theverify_otpfunction returns a dictionary with the following keys:status_code(int): The status code of the request.status(int): The status code of the truecaller OTP verification.message(str): A message indicating the result of the OTP verification.installationId(str): The installation ID associated with the verified number.ttl(int): The time-to-live (TTL) value for the verification result in seconds.userId(int): The user ID associated with the verified number.suspended(bool): Indicates whether the account is suspended.phones(list): List of phone numbers associated with the user, each containingphoneNumber,countryCode, andprioritykeys.Phone Number SearchThesearch_phonenumberfunction allows you to search for a phone number using the Truecaller API.importasynciofromtruecallerpyimportsearch_phonenumberphone_number="+1234567890"country_code="US"installation_id="Your installation ID"response=asyncio.run(search_phonenumber(phone_number,country_code,installation_id))print(response)Thesearch_phonenumberfunction returns a dictionary containing information about the phone number.Bulk Phone Number SearchThebulk_searchfunction allows you to perform a bulk search for a list of phone numbers using the Truecaller API.importasynciofromtruecallerpyimportbulk_searchphone_numbers="+1234567890,9876543210"country_code="US"installation_id="Installation ID"response=asyncio.run(bulk_search(phone_numbers,country_code,installation_id))print(response)Thebulk_searchfunction returns a dictionary containing information about the phone numbers.ContributingContributions to the TruecallerPy package are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request on the project's GitHub repository.LicenseThis project is licensed under the MIT License.SupportIf you need any assistance or have questions, please contactsumithemmadi244@gmail.com.Feel free to customize the documentation template according to your package's features and requirements. Provide detailed explanations and examples for each function, along with the necessary parameters and return types.