Repository navigation
Expand file tree
/
Copy pathapi_doc.html
More file actions
executable file
·1855 lines (1809 loc) · 78.1 KB
/
Copy pathapi_doc.html
File metadata and controls
executable file
·1855 lines (1809 loc) · 78.1 KB
1
2
3
4
5
6
7
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="author" content="Devanand Premkumar" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:site" content="@XposedOrNot" />
<meta name="twitter:creator" content="@DevaOnBreaches" />
<meta name="twitter:title" content="Free Data Breach API, No API Key Required" />
<meta
name="twitter:description"
content="Query 11.6 billion+ breach records by email or domain with a free REST API. No API key needed for basic checks. JSON responses, docs, and 8 official SDKs."
/>
<meta
name="twitter:image"
content="https://xposedornot.com/static/images/og/og-api-doc.png"
/>
<meta
name="twitter:image:alt"
content="Free data breach API for developers"
/>
<meta
property="og:image"
content="https://xposedornot.com/static/images/og/og-api-doc.png"
/>
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />
<meta
property="og:image:alt"
content="Free data breach API for developers"
/>
<meta property="og:site_name" content="XposedOrNot" />
<title>Free Data Breach API, No API Key Required | XposedOrNot</title>
<link rel="dns-prefetch" href="https://cdnjs.cloudflare.com" />
<link rel="dns-prefetch" href="https://static.hotjar.com" />
<meta
name="description"
content="Query 11.6 billion+ breach records by email or domain with a free REST API. No API key needed for basic checks. JSON responses, docs, and 8 official SDKs."
/>
<meta
property="og:title"
content="Free Data Breach API, No API Key Required"
/>
<meta
property="og:description"
content="Query 11.6 billion+ breach records by email or domain with a free REST API. No API key needed for basic checks. JSON responses, docs, and 8 official SDKs."
/>
<meta property="og:type" content="website" />
<meta property="og:url" content="https://xposedornot.com/api_doc" />
<meta
name="keywords"
content="API documentation, data breach API, password security, email breach detection, cybersecurity API, domain security, REST API, JSON API, security integration"
/>
<link rel="canonical" href="https://xposedornot.com/api_doc" />
<link rel="alternate" hreflang="en" href="https://xposedornot.com/api_doc" />
<link rel="alternate" hreflang="bn" href="https://xposedornot.com/bn/api_doc" />
<link rel="alternate" hreflang="de" href="https://xposedornot.com/de/api_doc" />
<link rel="alternate" hreflang="es" href="https://xposedornot.com/es/api_doc" />
<link rel="alternate" hreflang="fr" href="https://xposedornot.com/fr/api_doc" />
<link rel="alternate" hreflang="hi" href="https://xposedornot.com/hi/api_doc" />
<link rel="alternate" hreflang="it" href="https://xposedornot.com/it/api_doc" />
<link rel="alternate" hreflang="ja" href="https://xposedornot.com/ja/api_doc" />
<link rel="alternate" hreflang="nl" href="https://xposedornot.com/nl/api_doc" />
<link rel="alternate" hreflang="pt" href="https://xposedornot.com/pt/api_doc" />
<link rel="alternate" hreflang="ru" href="https://xposedornot.com/ru/api_doc" />
<link rel="alternate" hreflang="ta" href="https://xposedornot.com/ta/api_doc" />
<link rel="alternate" hreflang="zh" href="https://xposedornot.com/zh/api_doc" />
<link rel="alternate" hreflang="tr" href="https://xposedornot.com/tr/api_doc" />
<link rel="alternate" hreflang="pl" href="https://xposedornot.com/pl/api_doc" />
<link rel="alternate" hreflang="x-default" href="https://xposedornot.com/api_doc" />
<meta http-equiv="content-language" content="en" />
<meta name="robots" content="index, follow" />
<meta name="googlebot" content="index, follow" />
<meta name="theme-color" content="#3f71f3" />
<link rel="icon" href="/favicon.ico" sizes="16x16 32x32 48x48 64x64 128x128 256x256" type="image/x-icon" />
<link rel="icon" href="/static/images/logos/logo.svg" type="image/svg+xml" />
<link rel="icon" href="/static/images/logos/logo-96x96.png" sizes="96x96" type="image/png" />
<link rel="icon" href="/static/images/logos/logo-32x32.png" sizes="32x32" type="image/png" />
<link rel="icon" href="/static/images/logos/logo-192x192.png" sizes="192x192" type="image/png" />
<link rel="icon" href="/static/images/logos/logo-512x512.png" sizes="512x512" type="image/png" />
<link rel="apple-touch-icon" href="/static/images/logos/logo-180x180.png" />
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link rel="preconnect" href="https://cdnjs.cloudflare.com" crossorigin />
<link
rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/4.6.2/css/bootstrap.min.css"
integrity="sha512-rt/SrQ4UNIaGfDyEXZtNcyWvQeOq0QLygHluFQcSjaGB04IxWhal71tKuzP6K8eYXYB6vJV4pHkXcmFGGQ1/0w=="
crossorigin="anonymous"
referrerpolicy="no-referrer"
/>
<link
rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/all.min.css"
integrity="sha256-BtbhCIbtfeVWGsqxk1vOHEYXS6qcvQvLMZqjtpWUEx8"
crossorigin="anonymous"
media="print"
onload="this.media='all'"
/>
<noscript>
<link
rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/all.min.css"
integrity="sha256-BtbhCIbtfeVWGsqxk1vOHEYXS6qcvQvLMZqjtpWUEx8"
crossorigin="anonymous"
/>
</noscript>
<link
rel="preload"
as="style"
href="https://fonts.googleapis.com/css?family=Poppins%3A300%2C400%2C500%2C600%2C700%2C900&subset&display=swap"
/>
<link
rel="stylesheet"
href="https://fonts.googleapis.com/css?family=Poppins%3A300%2C400%2C500%2C600%2C700%2C900&subset&display=swap"
type="text/css"
media="print"
onload="this.media='all'"
/>
<noscript>
<link
rel="stylesheet"
href="https://fonts.googleapis.com/css?family=Poppins%3A300%2C400%2C500%2C600%2C700%2C900&subset&display=swap"
type="text/css"
media="all"
/>
</noscript>
<link rel="preload" href="/static/css/style-new.css" as="style" />
<link rel="preload" href="/static/css/api_doc.css" as="style" />
<link rel="preload" href="/static/scripts/api_doc_ui.js" as="script" />
<link href="/static/css/style-new.css" type="text/css" rel="stylesheet" />
<link href="/static/css/api_doc.css" type="text/css" rel="stylesheet" />
<script src="/static/scripts/libs/jquery-3.7.1.min.js" defer></script>
<script
src="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/4.6.2/js/bootstrap.min.js"
integrity="sha512-7rusk8kGPFynZWu26OKbTeI+QPoYchtxsmPeBqkHIEXJxeun4yJ4ISYe7C6sz9wdxeE1Gk3VxsIWgCZTc+vX3g=="
crossorigin="anonymous"
referrerpolicy="no-referrer"
defer
></script>
<style>
@font-face {
font-family: "Font Awesome 5 Free";
font-style: normal;
font-weight: 400;
font-display: swap;
src: url("https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/webfonts/fa-regular-400.woff2") format("woff2");
}
@font-face {
font-family: "Font Awesome 5 Free";
font-style: normal;
font-weight: 900;
font-display: swap;
src: url("https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/webfonts/fa-solid-900.woff2") format("woff2");
}
@font-face {
font-family: "Font Awesome 5 Brands";
font-style: normal;
font-weight: normal;
font-display: swap;
src: url("https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/webfonts/fa-brands-400.woff2") format("woff2");
}
</style>
</head>
<body>
<script>
if (localStorage.getItem("darkSwitch") === "dark") {
document.body.setAttribute("data-theme", "dark");
}
</script>
<nav class="skip-links" aria-label="Skip links">
<a href="#main-content">Skip to main content</a>
<a href="#endpoint-1">Skip to API endpoints</a>
</nav>
<div class="banner" style="padding: 30px 0px 40px 0px;">
<div class="grid">
<nav class="navbar navbar-expand-md navbar-dark justify-content-center" aria-label="Main navigation">
<a class="navbar-brand abs" href="/" style="text-decoration: none;">
<span style="font-size: 1.5em; font-weight: bold; display: block; color: white;">XposedOrNot</span>
<span style="font-size: 0.8em; display: block; color: white; opacity: 0.85; margin-top: -10px;">Community Edition</span>
</a>
<button class="navbar-toggler" type="button" data-toggle="collapse"
data-target="#collapsingNavbar" aria-controls="collapsingNavbar"
aria-expanded="false" aria-label="Toggle navigation menu">
<span class="navbar-toggler-icon"></span>
</button>
<div class="navbar-collapse collapse" id="collapsingNavbar">
<ul class="navbar-nav ml-auto">
<li class="nav-item active px-4">
<a class="nav-link" href="password">Password</a>
</li>
<li class="nav-item active px-4">
<a class="nav-link" href="faq">FAQ</a>
</li>
<li class="nav-item active px-4">
<a
class="nav-link xon-nav-tip"
href="https://plus.xposedornot.com"
target="_blank"
rel="noopener"
data-tip="xonPlus for Business: breach monitoring for teams and companies" aria-label="xonPlus for Business: breach monitoring for teams and companies">xonPlus<span class="sr-only"> (opens in new tab)</span></a
>
</li>
<li class="nav-item active px-4">
<a class="nav-link" href="api_doc">API</a>
</li>
</ul>
</div>
</nav>
</div>
</div>
<nav class="breadcrumb-nav" aria-label="Breadcrumb">
<ol itemscope itemtype="https://schema.org/BreadcrumbList">
<li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
<a itemprop="item" href="/">
<span itemprop="name">Home</span>
</a>
<meta itemprop="position" content="1" />
</li>
<li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
<span itemprop="name" class="current">API Documentation</span>
<meta itemprop="position" content="2" />
</li>
</ol>
</nav>
<div class="container" id="main-content">
<div align="center" style="margin-bottom: 2rem">
<h1 style="margin-bottom: 0.75rem; font-size: 1.75rem">Free Data Breach API</h1>
<p
style="
font-size: 0.95rem;
color: var(--secondary-color);
margin-bottom: 1.5rem;
line-height: 1.6;
"
>
Check billions of exposed records with our free RESTful API. No API key needed.
</p>
<div
style="
display: grid;
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
gap: 1rem;
margin-bottom: 1.5rem;
text-align: left;
"
>
<div class="info-card">
<i
class="fas fa-key"
style="
font-size: 2em;
color: var(--primary-color);
margin-bottom: 0.5rem;
"
></i>
<h4>Authentication</h4>
<p>Most endpoints are public. Domain endpoints require an <a href="faq#collapse102">API key</a>.</p>
</div>
<div class="info-card">
<i
class="fas fa-tachometer-alt"
style="
font-size: 2em;
color: var(--primary-color);
margin-bottom: 0.5rem;
"
></i>
<h4>Rate Limit</h4>
<p>2 requests per second per IP, plus hourly and daily caps per endpoint. <a href="#rate-limits">See limits</a>.</p>
</div>
<div class="info-card">
<i
class="fas fa-code"
style="
font-size: 2em;
color: var(--primary-color);
margin-bottom: 0.5rem;
"
></i>
<h4>Response Format</h4>
<p>All responses return JSON with standard HTTP codes.</p>
</div>
<div class="info-card">
<i
class="fas fa-globe"
style="
font-size: 2em;
color: var(--primary-color);
margin-bottom: 0.5rem;
"
></i>
<h4>Base URL</h4>
<p><code>api.xposedornot.com</code></p>
</div>
<div class="info-card">
<i
class="fas fa-robot"
style="
font-size: 2em;
color: var(--primary-color);
margin-bottom: 0.5rem;
"
></i>
<h4>MCP Server</h4>
<p>Connect Claude, Cursor, and other AI assistants to the same breach data. <a href="/mcp">MCP setup guide</a>.</p>
</div>
</div>
<div style="margin-top: 1.5rem">
<a
href="https://api.xposedornot.com/docs"
target="_blank"
class="button-link"
style="margin-right: 12px"
><i class="fas fa-book"></i> Swagger Documentation</a
>
<a
href="https://xposedornot.docs.apiary.io"
target="_blank"
class="button-link"
><i class="fas fa-code"></i> API Playground</a
>
</div>
</div>
<div
id="sdk-section"
style="
margin-top: 2rem;
margin-bottom: 1.5rem;
position: relative;
z-index: 100;
"
>
<h2 style="text-align: center; margin-bottom: 1rem; font-size: 1.4rem">Official SDKs</h2>
<p
style="
text-align: center;
color: var(--secondary-color);
margin-bottom: 1.5rem;
font-size: 0.9rem;
"
>
Use our official libraries to integrate XposedOrNot into your
applications with just a few lines of code.
</p>
<div
style="
display: grid;
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
gap: 1.5rem;
"
>
<div class="panel" style="margin-bottom: 0">
<div
class="panel-heading"
style="display: flex; align-items: center; gap: 0.75rem"
>
<i
class="fab fa-npm"
style="font-size: 1.5em; color: #cb3837"
></i>
Node.js / JavaScript
</div>
<div class="panel-body">
<p style="margin-bottom: 1rem">
<strong>Install via npm:</strong>
</p>
<pre style="margin-bottom: 1.5rem">npm install xposedornot</pre>
<p style="margin-bottom: 1rem"><strong>Quick Example:</strong></p>
<pre>
const { XposedOrNot } = require('xposedornot');
const xon = new XposedOrNot();
// Check email for breaches
const result = await xon.checkEmail('test@example.com');
console.log(result);</pre
>
<p style="margin-top: 1.5rem; display: flex; gap: 0.75rem; flex-wrap: wrap">
<a
href="https://www.npmjs.com/package/xposedornot"
target="_blank"
rel="noopener"
class="button-link"
style="padding: 10px 20px; font-size: 0.9em"
aria-label="View XposedOrNot JavaScript SDK on npm"
>
<i class="fas fa-external-link-alt"></i> View on npm
</a>
<a
href="https://github.com/XposedOrNot/XposedOrNot-JS"
target="_blank"
rel="noopener"
class="button-link"
style="padding: 10px 20px; font-size: 0.9em; background: linear-gradient(135deg, #24292e, #40464e)"
aria-label="View XposedOrNot JavaScript SDK on GitHub"
>
<i class="fab fa-github"></i> GitHub
</a>
</p>
</div>
</div>
<div class="panel" style="margin-bottom: 0">
<div
class="panel-heading"
style="display: flex; align-items: center; gap: 0.75rem"
>
<i
class="fab fa-python"
style="font-size: 1.5em; color: #3776ab"
></i>
Python
</div>
<div class="panel-body">
<p style="margin-bottom: 1rem">
<strong>Install via pip:</strong>
</p>
<pre style="margin-bottom: 1.5rem">pip install xposedornot</pre>
<p style="margin-bottom: 1rem"><strong>Quick Example:</strong></p>
<pre>
from xposedornot import XposedOrNot
xon = XposedOrNot()
# Check email for breaches
result = xon.check_email('test@example.com')
print(result)</pre
>
<p style="margin-top: 1.5rem; display: flex; gap: 0.75rem; flex-wrap: wrap">
<a
href="https://pypi.org/project/xposedornot/"
target="_blank"
rel="noopener"
class="button-link"
style="padding: 10px 20px; font-size: 0.9em"
aria-label="View XposedOrNot Python SDK on PyPI"
>
<i class="fas fa-external-link-alt"></i> View on PyPI
</a>
<a
href="https://github.com/XposedOrNot/XposedOrNot-Python"
target="_blank"
rel="noopener"
class="button-link"
style="padding: 10px 20px; font-size: 0.9em; background: linear-gradient(135deg, #24292e, #40464e)"
aria-label="View XposedOrNot Python SDK on GitHub"
>
<i class="fab fa-github"></i> GitHub
</a>
</p>
</div>
</div>
</div>
<h3 style="text-align: center; margin-top: 2rem; margin-bottom: 0.5rem; font-size: 1.1rem">Also Available For</h3>
<p style="text-align: center; color: var(--secondary-color); margin-bottom: 1.25rem; font-size: 0.85rem">
Click any card to view the package registry, or the GitHub icon for source code.
</p>
<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(170px, 1fr)); gap: 1rem;">
<div class="sdk-card" role="group" aria-label="Go SDK">
<a href="https://pkg.go.dev/github.com/XposedOrNot/XposedOrNot-Go" target="_blank" rel="noopener" class="sdk-card-main" aria-label="View Go SDK on pkg.go.dev">
<i class="fas fa-code" style="color: #00add8"></i>
<span class="sdk-card-lang">Go</span>
<code>go get</code>
</a>
<a href="https://github.com/XposedOrNot/XposedOrNot-Go" target="_blank" rel="noopener" class="sdk-card-gh" aria-label="Go SDK on GitHub">
<i class="fab fa-github"></i>
</a>
</div>
<div class="sdk-card" role="group" aria-label="Ruby SDK">
<a href="https://rubygems.org/gems/xposedornot" target="_blank" rel="noopener" class="sdk-card-main" aria-label="View Ruby SDK on RubyGems">
<i class="fas fa-gem" style="color: #cc342d"></i>
<span class="sdk-card-lang">Ruby</span>
<code>gem install</code>
</a>
<a href="https://github.com/XposedOrNot/XposedOrNot-Ruby" target="_blank" rel="noopener" class="sdk-card-gh" aria-label="Ruby SDK on GitHub">
<i class="fab fa-github"></i>
</a>
</div>
<div class="sdk-card" role="group" aria-label="PHP SDK">
<a href="https://packagist.org/packages/xposedornot/xposedornot-php" target="_blank" rel="noopener" class="sdk-card-main" aria-label="View PHP SDK on Packagist">
<i class="fab fa-php" style="color: #777bb4"></i>
<span class="sdk-card-lang">PHP</span>
<code>composer require</code>
</a>
<a href="https://github.com/XposedOrNot/XposedOrNot-PHP" target="_blank" rel="noopener" class="sdk-card-gh" aria-label="PHP SDK on GitHub">
<i class="fab fa-github"></i>
</a>
</div>
<div class="sdk-card" role="group" aria-label="Rust SDK">
<a href="https://crates.io/crates/xposedornot" target="_blank" rel="noopener" class="sdk-card-main" aria-label="View Rust SDK on crates.io">
<i class="fas fa-cog" style="color: #dea584"></i>
<span class="sdk-card-lang">Rust</span>
<code>cargo add</code>
</a>
<a href="https://github.com/XposedOrNot/XposedOrNot-Rust" target="_blank" rel="noopener" class="sdk-card-gh" aria-label="Rust SDK on GitHub">
<i class="fab fa-github"></i>
</a>
</div>
<div class="sdk-card" role="group" aria-label="C# .NET SDK">
<a href="https://www.nuget.org/packages/XposedOrNot" target="_blank" rel="noopener" class="sdk-card-main" aria-label="View C# .NET SDK on NuGet">
<i class="fas fa-window-maximize" style="color: #512bd4"></i>
<span class="sdk-card-lang">C# / .NET</span>
<code>dotnet add</code>
</a>
<a href="https://github.com/XposedOrNot/XposedOrNot-DotNet" target="_blank" rel="noopener" class="sdk-card-gh" aria-label="C# .NET SDK on GitHub">
<i class="fab fa-github"></i>
</a>
</div>
<div class="sdk-card" role="group" aria-label="Java SDK">
<a href="https://central.sonatype.com/artifact/com.xposedornot/xposedornot" target="_blank" rel="noopener" class="sdk-card-main" aria-label="View Java SDK on Maven Central">
<i class="fab fa-java" style="color: #f89820"></i>
<span class="sdk-card-lang">Java</span>
<code>Maven Central</code>
</a>
<a href="https://github.com/XposedOrNot/XposedOrNot-Jav" target="_blank" rel="noopener" class="sdk-card-gh" aria-label="Java SDK on GitHub">
<i class="fab fa-github"></i>
</a>
</div>
</div>
<p
style="
text-align: center;
color: var(--secondary-color);
margin-top: 1.5rem;
font-size: 0.9rem;
"
>
Prefer a ready-made integration? XposedOrNot plugs into MISP,
TheHive/Cortex, OpenCTI, Maltego, Wazuh, Splunk and Microsoft Sentinel.
<a href="/integrations">Browse all integrations</a>.
</p>
</div>
<br />
<div class="mobile-toc" id="mobile-toc">
<div class="mobile-toc-toggle" onclick="this.parentElement.classList.toggle('expanded')">
<span><i class="fas fa-list-ul"></i> Quick Navigation</span>
</div>
<div class="mobile-toc-content">
<ul>
<li><a href="#sdk-section" class="toc-link"><i class="fas fa-cube"></i> Official SDKs</a></li>
<li><a href="#endpoint-1" class="toc-link"><i class="fas fa-envelope"></i> Email Breach</a></li>
<li><a href="#endpoint-2" class="toc-link"><i class="fas fa-chart-line"></i> Analytics</a></li>
<li><a href="#endpoint-3" class="toc-link"><i class="fas fa-key"></i> Password</a></li>
<li><a href="#endpoint-4" class="toc-link"><i class="fas fa-database"></i> All Breaches</a></li>
<li><a href="#endpoint-5" class="toc-link"><i class="fas fa-shield-alt"></i> Domain</a></li>
<li><a href="#endpoint-6" class="toc-link"><i class="fas fa-code"></i> Response Codes</a></li>
</ul>
</div>
</div>
<div
style="
display: flex;
gap: 2rem;
align-items: flex-start;
max-width: 100%;
"
>
<nav
id="api-toc"
style="
position: sticky;
top: 2rem;
width: 240px;
flex-shrink: 0;
z-index: 1;
"
>
<div
style="
background: var(--panel-bg);
border: 1px solid var(--border-color);
border-radius: 12px;
padding: 1rem 1.25rem;
"
>
<h4
style="
margin-top: 0;
margin-bottom: 0.75rem;
color: var(--primary-color);
font-size: 0.95rem;
"
>
Quick Navigation
</h4>
<ul style="list-style: none; padding: 0; margin: 0">
<li style="margin-bottom: 0.5rem">
<a href="#sdk-section" class="toc-link"
><i class="fas fa-cube"></i> Official SDKs</a
>
</li>
<li style="margin-bottom: 0.5rem">
<a href="#endpoint-1" class="toc-link"
><i class="fas fa-envelope"></i> Email Breach Check</a
>
</li>
<li style="margin-bottom: 0.5rem">
<a href="#endpoint-2" class="toc-link"
><i class="fas fa-chart-line"></i> Breach Analytics</a
>
</li>
<li style="margin-bottom: 0.5rem">
<a href="#endpoint-3" class="toc-link"
><i class="fas fa-key"></i> Password Check</a
>
</li>
<li style="margin-bottom: 0.5rem">
<a href="#endpoint-4" class="toc-link"
><i class="fas fa-database"></i> All Breaches</a
>
</li>
<li style="margin-bottom: 0.5rem">
<a href="#endpoint-5" class="toc-link"
><i class="fas fa-shield-alt"></i> Domain Breaches</a
>
</li>
<li style="margin-bottom: 0.5rem">
<a href="#endpoint-6" class="toc-link"
><i class="fas fa-code"></i> Response Codes</a
>
</li>
</ul>
</div>
</nav>
<div style="flex: 1; min-width: 0">
<div class="panel-group" id="accordion">
<div class="panel panel-default">
<div class="panel-heading">
API Quick Reference
<span
style="float: right; font-size: 0.9em; font-weight: normal"
>Last Updated: 03-Jun-2026</span
>
</div>
<div id="collapse1" style="display: block">
<div class="panel-body">
<br />
Thank you for your interest in <strong>XposedOrNot</strong>.
The goal is to keep our API as accessible and responsive as
possible, making it a valuable tool for everyone. Hosted
directly on <strong>Google Infrastructure</strong> and
robustly cached by <strong>Cloudflare</strong>, the
<strong>XposedOrNot API</strong> offers rapid responses for
any queries, regardless of their origin point. <br /><br />
The <strong>XposedOrNot API</strong> adheres to the principles
of <strong>REST architecture</strong>. It returns
<strong>JSON-encoded responses</strong> and utilizes
<strong>standard HTTP response codes</strong>. For the
majority of our API routes, there are no authentication
requirements, ensuring easy access and simplicity of use.
However, please note that our specific
<strong
>API route used for querying domain-related data requires an
API key authorization</strong
>. This measure is in place to ensure that only verified
owners or authorities of the specified domains can access this
sensitive information.<br /><br />
To experiment with the endpoints, try the API Playground,
where you can explore the XposedOrNot API interactively.
<br />
<hr />
<p>
<strong>Reading the examples:</strong> values shown in
<code>{curly braces}</code> are placeholders. Replace
each one (including the braces) with your own value. For
example, <code>{email}</code> becomes
<code>test@example.com</code>.
</p>
<div id="rate-limits" class="alert alert-primary" role="alert">
<h4><strong>Rate Limits</strong></h4>
</div>
<p>Free-tier limits per IP address, per endpoint:</p>
<div class="table-responsive">
<table class="table table-condensed table-striped table-bordered table-hover">
<caption class="sr-only-caption">Free tier rate limits by endpoint</caption>
<thead><tr><th scope="col">Endpoint</th><th scope="col">Per second</th><th scope="col">Per hour</th><th scope="col">Per day</th></tr></thead>
<tbody><tr><th scope="row"><code>/v1/check-email/{email}</code></th><td>2</td><td>25</td><td>100</td></tr><tr><th scope="row"><code>/v1/breach-analytics</code></th><td>2</td><td>25</td><td>100</td></tr><tr><th scope="row"><code>/v1/breaches</code></th><td>2</td><td>50</td><td>100</td></tr><tr><th scope="row"><code>/v1/domain-breaches</code></th><td>2</td><td>25</td><td>50</td></tr><tr><th scope="row"><code>/v1/metrics</code></th><td>5/min</td><td>50</td><td>100</td></tr><tr><th scope="row"><code>/api/v1/pass/anon/{prefix}</code></th><td colspan="3">Separate high-volume service; no fixed published limit.</td></tr></tbody>
</table>
</div>
<p>HTTP 429 means you hit an hourly or daily cap: wait for the window to reset before retrying. The response includes a link to higher-limit plans.</p>
<div class="alert alert-primary" role="alert">
<h4><strong>Need higher rate limits?</strong></h4>
<p style="margin-bottom: 0">The free API is for personal and low-volume use, and it stays free. If you are building a product on breach data or need more throughput, <a href="https://plus.xposedornot.com/products/api" target="_blank" rel="noopener">xonAPI+</a> offers paid plans from $9/month with rate limits up to 25,000 requests/minute, API-key access, and commercial support. It is the same breach data, and it is what keeps the free tier free.</p>
</div>
<hr />
<div id="endpoint-1" class="alert alert-primary" role="alert">
<h4>
<span class="http-badge http-get">GET</span>
<strong
>1. API Call: Checking for Email Address Data
Breaches</strong
>
</h4>
</div>
<p>
This API checks if an email address
has been involved in any known data breaches. It searches a
comprehensive database of breaches and alerts you if the
email is at risk.
</p>
<br /><strong>API Endpoint:</strong>
<blockquote>
<pre>
https://api.xposedornot.com/v1/check-email/{email}</pre
>
</blockquote>
<strong>Parameters:</strong>
<div class="table-responsive">
<table class="table table-condensed table-striped table-bordered table-hover">
<caption class="sr-only-caption">Parameters for the check-email endpoint</caption>
<thead>
<tr>
<th scope="col">Parameter</th>
<th scope="col">In</th>
<th scope="col">Required</th>
<th scope="col">Type</th>
<th scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row"><code>email</code></th>
<td>path</td>
<td>Yes</td>
<td>string</td>
<td>Email address to check for breaches.</td>
</tr>
<tr>
<th scope="row"><code>details</code></th>
<td>query</td>
<td>No</td>
<td>boolean</td>
<td>Include detailed breach information in the response. Defaults to <code>false</code> (accepts true/false, yes/no, 1/0).</td>
</tr>
</tbody>
</table>
</div>
<strong> Example of Successful Breach Detection: </strong>
When a breach is detected, you'll receive a JSON response like
this:
<pre>
{
"breaches": [
[
"Tesco",
"KiwiFarms",
"Vermillion",
"Verified",
"LizardSquad",
"2fast4u",
"Autotrader",
"MyRepoSpace",
"SweClockers"
]
],
"email": "<!--email_off-->test@example.com<!--/email_off-->",
"status": "success"
}
</pre
>
The response is in JSON format, making it simple to parse with
any scripting language. This lets you easily integrate the
data into your applications.
<br />
<strong>Response When No Breach is Found:</strong><br />
If the email address is not found in any breach database, you
will get the following JSON response:
<pre>
{"Error":"Not found","email":null}
</pre
>
<hr />
<div id="endpoint-2" class="alert alert-primary" role="alert">
<h4>
<span class="http-badge http-get">GET</span>
<strong
>2. API Call: Data Breach Analytics for Email
Addresses</strong
>
</h4>
</div>
<p>
Our API offers an in-depth analysis of an email address's
data breach history. It reveals when and where breaches
occurred, providing essential analytics to gauge the impact
and severity of these incidents. This tool is key for
understanding data exposure levels and enhancing security
strategies.
</p>
<br /><strong>API Endpoint:</strong>
<blockquote>
<pre>
https://api.xposedornot.com/v1/breach-analytics?email={email}</pre
>
</blockquote>
<strong>Parameters:</strong>
<div class="table-responsive">
<table class="table table-condensed table-striped table-bordered table-hover">
<caption class="sr-only-caption">Parameters for the breach-analytics endpoint</caption>
<thead>
<tr>
<th scope="col">Parameter</th>
<th scope="col">In</th>
<th scope="col">Required</th>
<th scope="col">Type</th>
<th scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row"><code>email</code></th>
<td>query</td>
<td>Yes</td>
<td>string</td>
<td>Email address to analyze.</td>
</tr>
</tbody>
</table>
</div>
<p>
The API responds with two possible outcomes: success or
failure. Below are the key components of a successful
response:
</p>
<br />
<ul>
<li>
<strong>BreachesSummary:</strong> Get a quick overview of
all breaches tied to the email address, including a list
of affected sites. Ideal for a fast check on breach
history.
</li>
<br />
<li>
<strong>ExposedBreaches:</strong> Receive detailed
information on each breach, including the breached
entity's name, description, domain, industry, risk level,
references, exposed data types, and the year and number of
records exposed. This helps assess the specifics and
seriousness of each breach.
</li>
<br />
<li>
<strong>BreachMetrics:</strong> This component offers
analytics about the breaches, such as affected industries,
password strength, risk score, data types exposed, and a
yearly breakdown. This data is crucial for understanding
the full impact of the breaches.
</li>
<br />
<li>
<strong>xposed_data:</strong> Gain insight into the
specific data types exposed in the breaches, such as
names, photos, nationalities, etc. This helps in
understanding the nature and extent of personal data
exposure.
</li>
<br />
<li>
<strong>PastesSummary:</strong> Provides an overview of
'paste' breaches (data exposures on public pastebin-like
services), including a count and the most recent
occurrence. It's a quick way to gauge exposure on these
platforms.
</li>
<br />
<li>
<strong>ExposedPastes & PasteMetrics:</strong> These
components give detailed information and a yearly analysis
of paste breaches, allowing for a deeper understanding of
exposure trends over time.
</li>
<br />
</ul>
<p>
This comprehensive suite of analytics tools offers a deep
dive into the data breach history of any email, providing
the insights needed for better digital security management.
</p>
<br />
<strong
>Sample JSON output on successfully finding a matching
record:
</strong>
<pre>
{
"BreachMetrics": {
"get_details": [],
"industry": [
[
[ "elec", 1 ],
[ "misc", 0 ],
[ "mini", 0 ],
[ "musi", 0 ],
[ "manu", 0 ],
[ "ener", 0 ],
[ "news", 0 ],
[ "ente", 0 ],
[ "hosp", 0 ],
[ "heal", 0 ],
[ "food", 0 ],
[ "phar", 0 ],
[ "educ", 0 ],
[ "cons", 0 ],
[ "agri", 0 ],
[ "tele", 0 ],
[ "info", 0 ],
[ "tran", 0 ],
[ "aero", 0 ],
[ "fina", 0 ],
[ "reta", 0 ],
[ "nonp", 0 ],
[ "govt", 0 ],
[ "spor", 0 ],
[ "envi", 0 ]
]
],
"passwords_strength": [
{
"EasyToCrack": 0,
"PlainText": 0,
"StrongHash": 1,
"Unknown": 0
}
],
"risk": [
{
"risk_label": "Low",
"risk_score": 3
}
],
"xposed_data": [
{
"children": [
{
"children": [
{
"colname": "level3",
"group": "A",
"name": "data_Usernames",
"value": 1
}
],
"colname": "level2",
"name": "👤 Personal Identification"
},
{
"children": [
{
"colname": "level3",
"group": "D",
"name": "data_Passwords",
"value": 1
}
],
"colname": "level2",
"name": "🔒 Security Practices"
},
{
"children": [
{
"colname": "level3",
"group": "F",
"name": "data_Email addresses",
"value": 1
}
],
"colname": "level2",
"name": "📞 Communication and Social Interactions"
}