forked from passivetotal/python_api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.html
More file actions
809 lines (685 loc) · 47.8 KB
/
api.html
File metadata and controls
809 lines (685 loc) · 47.8 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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>API Wrappers — PassiveTotal 2.0.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="PassiveTotal 2.0.0 documentation" href="index.html"/>
<link rel="next" title="DNS Results" href="dns.html"/>
<link rel="prev" title="Writing Tools" href="developers.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> PassiveTotal
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#quick-start">Quick Start</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#library-organization">Library Organization</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="outputs.html">Output Formats</a><ul>
<li class="toctree-l2"><a class="reference internal" href="outputs.html#text">Text</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputs.html#table">Table</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputs.html#csv">CSV</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputs.html#stix">STIX</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputs.html#json">JSON</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputs.html#xml">XML</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="developers.html">Writing Tools</a><ul>
<li class="toctree-l2"><a class="reference internal" href="developers.html#building-a-simple-tool">Building a Simple Tool</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="">API Wrappers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-passivetotal.api">Base Client</a></li>
<li class="toctree-l2"><a class="reference internal" href="#dns-request">DNS Request</a></li>
<li class="toctree-l2"><a class="reference internal" href="#whois-request">WHOIS Request</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ssl-request">SSL Request</a></li>
<li class="toctree-l2"><a class="reference internal" href="#actions-request">Actions Request</a></li>
<li class="toctree-l2"><a class="reference internal" href="#attribute-request">Attribute Request</a></li>
<li class="toctree-l2"><a class="reference internal" href="#enrichment-request">Enrichment Request</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dns.html">DNS Results</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dns.html#dnsresponse">DnsResponse</a></li>
<li class="toctree-l2"><a class="reference internal" href="dns.html#dnsrecord">DnsRecord</a></li>
<li class="toctree-l2"><a class="reference internal" href="dns.html#dnsuniqueresponse">DnsUniqueResponse</a></li>
<li class="toctree-l2"><a class="reference internal" href="dns.html#uniquednsrecord">UniqueDnsRecord</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="whois.html">WHOIS Results</a><ul>
<li class="toctree-l2"><a class="reference internal" href="whois.html#whoisrequest">WhoisRequest</a></li>
<li class="toctree-l2"><a class="reference internal" href="whois.html#whoisresponse">WhoisResponse</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ssl.html">SSL Results</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ssl.html#sslrequest">SslRequest</a></li>
<li class="toctree-l2"><a class="reference internal" href="ssl.html#sslhistoryresponse">SslHistoryResponse</a></li>
<li class="toctree-l2"><a class="reference internal" href="ssl.html#historyrecord">HistoryRecord</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="attributes.html">Attribute Results</a><ul>
<li class="toctree-l2"><a class="reference internal" href="attributes.html#attributeresponse">AttributeResponse</a></li>
<li class="toctree-l2"><a class="reference internal" href="attributes.html#geneticattributerecord">GeneticAttributeRecord</a></li>
</ul>
</li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PassiveTotal</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>API Wrappers</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/api.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<div class="section" id="api-wrappers">
<h1>API Wrappers<a class="headerlink" href="#api-wrappers" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-passivetotal.api">
<span id="base-client"></span><h2>Base Client<a class="headerlink" href="#module-passivetotal.api" title="Permalink to this headline">¶</a></h2>
<p>PassiveTotal API Interface.</p>
<dl class="class">
<dt id="passivetotal.api.Client">
<em class="property">class </em><code class="descclassname">passivetotal.api.</code><code class="descname">Client</code><span class="sig-paren">(</span><em>username</em>, <em>api_key</em>, <em>server='api.passivetotal.org'</em>, <em>version='v2'</em>, <em>http_proxy=None</em>, <em>https_proxy=None</em>, <em>verify=True</em>, <em>headers=None</em>, <em>debug=False</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.api.Client" title="Permalink to this definition">¶</a></dt>
<dd><p>Base client that all data sources will inherit from.</p>
<dl class="method">
<dt id="passivetotal.api.Client._endpoint">
<code class="descname">_endpoint</code><span class="sig-paren">(</span><em>endpoint</em>, <em>action</em>, <em>*url_args</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.api.Client._endpoint" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the URL for the action.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>endpoint</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – The controller</li>
<li><strong>action</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – The action provided by the controller</li>
<li><strong>url_args</strong> – Additional endpoints(for endpoints that take part of
the url as option)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Full URL for the requested action</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.api.Client._get">
<code class="descname">_get</code><span class="sig-paren">(</span><em>endpoint</em>, <em>action</em>, <em>*url_args</em>, <em>**url_params</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.api.Client._get" title="Permalink to this definition">¶</a></dt>
<dd><p>Request API Endpoint - for GET methods.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>endpoint</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Endpoint</li>
<li><strong>action</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Endpoint Action</li>
<li><strong>url_args</strong> – Additional endpoints(for endpoints that take part of
the url as option)</li>
<li><strong>url_params</strong> – Parameters to pass to url, typically query string</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">response deserialized from JSON</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.api.Client._get_special">
<code class="descname">_get_special</code><span class="sig-paren">(</span><em>endpoint</em>, <em>action</em>, <em>trail</em>, <em>data</em>, <em>*url_args</em>, <em>**url_params</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.api.Client._get_special" title="Permalink to this definition">¶</a></dt>
<dd><p>Request API Endpoint - for GET methods.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>endpoint</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Endpoint</li>
<li><strong>action</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Endpoint Action</li>
<li><strong>url_args</strong> – Additional endpoints(for endpoints that take part of
the url as option)</li>
<li><strong>url_params</strong> – Parameters to pass to url, typically query string</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">response deserialized from JSON</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.api.Client._json">
<code class="descname">_json</code><span class="sig-paren">(</span><em>response</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.api.Client._json" title="Permalink to this definition">¶</a></dt>
<dd><p>JSON response from server.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>response</strong> – Response from the server</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">Throws ValueError:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">from requests’ response.json() error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">response deserialized from JSON</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.api.Client._send_data">
<code class="descname">_send_data</code><span class="sig-paren">(</span><em>method</em>, <em>endpoint</em>, <em>action</em>, <em>data</em>, <em>*url_args</em>, <em>**url_params</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.api.Client._send_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Submit to API Endpoint - for DELETE, PUT, POST methods.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>method</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Method to use for the request</li>
<li><strong>endpoint</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Endpoint</li>
<li><strong>action</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Endpoint Action</li>
<li><strong>url_args</strong> – Additional endpoints(for endpoints that take part of
the url as option)</li>
<li><strong>url_params</strong> – Parameters to pass to url, typically query string</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">response deserialized from JSON</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="classmethod">
<dt id="passivetotal.api.Client.from_config">
<em class="property">classmethod </em><code class="descname">from_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.api.Client.from_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Method to return back a loaded instance.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="dns-request">
<h2>DNS Request<a class="headerlink" href="#dns-request" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="passivetotal.libs.dns.DnsRequest">
<em class="property">class </em><code class="descclassname">passivetotal.libs.dns.</code><code class="descname">DnsRequest</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.dns.DnsRequest" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#passivetotal.api.Client" title="passivetotal.api.Client"><code class="xref py py-class docutils literal"><span class="pre">passivetotal.api.Client</span></code></a></p>
<p>Client to interface with the DNS calls from the PassiveTotal API.</p>
<dl class="method">
<dt id="passivetotal.libs.dns.DnsRequest.get_passive_dns">
<code class="descname">get_passive_dns</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.dns.DnsRequest.get_passive_dns" title="Permalink to this definition">¶</a></dt>
<dd><p>Get passive DNS data based on a query value.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-DNS-GetDnsPassiveQuery">https://api.passivetotal.org/api/docs/#api-DNS-GetDnsPassiveQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>query</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Query value to use when making the request for data</li>
<li><strong>start</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Starting period for record filtering</li>
<li><strong>end</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Ending period for record filtering</li>
<li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – Timeout to apply to source queries</li>
<li><strong>sources</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) – List of sources to use for the query</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">List of passive DNS results</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.dns.DnsRequest.get_unique_resolutions">
<code class="descname">get_unique_resolutions</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.dns.DnsRequest.get_unique_resolutions" title="Permalink to this definition">¶</a></dt>
<dd><p>Get unique resolutions from passive DNS.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-DNS-GetDnsPassiveUniqueQuery">https://api.passivetotal.org/api/docs/#api-DNS-GetDnsPassiveUniqueQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>query</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Query value to use when making the request for data</li>
<li><strong>start</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Starting period for record filtering</li>
<li><strong>end</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Ending period for record filtering</li>
<li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – Timeout to apply to source queries</li>
<li><strong>sources</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) – List of sources to use for the query</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">List of passive DNS unique resolutions</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.dns.DnsRequest.search_keyword">
<code class="descname">search_keyword</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.dns.DnsRequest.search_keyword" title="Permalink to this definition">¶</a></dt>
<dd><p>Search for a keyword across passive DNS data.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-DNS-GetV2DnsSearchKeywordQuery">https://api.passivetotal.org/api/docs/#api-DNS-GetV2DnsSearchKeywordQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>query</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Keyword value to search for in the dataset</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of matching hits based on the keyword</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="whois-request">
<h2>WHOIS Request<a class="headerlink" href="#whois-request" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="passivetotal.libs.whois.WhoisRequest">
<em class="property">class </em><code class="descclassname">passivetotal.libs.whois.</code><code class="descname">WhoisRequest</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.whois.WhoisRequest" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#passivetotal.api.Client" title="passivetotal.api.Client"><code class="xref py py-class docutils literal"><span class="pre">passivetotal.api.Client</span></code></a></p>
<p>Client to interface with the WHOIS calls from the PassiveTotal API.</p>
<dl class="method">
<dt id="passivetotal.libs.whois.WhoisRequest.get_whois_details">
<code class="descname">get_whois_details</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.whois.WhoisRequest.get_whois_details" title="Permalink to this definition">¶</a></dt>
<dd><p>Get WHOIS details based on query value.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-WHOIS-GetV2WhoisQuery">https://api.passivetotal.org/api/docs/#api-WHOIS-GetV2WhoisQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>query</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Query value to use when making the request for data</li>
<li><strong>compact_record</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Return the record in a compact format</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">WHOIS details for the query</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.whois.WhoisRequest.search_keyword">
<code class="descname">search_keyword</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.whois.WhoisRequest.search_keyword" title="Permalink to this definition">¶</a></dt>
<dd><p>Search for a keyword across WHOIS data.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-WHOIS-GetV2WhoisSearchKeywordQuery">https://api.passivetotal.org/api/docs/#api-WHOIS-GetV2WhoisSearchKeywordQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>query</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Keyword value to search for in the dataset</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of matching hits based on the keyword</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.whois.WhoisRequest.search_whois_by_field">
<code class="descname">search_whois_by_field</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.whois.WhoisRequest.search_whois_by_field" title="Permalink to this definition">¶</a></dt>
<dd><p>Search WHOIS details based on query value and field.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-WHOIS-GetV2WhoisSearchQueryField">https://api.passivetotal.org/api/docs/#api-WHOIS-GetV2WhoisSearchQueryField</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>query</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Query value to use when making the request for data</li>
<li><strong>compact_record</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Return the record in a compact format</li>
<li><strong>field</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Field to run the query against</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">WHOIS records matching the query</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="ssl-request">
<h2>SSL Request<a class="headerlink" href="#ssl-request" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="passivetotal.libs.ssl.SslRequest">
<em class="property">class </em><code class="descclassname">passivetotal.libs.ssl.</code><code class="descname">SslRequest</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.ssl.SslRequest" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#passivetotal.api.Client" title="passivetotal.api.Client"><code class="xref py py-class docutils literal"><span class="pre">passivetotal.api.Client</span></code></a></p>
<p>Client to interface with the SSL calls from the PassiveTotal API.</p>
<dl class="method">
<dt id="passivetotal.libs.ssl.SslRequest.get_ssl_certificate_details">
<code class="descname">get_ssl_certificate_details</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.ssl.SslRequest.get_ssl_certificate_details" title="Permalink to this definition">¶</a></dt>
<dd><p>Get SSL certificate details based on query value.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-SSL_Certificates-GetSslCertificateQuery">https://api.passivetotal.org/api/docs/#api-SSL_Certificates-GetSslCertificateQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>query</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – SHA-1 or IP address</li>
<li><strong>compact_record</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Return the record in a compact format</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">SSL certificate details for the query</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.ssl.SslRequest.get_ssl_certificate_history">
<code class="descname">get_ssl_certificate_history</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.ssl.SslRequest.get_ssl_certificate_history" title="Permalink to this definition">¶</a></dt>
<dd><p>Search SSL certificate history.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-SSL_Certificates-GetSslCertificateHistoryQuery">https://api.passivetotal.org/api/docs/#api-SSL_Certificates-GetSslCertificateHistoryQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>query</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – SHA-1 or IP address</li>
<li><strong>compact_record</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Return the record in a compact format</li>
<li><strong>field</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Field to run the query against</li>
<li><strong>type</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Type of search to conduct</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">SSL certificates records matching the query</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.ssl.SslRequest.search_keyword">
<code class="descname">search_keyword</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.ssl.SslRequest.search_keyword" title="Permalink to this definition">¶</a></dt>
<dd><p>Search for a keyword across SSL certificate data.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-SSL_Certificates-GetV2SslCertificateSearchQueryField">https://api.passivetotal.org/api/docs/#api-SSL_Certificates-GetV2SslCertificateSearchQueryField</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>query</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Keyword value to search for in the dataset</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of matching hits based on the keyword</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.ssl.SslRequest.search_ssl_certificate_by_field">
<code class="descname">search_ssl_certificate_by_field</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.ssl.SslRequest.search_ssl_certificate_by_field" title="Permalink to this definition">¶</a></dt>
<dd><p>Search SSL certificate details based on query value and field.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-SSL_Certificates-GetSslCertificateSearchQueryField">https://api.passivetotal.org/api/docs/#api-SSL_Certificates-GetSslCertificateSearchQueryField</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>query</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Query value to use when making the request for data</li>
<li><strong>compact_record</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Return the record in a compact format</li>
<li><strong>field</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Field to run the query against</li>
<li><strong>type</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Type of search to conduct</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">SSL certificates matching the query</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="actions-request">
<h2>Actions Request<a class="headerlink" href="#actions-request" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="passivetotal.libs.actions.ActionsClient">
<em class="property">class </em><code class="descclassname">passivetotal.libs.actions.</code><code class="descname">ActionsClient</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.actions.ActionsClient" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#passivetotal.api.Client" title="passivetotal.api.Client"><code class="xref py py-class docutils literal"><span class="pre">passivetotal.api.Client</span></code></a></p>
<p>Client to interface with the Actions calls from the PassiveTotal API.</p>
</dd></dl>
</div>
<div class="section" id="attribute-request">
<h2>Attribute Request<a class="headerlink" href="#attribute-request" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="passivetotal.libs.attributes.AttributeRequest">
<em class="property">class </em><code class="descclassname">passivetotal.libs.attributes.</code><code class="descname">AttributeRequest</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.attributes.AttributeRequest" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#passivetotal.api.Client" title="passivetotal.api.Client"><code class="xref py py-class docutils literal"><span class="pre">passivetotal.api.Client</span></code></a></p>
<p>Client to interface with the account calls from the PassiveTotal API.</p>
<dl class="method">
<dt id="passivetotal.libs.attributes.AttributeRequest.get_host_attribute_components">
<code class="descname">get_host_attribute_components</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.attributes.AttributeRequest.get_host_attribute_components" title="Permalink to this definition">¶</a></dt>
<dd><p>Get components associated with a particular host or IP address.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-Host_Attributes-GetComponents">https://api.passivetotal.org/api/docs/#api-Host_Attributes-GetComponents</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Dict of results with component information</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.attributes.AttributeRequest.get_host_attribute_pairs">
<code class="descname">get_host_attribute_pairs</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.attributes.AttributeRequest.get_host_attribute_pairs" title="Permalink to this definition">¶</a></dt>
<dd><p>Get pairs associated with a particular hostname.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-Host_Attributes-GetV2HostAttributesPairsQueryDirection">https://api.passivetotal.org/api/docs/#api-Host_Attributes-GetV2HostAttributesPairsQueryDirection</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Dict of results with component information</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.attributes.AttributeRequest.get_host_attribute_trackers">
<code class="descname">get_host_attribute_trackers</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.attributes.AttributeRequest.get_host_attribute_trackers" title="Permalink to this definition">¶</a></dt>
<dd><p>Get trackers associated with a particular host or IP address.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-Host_Attributes-GetTrackers">https://api.passivetotal.org/api/docs/#api-Host_Attributes-GetTrackers</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Dict of results with tracking IDs</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.attributes.AttributeRequest.search_trackers">
<code class="descname">search_trackers</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.attributes.AttributeRequest.search_trackers" title="Permalink to this definition">¶</a></dt>
<dd><p>Search tracking IDs for associated hosts.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-Host_Attributes-SearchTrackers">https://api.passivetotal.org/api/docs/#api-Host_Attributes-SearchTrackers</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Dict of matching hosts using a tracking ID</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="enrichment-request">
<h2>Enrichment Request<a class="headerlink" href="#enrichment-request" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="passivetotal.libs.enrichment.EnrichmentRequest">
<em class="property">class </em><code class="descclassname">passivetotal.libs.enrichment.</code><code class="descname">EnrichmentRequest</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.enrichment.EnrichmentRequest" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#passivetotal.api.Client" title="passivetotal.api.Client"><code class="xref py py-class docutils literal"><span class="pre">passivetotal.api.Client</span></code></a></p>
<p>Client to interface with the enrichment calls from the PassiveTotal API.</p>
<dl class="method">
<dt id="passivetotal.libs.enrichment.EnrichmentRequest.get_bulk_enrichment">
<code class="descname">get_bulk_enrichment</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.enrichment.EnrichmentRequest.get_bulk_enrichment" title="Permalink to this definition">¶</a></dt>
<dd><p>Get bulk enrichment data for a value.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentBulkQuery">https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentBulkQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>query</strong> – Value to enrich</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Dict of results</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.enrichment.EnrichmentRequest.get_bulk_malware">
<code class="descname">get_bulk_malware</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.enrichment.EnrichmentRequest.get_bulk_malware" title="Permalink to this definition">¶</a></dt>
<dd><p>Get bulk malware data for a value.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentBulkMalwareQuery">https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentBulkMalwareQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>query</strong> – Value to search for in OSINT</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Dict of results</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.enrichment.EnrichmentRequest.get_bulk_osint">
<code class="descname">get_bulk_osint</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.enrichment.EnrichmentRequest.get_bulk_osint" title="Permalink to this definition">¶</a></dt>
<dd><p>Get bulk OSINT data for a value.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentBulkOsintQuery">https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentBulkOsintQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>query</strong> – Value to search for in OSINT</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Dict of results</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.enrichment.EnrichmentRequest.get_enrichment">
<code class="descname">get_enrichment</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.enrichment.EnrichmentRequest.get_enrichment" title="Permalink to this definition">¶</a></dt>
<dd><p>Get enrichment data for a value.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentQuery">https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>query</strong> – Value to enrich</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Dict of results</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.enrichment.EnrichmentRequest.get_malware">
<code class="descname">get_malware</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.enrichment.EnrichmentRequest.get_malware" title="Permalink to this definition">¶</a></dt>
<dd><p>Get malware data for a value.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentMalwareQuery">https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentMalwareQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>query</strong> – Value to search for in malware</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Dict of results</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.enrichment.EnrichmentRequest.get_osint">
<code class="descname">get_osint</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.enrichment.EnrichmentRequest.get_osint" title="Permalink to this definition">¶</a></dt>
<dd><p>Get OSINT data for a value.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentOsintQuery">https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentOsintQuery</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>query</strong> – Value to search for in OSINT</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Dict of results</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="passivetotal.libs.enrichment.EnrichmentRequest.get_subdomains">
<code class="descname">get_subdomains</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#passivetotal.libs.enrichment.EnrichmentRequest.get_subdomains" title="Permalink to this definition">¶</a></dt>
<dd><p>Get listing of subdomains for a given query.</p>
<p>Reference: <a class="reference external" href="https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentSubdomains">https://api.passivetotal.org/api/docs/#api-Enrichment-GetV2EnrichmentSubdomains</a></p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="dns.html" class="btn btn-neutral float-right" title="DNS Results" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="developers.html" class="btn btn-neutral" title="Writing Tools" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2016, Brandon Dixon.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'2.0.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>