@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api IPQualityScore API
@base https://ipqualityscore.com/api
@auth Basic
@endpoints 3
@toc json(3)

@endpoint GET /json/email/:YOUR_API_KEY_HERE/:USER_EMAIL_HERE
@required {YOUR_API_KEY_HERE: str, USER_EMAIL_HERE: str}
@returns(200) {message: str, success: bool, valid: bool, disposable: bool, smtp_score: int, overall_score: int, first_name: str, generic: bool, common: bool, dns_valid: bool, honeypot: bool, deliverability: str, frequent_complainer: bool, spam_trap_score: str, catch_all: bool, timed_out: bool, suspect: bool, recent_abuse: bool, fraud_score: int, suggested_domain: str, leaked: bool, domain_age: map, first_seen: map, sanitized_email: str, domain_velocity: str, user_activity: str, associated_names: map, associated_phone_numbers: map, request_id: str}

@endpoint GET /json/phone/:YOUR_API_KEY_HERE/:USER_PHONE_HERE
@required {YOUR_API_KEY_HERE: str, USER_PHONE_HERE: str}
@optional {country: str, country: str}
@returns(200) {message: str, success: bool, formatted: str, local_format: str, valid: bool, fraud_score: int, recent_abuse: bool, VOIP: bool, prepaid: str, risky: bool, active: bool, carrier: str, line_type: str, country: str, city: str, zip_code: str, region: str, dialing_code: int, active_status: str, sms_domain: str, associated_email_addresses: map, user_activity: str, mnc: str, mcc: str, leaked: bool, spammer: bool, request_id: str, name: str, timezone: str, do_not_call: bool, sms_email: str}

@endpoint GET /json/url/:YOUR_API_KEY_HERE/:URL_HERE
@required {YOUR_API_KEY_HERE: str, URL_HERE: str}
@returns(200) {message: str, success: bool, unsafe: bool, domain: str, ip_address: str, server: str, content_type: str, status_code: int, page_size: int, domain_rank: int, dns_valid: bool, parking: bool, spamming: bool, malware: bool, phishing: bool, suspicious: bool, adult: bool, risk_score: int, domain_age: map, category: str, request_id: str}

@end