To use the CallerAPI, include your API key in the header of each request:
X-Auth: YOUR_API_KEY
Replace YOUR_API_KEY
with the actual API key provided
in your CallerAPI dashboard.
••••••••••••••••••••••••••••••
Retrieve information about the authenticated user.
GET https://callerapi.com/api/me
{
"status": "success",
"email": "[email protected]",
"credits_spent": 23498,
"credits_monthly": 250000,
"credits_left": 226502
}
curl -H 'X-Auth: YOUR_API_KEY' 'https://callerapi.com/api/me'Retrieve detailed information about a specific phone number.
GET https://callerapi.com/api/phone/info/{phone}
Replace {phone}
with the phone number you
want to look up. The phone number should be in E.164 format (e.g., +18006927753).
The response is a JSON object containing information from various sources. Here's a breakdown of the main sections:
callerapi: Internal spam and block datatruecaller: Basic phone number validation and carrier infocallapp: Detailed business information and social media profilesviewcaller: Community-sourced names and spam reportseyecon: Contact name informationhiya: Reputation data and user comments
{
"status": "success",
"callerapi": {
"name": null,
"spam_count": 0,
"block_count": 0,
"is_spam": false,
"spam_score": 0
},
"truecaller": {
"number": "+1 800-692-7753",
"is_valid": true,
"country_code": 1,
"national_number": 8006927753,
"country": "United States",
"number_type": 3,
"number_type_label": "Toll free",
"provider": "",
"time_zones": ["America/New_York", "America/Chicago", "America/Denver", "America/Los_Angeles"]
},
"eyecon": "Apple Inc.",
"callapp": {
"name": "apple inc.",
"websites": [
{"websiteUrl": "http://www.apple.com/"},
{"websiteUrl": "https://www.apple.com/"},
{"websiteUrl": "http://m.yelp.com/biz/apple-computer-headquarters-cupertino"}
],
"addresses": [
{"type": 1, "street": "Summit Boulevard, 35243, Vestavia Hills"},
{"type": 1, "street": "320 S Capital of Texas Hwy, West Lake Hills, TX 78746, USA"}
],
"photoUrl": "https://lh3.googleusercontent.com/p/AF1QipPmIDDqiF56xI9-dF3etwxfTYmlZrpKJKn_2T9r=k",
"categories": [
{"name": "Shopping & Retail"},
{"name": "Computer & Equipment Dealers"}
],
"avgRating": 4.6,
"priceRange": 3,
"description": "Apple retail store showcasing the brand's phones, tablets & more in sleekly designed spaces.",
"openingHours": {
"sunday": ["07:00 - 16:00"],
"monday": ["05:00 - 20:00"],
"tuesday": ["05:00 - 20:00"],
"wednesday": ["05:00 - 20:00"],
"thursday": ["05:00 - 20:00"],
"friday": ["05:00 - 20:00"],
"saturday": ["07:00 - 16:00"]
},
"facebookID": {"id": "114092991968595", "sure": true, "version": 1},
"linkedinPubProfileUrl": {"id": "http://www.linkedin.com/pub/claudia-smith/30/565/a31", "sure": true, "version": 1},
"twitterScreenName": {"id": "djsetroc", "sure": true, "version": 1},
"googlePlusID": {"id": "115474023033355232032", "sure": true, "version": 1},
"foursquareID": {"id": "12550046", "sure": true, "version": 1},
"instagramID": {"id": "230216465", "sure": true, "version": 1},
"pinterestID": {"id": "caseybrunetti", "sure": true, "version": 1},
"lat": 30.30219640000001,
"lng": -97.8296238,
"url": "https://maps.google.com/?cid=2099657283551182410",
"googlePlacesId": "ChIJfTemqIdKW4YRopyJNzlsVwE",
"huaweiPlacesId": "798EC49D94E53FA0CC39A9A66E3FCA90",
"spamScore": 343,
"priority": 37744
},
"viewcaller": [
{
"name": "apple inc.",
"prefix": "1",
"number": "8006927753",
"spamCounter": 0,
"spam": false,
"names": [
{
"name": "apple inc.",
"occurrences": 9273,
"isSpam": false
},
{
"name": "apple",
"occurrences": 609,
"isSpam": false
}
],
"namesCount": 2
}
],
"hiya": {
"name": "Apple Inc.",
"type": "Business",
"is_spam": false,
"reputation": "UNCERTAIN",
"spam_score": 0,
"reputation_score": 100,
"category": "Technology",
"comments": {
"reports": [
{
"id": "unique-id",
"phone": "1/8006927753",
"timestamp": "2024-02-14T12:53:21.190Z",
"comment": {
"languageTag": "en-US",
"str": "Apple Support"
},
"category": 1
}
]
}
}
}
spam_count: Number of spam reportsblock_count: Number of times the number was blockedis_spam: Whether the number is marked as spamspam_score: Spam likelihood score (0-100)is_valid: Whether the number is validcountry: Country of the phone numbernumber_type_label: Type of number (mobile, landline, etc.)provider: Carrier/provider namewebsites: Associated websitesaddresses: Physical addressescategories: Business categoriesopeningHours: Business hoursspamScore: Spam likelihood scorespamCounter: Number of spam reportsnames: List of reported names with occurrence countsnamesCount: Total number of reported namesreputation: Overall reputation (GOOD, SPAM, UNCERTAIN)spam_score: Spam likelihood score (0-100)comments: User-submitted reports and comments1: Not Spam - Legitimate calls2: General Spam - Non-specific spam calls3: Debt Collector - Collection agency calls4: Political - Campaign or political calls5: Nonprofit - Charity or nonprofit organization calls6: Telemarketer - Sales and marketing calls7: Survey - Market research or survey calls8: Fraud - Scam or fraudulent calls10: Robocaller - Automated calling systemscurl -H 'X-Auth: YOUR_API_KEY' 'https://callerapi.com/api/phone/info/18006927753'