Phone
Developer docs
A class to represent a phone number
Source code in src/whitepyges/phone.py
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | |
__init__
Initialize a new Phone object
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
phone_number | str | The phone number to search | required |
Returns:
| Type | Description |
|---|---|
None | None |
Source code in src/whitepyges/phone.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | |
__repr__
Return the string representation of the object
Returns:
| Name | Type | Description |
|---|---|---|
str | str | The string representation of the object |
Source code in src/whitepyges/phone.py
113 114 115 116 117 118 119 120 121 | |
__str__
Return the string representation of the object
Returns:
| Name | Type | Description |
|---|---|---|
str | str | The string representation of the object |
Source code in src/whitepyges/phone.py
123 124 125 126 127 128 129 130 131 | |
search
Perform a search for the phone number
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout | int | The timeout for the request. Defaults to 10. | 10 |
max_retries | int | The maximum number of retries. Defaults to 3. | 3 |
randomize_headers | bool | Randomize the headers for the request. Defaults to False. | False |
ignore_robots | bool | Ignore the robots.txt file. Defaults to False. | False |
Returns:
| Type | Description |
|---|---|
dict | None | list[dict] | None: Possible data for the phone number |
Source code in src/whitepyges/phone.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | |
Features
- Lookup phone numbers to retrieve spam risk, state, cities, area code, and profile URL
- Handles request retries and optional header randomization
Example Usage
from whitepyges import Phone
phone: Phone = Phone(phone_number='123-456-7890')
info: dict = phone.search()
print(info)
Example Response
{
"spam_info": "LOW SPAM RISK",
"state": "Washington",
"cities": "Example, Example-2, Examples 3",
"area_code": "123",
"url": "https://www.whitepages.com/phone/1-123-456-7890"
}