{"openapi":"3.0.0","info":{"title":"XposedOrNot API","description":"\nThe XON API provides comprehensive data breach detection and monitoring services. Use our API to:\n* Check if email addresses have been exposed in data breaches\n* Monitor domain-level breaches\n* Access detailed breach analytics\n* Get real-time breach metrics\n\n## Documentation Access\n\n| Interface | Features | Rate Limits |\n|-----------|----------|-------------|\n| **Swagger UI** - Interactive documentation at `/docs` | • Try out API endpoints directly<br>• View request/response examples<br>• Interactive testing | • 2 requests/second<br>• 50-100/hour<br>• 100-1000/day |\n| **OpenAPI JSON** - Raw spec at `/openapi.json` | • Import into other tools<br>• Use for automated testing<br>• Generate client code |  |\n\n> Most endpoints are publicly accessible. Domain-specific endpoints may require authentication.\n","version":"2.0.0"},"paths":{"/v1/breaches":{"get":{"operationId":"getBreaches","summary":"Get List Of Breaches","description":"Retrieves a list of all known data breaches in the system. This endpoint provides information about each breach including its name, title, breach date, and when it was added to the system.","tags":["breaches"],"parameters":[{"name":"domain","in":"query","description":"Filter breaches by domain","required":false,"schema":{"type":"string"}},{"name":"breach_id","in":"query","description":"Get specific breach by ID","required":false,"schema":{"type":"string"}},{"name":"if-modified-since","in":"header","description":"Return 304 if no changes since this date","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successfully retrieved list of breaches","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Response status"},"exposedBreaches":{"type":"array","description":"List of breach objects","items":{"type":"object","properties":{"breachID":{"type":"string","description":"Unique identifier for the breach"},"breachedDate":{"type":"string","description":"Date when the breach occurred"},"domain":{"type":"string","description":"Domain associated with the breach"},"industry":{"type":"string","description":"Industry of the breached organization"},"logo":{"type":"string","description":"URL to organization logo"},"passwordRisk":{"type":"string","description":"Password risk level"},"searchable":{"type":"boolean","description":"Whether the breach is searchable"},"sensitive":{"type":"boolean","description":"Whether the breach contains sensitive data"},"verified":{"type":"boolean","description":"Whether the breach has been verified"},"exposedData":{"type":"array","items":{"type":"string"},"description":"Types of data exposed in the breach"},"exposedRecords":{"type":"integer","description":"Number of records affected"},"exposureDescription":{"type":"string","description":"Detailed description of the breach"},"referenceURL":{"type":"string","description":"URL to breach reference"}}}}}}}}},"304":{"description":"Not Modified - No changes since the specified date"},"404":{"description":"Not Found - No breaches found for the provided criteria"}}}},"/v1/check-email/{email}":{"get":{"operationId":"checkEmailBreaches","summary":"Check Email For Breaches","description":"Searches for any data breaches containing the specified email address. This endpoint provides information about breaches where the email was found.","tags":["breaches"],"parameters":[{"required":true,"schema":{"type":"string","format":"email"},"name":"email","in":"path","description":"Email address to check for breaches"},{"name":"include_details","in":"query","description":"Include detailed breach information in the response","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successfully retrieved breach information for the email","content":{"application/json":{"schema":{"type":"object","properties":{"breaches":{"type":"array","description":"List of breaches containing the email","items":{"type":"array","items":{"type":"string"}}},"email":{"type":"string","description":"Email address that was checked"}}}}}},"404":{"description":"Not Found - Email not found or invalid format","content":{"application/json":{"schema":{"type":"object","properties":{"Error":{"type":"string"},"email":{"type":"string"}}}}}}}}},"/v1/breach-analytics":{"get":{"operationId":"getBreachAnalytics","summary":"Get Breach Analytics","description":"Retrieves analytics and statistics about breaches for a specific email address. This endpoint provides information about breaches and associated paste data.","tags":["analytics"],"parameters":[{"required":true,"schema":{"type":"string","format":"email"},"name":"email","in":"query","description":"Email address to get analytics for"},{"name":"token","in":"query","description":"Token for accessing sensitive data","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved breach analytics","content":{"application/json":{"schema":{"type":"object","properties":{"ExposedBreaches":{"type":"array","description":"List of breaches containing the email","items":{"type":"object"}},"BreachesSummary":{"type":"object","description":"Summary of breaches"},"BreachMetrics":{"type":"object","description":"Metrics about breaches"},"PastesSummary":{"type":"object","description":"Summary of pastes"},"ExposedPastes":{"type":"array","description":"List of pastes containing the email","items":{"type":"object"}},"PasteMetrics":{"type":"object","description":"Metrics about pastes"}}}}}},"404":{"description":"Not Found - Email not found or invalid format"}}}},"/v1/domain-breaches":{"post":{"operationId":"getDomainBreaches","summary":"Get Domain Breaches","description":"Retrieves information about data breaches associated with verified domains for an API key. This endpoint provides detailed metrics and statistics about breaches affecting the domains.","tags":["domain_breaches"],"parameters":[{"required":true,"schema":{"type":"string"},"name":"x-api-key","in":"header","description":"API key for authentication"}],"responses":{"200":{"description":"Successfully retrieved domain breaches","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Response status"},"metrics":{"type":"object","description":"Detailed metrics about domain breaches","properties":{"Yearly_Metrics":{"type":"object","description":"Breach counts by year"},"Domain_Summary":{"type":"object","description":"Summary of breaches by domain"},"Breach_Summary":{"type":"object","description":"Summary of all breaches"},"Breaches_Details":{"type":"array","description":"Detailed information about each breach","items":{"type":"object","properties":{"email":{"type":"string"},"domain":{"type":"string"},"breach":{"type":"string"}}}},"Top10_Breaches":{"type":"object","description":"Top 10 largest breaches"},"Detailed_Breach_Info":{"type":"object","description":"Detailed information about each breach"}}}}}}}},"401":{"description":"Unauthorized - Invalid or missing API key"},"500":{"description":"Internal Server Error - An error occurred during processing"}}}}},"servers":[{"url":"https://api.xposedornot.com","description":"Production server"}]}