-
Notifications
You must be signed in to change notification settings - Fork 7
/
api.html
1247 lines (1103 loc) · 90.8 KB
/
api.html
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>
<!--[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 Reference — nasapy 0.2.3 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Version History" href="versions.html" />
<link rel="prev" title="Nasapy Documentation" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> nasapy
</a>
<div class="version">
0.2
</div>
<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 current"><a class="current reference internal" href="#">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#nasa-nasa-api-wrapper"><code class="docutils literal notranslate"><span class="pre">Nasa</span></code> - NASA API Wrapper</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#astronomy-picture-of-the-day">Astronomy Picture of the Day</a></li>
<li class="toctree-l3"><a class="reference internal" href="#mars-weather-insight">Mars Weather Insight</a></li>
<li class="toctree-l3"><a class="reference internal" href="#near-earth-objects">Near Earth Objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="#donki-space-weather-database-of-notifications-knowledge-and-information">DONKI (Space Weather Database of Notifications, Knowledge, and Information)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#epic-earth-polychromatic-imaging-camera">EPIC (Earth Polychromatic Imaging Camera)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#earth-satellite-imagery">Earth Satellite Imagery</a></li>
<li class="toctree-l3"><a class="reference internal" href="#mars-rover-photos">Mars Rover Photos</a></li>
<li class="toctree-l3"><a class="reference internal" href="#genelab-search">GeneLab Search</a></li>
<li class="toctree-l3"><a class="reference internal" href="#techport">Techport</a></li>
<li class="toctree-l3"><a class="reference internal" href="#tle-two-line-element-set-data">TLE (Two-Line Element Set Data)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#nasa-image-and-video-library">NASA Image and Video Library</a></li>
<li class="toctree-l3"><a class="reference internal" href="#solar-system-dynamics-ssd-and-center-for-near-earth-object-studies-cneos">Solar System Dynamics (SSD) and Center for Near-Earth Object Studies (CNEOS)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#other-methods">Other Methods</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="versions.html">Version History</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">nasapy</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 Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/api.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="api-reference">
<span id="api"></span><h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>
<div class="section" id="nasa-nasa-api-wrapper">
<h2><a class="reference internal" href="#Nasa" title="Nasa"><code class="xref py py-mod docutils literal notranslate"><span class="pre">Nasa</span></code></a> - NASA API Wrapper<a class="headerlink" href="#nasa-nasa-api-wrapper" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="Nasa">
<em class="property">class </em><code class="descname">Nasa</code><span class="sig-paren">(</span><span class="optional">[</span><em>key=None</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#Nasa" title="Permalink to this definition">¶</a></dt>
<dd><p>Class object containing the methods for interacting with NASA API endpoints that require an API key.</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>key</strong> – The generated API key received from the NASA API. Registering for an API key can be done on the <a class="reference external" href="https://api.nasa.gov/">NASA API webpage</a>. If <code class="code docutils literal notranslate"><span class="pre">None</span></code>, a ‘DEMO_KEY’ with a much more restricted access limit is used.</td>
</tr>
</tbody>
</table>
</dd></dl>
<div class="section" id="astronomy-picture-of-the-day">
<h3>Astronomy Picture of the Day<a class="headerlink" href="#astronomy-picture-of-the-day" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="Nasa.picture_of_the_day">
<code class="descclassname">Nasa.</code><code class="descname">picture_of_the_day</code><span class="sig-paren">(</span><em>[date=None][, hd=False]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.picture_of_the_day" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URL and other information for the NASA Astronomy Picture of the Day.</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>date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to the current date.</li>
<li><strong>hd</strong> – If True, returns the associated high-definition image of the Astrononmy Picture of the Day.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict. Dictionary object of the JSON data returned from the API.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize Nasa API Class with a demo key</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">Nasa</span><span class="p">()</span>
<span class="c1"># Return today's picture of the day</span>
<span class="n">n</span><span class="o">.</span><span class="n">picture_of_the_day</span><span class="p">()</span>
<span class="c1"># Return a previous date's picture of the day with the high-definition URL included.</span>
<span class="n">n</span><span class="o">.</span><span class="n">picture_of_the_day</span><span class="p">(</span><span class="s1">'2019-01-01'</span><span class="p">,</span> <span class="n">hd</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="mars-weather-insight">
<h3>Mars Weather Insight<a class="headerlink" href="#mars-weather-insight" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="Nasa.mars_weather">
<code class="descclassname">Nasa.</code><code class="descname">mars_weather</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.mars_weather" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns per-Sol (Martian Days) summary data for each of the last seven available Sols. Data is provided by NASA’s
InSight Mars lander and as such data for particular Sols may be recalculated as more data is received. For more
information on the data returned, please see <a class="reference external" href="https://github.com/nasa/api-docs/blob/gh-pages/InSight%20Weather%20API%20Documentation.pdf">NASA’s documentation</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">Return type:</th><td class="field-body">dict. Dictionary object representing the returned JSON data from the API.</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize NASA API object with a demo key</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">NASA</span><span class="p">()</span>
<span class="c1"># Return the most recent data for the previous seven Sols (Martian Days)</span>
<span class="n">n</span><span class="o">.</span><span class="n">mars_weather</span><span class="p">()</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="near-earth-objects">
<h3>Near Earth Objects<a class="headerlink" href="#near-earth-objects" title="Permalink to this headline">¶</a></h3>
<p>All the data is from the NASA JPL Asteroid team (<a class="reference external" href="http://neo.jpl.nasa.gov/">http://neo.jpl.nasa.gov/</a>). The API is maintained by the
<a class="reference external" href="https://github.com/SpaceRocks/">SpaceRocks team</a></p>
<dl class="method">
<dt id="Nasa.asteroid_feed">
<code class="descclassname">Nasa.</code><code class="descname">asteroid_feed</code><span class="sig-paren">(</span><em>[start_date][, end_date=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.asteroid_feed" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of asteroids based on their closest approach date to Earth.</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>start_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object.</li>
<li><strong>end_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to seven days after the provided <code class="code docutils literal notranslate"><span class="pre">start_date</span></code>.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict. Dictionary representing the returned JSON data from the API.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize the NASA API with a demo key.</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">NASA</span><span class="p">()</span>
<span class="c1"># Get asteroids approaching Earth at the beginning of 2019.</span>
<span class="n">n</span><span class="o">.</span><span class="n">asteroid_feed</span><span class="p">(</span><span class="n">start_date</span><span class="o">=</span><span class="s1">'2019-01-01'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="Nasa.get_asteroids">
<code class="descclassname">Nasa.</code><code class="descname">get_asteroids</code><span class="sig-paren">(</span><span class="optional">[</span><em>asteroid_id=None</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.get_asteroids" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns data from the overall asteroid data-set or specific asteroids given an ID.</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>asteroid_id</strong> – If None, the entire asteroid data set is returned. If an <code class="code docutils literal notranslate"><span class="pre">asteroid_id</span></code> is provided, data on that specific asteroid is returned.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">dict. Dictionary object representing the returned JSON data from the NASA API.</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">n</span> <span class="o">=</span> <span class="n">Nasa</span><span class="p">()</span>
<span class="c1"># Get entire asteroid data set.</span>
<span class="n">n</span><span class="o">.</span><span class="n">get_asteroids</span><span class="p">()</span>
<span class="c1"># Get asteroid with ID 3542519</span>
<span class="n">n</span><span class="o">.</span><span class="n">get_asteroids</span><span class="p">(</span><span class="n">asteroid_id</span><span class="o">=</span><span class="mi">3542519</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="donki-space-weather-database-of-notifications-knowledge-and-information">
<h3>DONKI (Space Weather Database of Notifications, Knowledge, and Information)<a class="headerlink" href="#donki-space-weather-database-of-notifications-knowledge-and-information" title="Permalink to this headline">¶</a></h3>
<p>The <a class="reference external" href="https://ccmc.gsfc.nasa.gov/donki/">Space Weather Database Of Notifications, Knowledge, Information (DONKI)</a>
is a comprehensive on-line tool for space weather forecasters, scientists, and the general space science community.
DONKI provides chronicles the daily interpretations of space weather observations, analysis, models, forecasts, and
notifications provided by the Space Weather Research Center (SWRC), comprehensive knowledge-base search
functionality to support anomaly resolution and space science research, intelligent linkages, relationships,
cause-and-effects between space weather activities and comprehensive webservice API access to information stored in
DONKI.</p>
<dl class="method">
<dt id="Nasa.coronal_mass_ejection">
<code class="descclassname">Nasa.</code><code class="descname">coronal_mass_ejection</code><span class="sig-paren">(</span><em>[start_date=None][, end_date=None][, accurate_only=True][, speed=0][, complete_entry=True][, half_angle=0][, catalog='ALL'][, keyword=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.coronal_mass_ejection" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns data collected on coronal mass ejection events.</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>start_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to 30 days prior to the current date in UTC time.</li>
<li><strong>end_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to the current date in UTC time.</li>
<li><strong>accurate_only</strong> – If True (default), only the most accurate results collected are returned.</li>
<li><strong>complete_entry</strong> – If True (default), only results with complete data is returned.</li>
<li><strong>speed</strong> – The lower limit of the speed of the CME event. Default is 0</li>
<li><strong>half_angle</strong> – The lower limit half angle of the CME event. Default is 0.</li>
<li><strong>catalog</strong> – Specifies which catalog of data to return results. Defaults to ‘ALL’ and must be one of {‘ALL’, ‘SWRC_CATALOG’, ‘JANG_ET_AL_CATALOG’}.</li>
<li><strong>keyword</strong> – Filter results by a specific keyword.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list. List of results representing returned JSON data. If no data is returned, an empty dictionary is returned.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize NASA API with a demo key</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">Nasa</span><span class="p">()</span>
<span class="c1"># View data from coronal mass ejection events from the last thirty days</span>
<span class="n">n</span><span class="o">.</span><span class="n">coronal_mass_ejection</span><span class="p">()</span>
<span class="c1"># View all CME events from the beginning of 2019.</span>
<span class="n">n</span><span class="o">.</span><span class="n">coronal_mass_ejection</span><span class="p">(</span><span class="n">start_date</span><span class="o">=</span><span class="s1">'2019-01-01'</span><span class="p">,</span> <span class="n">end_date</span><span class="o">=</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">today</span><span class="p">())</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="Nasa.geomagnetic_storm">
<code class="descclassname">Nasa.</code><code class="descname">geomagnetic_storm</code><span class="sig-paren">(</span><em>[start_date=None][,end_date=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.geomagnetic_storm" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns data collected on geomagnetic storm events.</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>start_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to 30 days prior to the current date in UTC time.</li>
<li><strong>end_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to the current date in UTC time.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list: List of results representing returned JSON data. If no data is returned, an empty dictionary is returned.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize API connection with a Demo Key</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">Nasa</span><span class="p">()</span>
<span class="c1"># Get geomagnetic storm events from the last thirty days.</span>
<span class="n">n</span><span class="o">.</span><span class="n">geomagnetic_storm</span><span class="p">()</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="Nasa.interplantary_shock">
<code class="descclassname">Nasa.</code><code class="descname">interplantary_shock</code><span class="sig-paren">(</span><em>[start_date=None][, end_date=None][, location='ALL'][, catalog='ALL']</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.interplantary_shock" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns data collected on interplantary shock events.</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>start_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to 30 days prior to the current date in UTC time.</li>
<li><strong>end_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to the current date in UTC time.</li>
<li><strong>location</strong> – Filters returned results to specified location of the interplantary shock event. Defaults to ‘ALL’ and must be one of {‘ALL’, ‘Earth’, ‘MESSENGER’, ‘STEREO A’, ‘STEREO B’}</li>
<li><strong>catalog</strong> – Filters results to a specified catalog of collected data. Defaults to ‘ALL’ and must be one of {‘ALL’, ‘SWRC_CATALOG’, ‘WINSLOW_MESSENGER_ICME_CATALOG’}</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list. List of results representing returned JSON data. If no data is returned, an empty list is returned.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="Nasa.solar_flare">
<code class="descclassname">Nasa.</code><code class="descname">solar_flare</code><span class="sig-paren">(</span><em>[start_date=None][, end_date=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.solar_flare" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns data on solar flare events.</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>start_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to 30 days prior to the current date in UTC time.</li>
<li><strong>end_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to the current date in UTC time.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list. If data is available in the specified date range, a list of dictionary objects representing the data from the API is returned. If no data is available, an empty dictionary is returned.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize API connection with a Demo Key</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">Nasa</span><span class="p">()</span>
<span class="c1"># Get solar flare events from May of 2019</span>
<span class="n">n</span><span class="o">.</span><span class="n">solar_flare</span><span class="p">(</span><span class="n">start_date</span><span class="o">=</span><span class="s1">'2019-05-01'</span><span class="p">,</span> <span class="n">end_date</span><span class="o">=</span><span class="s1">'2019-05-31'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="Nasa.solar_energetic_particle">
<code class="descclassname">Nasa.</code><code class="descname">solar_energetic_particle</code><span class="sig-paren">(</span><em>[start_date=None][, end_date=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.solar_energetic_particle" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns data available related to solar energetic particle events.</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>start_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to 30 days prior to the current date in UTC time.</li>
<li><strong>end_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to the current date in UTC time.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list. If data is available in the specified date range, a list of dictionary objects representing the data from the API is returned. If no data is available, an empty dictionary is returned.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize API connection with a Demo Key</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">Nasa</span><span class="p">()</span>
<span class="c1"># Get data from April 2017</span>
<span class="n">n</span><span class="o">.</span><span class="n">solar_energetic_particle</span><span class="p">(</span><span class="n">start_date</span><span class="o">=</span><span class="s1">'2017-04-01'</span><span class="p">,</span> <span class="n">end_date</span><span class="o">=</span><span class="s1">'2017-04-30'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="Nasa.magnetopause_crossing">
<code class="descclassname">Nasa.</code><code class="descname">magnetopause_crossing</code><span class="sig-paren">(</span><em>[start_date=None][, end_date=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.magnetopause_crossing" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns data available related to magnetopause crossing events.</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>start_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to 30 days prior to the current date in UTC time.</li>
<li><strong>end_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to the current date in UTC time.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list. If data is available in the specified date range, a list of dictionary objects representing the data from the API is returned. If no data is available, an empty dictionary is returned.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize API connection with a Demo Key</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">Nasa</span><span class="p">()</span>
<span class="c1"># Get data on magnetopause crossing events from 2018 to the current date.</span>
<span class="n">n</span><span class="o">.</span><span class="n">magnetopause_crossing</span><span class="p">(</span><span class="n">start_date</span><span class="o">=</span><span class="s1">'2018-01-01'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="Nasa.radiation_belt_enhancement">
<code class="descclassname">Nasa.</code><code class="descname">radiation_belt_enhancement</code><span class="sig-paren">(</span><em>[start_date=None][, end_date=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.radiation_belt_enhancement" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns data available related to radiation belt enhancement events.</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>start_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to 30 days prior to the current date in UTC time.</li>
<li><strong>end_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to the current date in UTC time.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list. If data is available in the specified date range, a list of dictionary objects representing the data from the API is returned. If no data is available, an empty dictionary is returned.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize API connection with a Demo Key</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">Nasa</span><span class="p">()</span>
<span class="c1"># Get data on radiation belt enhancement events from the last 30 days.</span>
<span class="n">n</span><span class="o">.</span><span class="n">radiation_belt_enhancement</span><span class="p">()</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="Nasa.hight_speed_stream">
<code class="descclassname">Nasa.</code><code class="descname">hight_speed_stream</code><span class="sig-paren">(</span><em>[start_date=None][, end_date=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.hight_speed_stream" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns data available related to hight speed stream events.</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>start_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to 30 days prior to the current date in UTC time.</li>
<li><strong>end_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to the current date in UTC time.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list. If data is available in the specified date range, a list of dictionary objects representing the data from the API is returned. If no data is available, an empty dictionary is returned.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize API connection with a Demo Key</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">Nasa</span><span class="p">()</span>
<span class="c1"># Get data on hight speed stream events from the beginning of September 2019.</span>
<span class="n">n</span><span class="o">.</span><span class="n">hight_speed_stream</span><span class="p">()</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="Nasa.wsa_enlil_simulation">
<code class="descclassname">Nasa.</code><code class="descname">wsa_enlil_simulation</code><span class="sig-paren">(</span><em>[start_date=None][, end_date=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.wsa_enlil_simulation" title="Permalink to this definition">¶</a></dt>
<dd><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>start_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to 30 days prior to the current date in UTC time.</li>
<li><strong>end_date</strong> – String representing a date in YYYY-MM-DD format or a datetime object. If None, defaults to the current date in UTC time.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list. If data is available in the specified date range, a list of dictionary objects representing the data from the API is returned. If no data is available, an empty dictionary is returned.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize API connection with a Demo Key</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">Nasa</span><span class="p">()</span>
<span class="c1"># Get data from the first simulation performed in 2019.</span>
<span class="n">wsa</span> <span class="o">=</span> <span class="n">n</span><span class="o">.</span><span class="n">wsa_enlil_simulation</span><span class="p">(</span><span class="n">start_date</span><span class="o">=</span><span class="s1">'2019-01-01'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="epic-earth-polychromatic-imaging-camera">
<h3>EPIC (Earth Polychromatic Imaging Camera)<a class="headerlink" href="#epic-earth-polychromatic-imaging-camera" title="Permalink to this headline">¶</a></h3>
<p>The EPIC API provides information on the daily imagery collected by DSCOVR’s Earth Polychromatic Imaging Camera
(EPIC) instrument. Uniquely positioned at the Earth-Sun Lagrange point, EPIC provides full disc imagery of the
Earth and captures unique perspectives of certain astronomical events such as lunar transits using a 2048x2048
pixel CCD (Charge Coupled Device) detector coupled to a 30-cm aperture Cassegrain telescope.</p>
<dl class="method">
<dt id="Nasa.epic">
<code class="descclassname">Nasa.</code><code class="descname">epic</code><span class="sig-paren">(</span><em>[color='natural'][, date=None][, available=False]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.epic" title="Permalink to this definition">¶</a></dt>
<dd><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>color</strong> – Specifies the type of imagery to return. Must be one of ‘natural’ (default) or ‘enhanced’</li>
<li><strong>date</strong> – String representing a date in ‘YYYY-MM-DD’ format or a datetime object</li>
<li><strong>available</strong> – Alternative listing of all dates with specified color imagery</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list. List of dictionaries representing the returned JSON data from the EPIC API.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize API connection with a Demo Key</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">Nasa</span><span class="p">()</span>
<span class="c1"># Get EPIC data from the beginning of 2019.</span>
<span class="n">e</span> <span class="o">=</span> <span class="n">n</span><span class="o">.</span><span class="n">epic</span><span class="p">(</span><span class="n">date</span><span class="o">=</span><span class="s1">'2019-01-01'</span><span class="p">)</span>
<span class="c1"># Print the first result</span>
<span class="n">e</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="earth-satellite-imagery">
<h3>Earth Satellite Imagery<a class="headerlink" href="#earth-satellite-imagery" title="Permalink to this headline">¶</a></h3>
<p>This endpoint retrieves the Landsat 8 image for the supplied location and date. The response will include the date
and URL to the image that is closest to the supplied date. The requested resource may not be available for the
exact date in the request.</p>
<dl class="method">
<dt id="Nasa.earth_imagery">
<code class="descclassname">Nasa.</code><code class="descname">earth_imagery</code><span class="sig-paren">(</span><em>lat, lon[, dim=0.025][, date=None][, cloud_score=False]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.earth_imagery" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the URL and other information from the Landsat 8 image database for the specified lat/lon location and date.</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>lat</strong> – Latitude of the desired imagery location</li>
<li><strong>lon</strong> – Longitude of the desired imagery location</li>
<li><strong>dim</strong> – Width and height of the image in degrees.</li>
<li><strong>date</strong> – Date the image was taken. If specified, must be a string representing a date in ‘YYYY-MM-DD’ format or a datetime object. If None, the most recent image available from the current date is returned.</li>
<li><strong>cloud_score</strong> – Calculate the percentage of the image covered by clouds.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict. Dictionary object representing the returned JSON data from the API.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Initialize API connection with a Demo Key</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">Nasa</span><span class="p">()</span>
<span class="c1"># Get imagery at latitude 1.5, longitude 100.75 and include the computed cloud score calculation.</span>
<span class="n">n</span><span class="o">.</span><span class="n">earth_imagery</span><span class="p">(</span><span class="n">lon</span><span class="o">=</span><span class="mf">100.75</span><span class="p">,</span> <span class="n">lat</span><span class="o">=</span><span class="mf">1.5</span><span class="p">,</span> <span class="n">cloud_score</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="Nasa.earth_assets">
<code class="descclassname">Nasa.</code><code class="descname">earth_assets</code><span class="sig-paren">(</span><em>lat, lon[, dim=0.025][, begin_date=None][, end_date=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.earth_assets" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the datetimes and asset names of available imagery for a specified lat-lon location over a given date range. The satellite that takes the images passes over each point approximately once every sixteen days.</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>lat</strong> – Latitude of the desired imagery location</li>
<li><strong>lon</strong> – Longitude of the desired imagery location</li>
<li><strong>begin_date</strong> – Beginning of date range in which to search for available assets. Must be a string representing a date in ‘YYYY-MM-DD’ format or a datetime object</li>
<li><strong>end_date</strong> – End of date range in which to search for available assets. If not specified, defaults to the current date. If specified, Must be a string representing a date in ‘YYYY-MM-DD’ format or a datetime object</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict. Dictionary object representing the returned JSON data from the API.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Get assets available beginning from 2014-02-01 at lat-lon 100.75, 1.5</span>
<span class="n">n</span><span class="o">.</span><span class="n">earth_assets</span><span class="p">(</span><span class="n">lat</span><span class="o">=</span><span class="mf">100.75</span><span class="p">,</span> <span class="n">lon</span><span class="o">=</span><span class="mf">1.5</span><span class="p">,</span> <span class="n">begin_date</span><span class="o">=</span><span class="s1">'2014-02-01'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="mars-rover-photos">
<h3>Mars Rover Photos<a class="headerlink" href="#mars-rover-photos" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="Nasa.mars_rover">
<code class="descclassname">Nasa.</code><code class="descname">mars_rover</code><span class="sig-paren">(</span><em>[sol=None][, earth_date=None][, camera='all'][, rover='curiosity'][, page=1]</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.mars_rover" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves image data collected by the Mars rovers Curiosity, Discovery and Spirit.</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>sol</strong> – The sol (Martian rotation or day) on which the images were collected. Either this parameter or <code class="code docutils literal notranslate"><span class="pre">earth_date</span></code> must be provided. The parameter <code class="code docutils literal notranslate"><span class="pre">earth_date</span></code> is an alternative parameter for searching for a specific date. The sol values count up from the rover’s landing date, for example, the Curiosity’s 100th sol would be the 100th Martian rotation since the rover landed.</li>
<li><strong>earth_date</strong> – Alternative search parameter for finding data on a specific date. Must be a string representing a date in ‘YYYY-MM-DD’ format or a datetime object. Either <code class="code docutils literal notranslate"><span class="pre">earth_date</span></code> or <code class="code docutils literal notranslate"><span class="pre">sol</span></code> must be specified.</li>
<li><strong>camera</strong> – Filter results to a specific camera on the Mars Curiosity, Opportunity or Spirit rovers. Defaults to ‘all’, which includes all cameras and must be one of {‘all’, FHAZ’, ‘RHAZ’, ‘MAST’, ‘CHEMCAM’, ‘MAHLI’, ‘MARDI’, ‘NAVCAM’, ‘PANCAM’, ‘MINITES’}</li>
<li><strong>rover</strong> – Specifies the Mars rover to return data. Defaults to the Curiosity rover which has more available cameras. Must be one of {‘curiosity’, ‘opportunity’, ‘spirit’}</li>
<li><strong>page</strong> – Page number of results to return. 25 results per page are returned.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list. List of dictionaries representing the returned JSON data from the Mars Rover API.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="genelab-search">
<h3>GeneLab Search<a class="headerlink" href="#genelab-search" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="Nasa.genelab_search">
<code class="descclassname">Nasa.</code><code class="descname">genelab_search</code><span class="sig-paren">(</span><em>term=None</em>, <em>database='cgene'</em>, <em>page=0</em>, <em>size=25</em>, <em>sort=None</em>, <em>order='desc'</em>, <em>ffield=None</em>, <em>fvalue=None</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.genelab_search" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves available data from the GeneLab and other bioinformatics databases such as the National Institutes
of Health (NIH) / National Center for Biotechnology Information (NCBI), Gene Expression Omnibus (GEO), the
European Bioinformatics Institute’s (EBI) Proteomics Identification (PRIDE), and the Argonne National
Laboratory’s (ANL) Metagenomics Rapid Annotations using Subsystems Technology (MG-RAST).</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>term</strong> – Search by specific keyword(s). Case-insensitive boolean operators (AND, OR, NOT) can be used as well to include and filter specific keywords.</li>
<li><strong>database</strong> – Determines the database(s) to query. Defaults to the ‘cgene’ (GeneLab) database, but other available databases include ‘nih_geo_gse’ (NIH GEO), ‘ebi_pride’ (EBI PRIDE), or ‘mg_rast’ (MG-RAST). Multiple databases can be queried by separating values with commas. For example, ‘cgene,nih_geo_gse,ebi_pride,mg_rast’ will query all available databases.</li>
<li><strong>page</strong> – Specifies the page of results to return. Defaults to the first page (0).</li>
<li><strong>size</strong> – Specifies the number of results to return per page. Default is 25 results per page.</li>
<li><strong>sort</strong> – Sorts by a specific field name in the returned JSON data.</li>
<li><strong>order</strong> – Determines the sorting order. Must be one of ‘desc’ (descending) or ‘asc’ (ascending).</li>
<li><strong>ffield</strong> – Filters the returned data based on the defined field. Should be paired with the <code class="code docutils literal notranslate"><span class="pre">fvalue</span></code> parameter. Only the ‘cgene’ (GeneLab) database can be filtered.</li>
<li><strong>fvalue</strong> – Filters the returned data based on value or values in the specified <code class="code docutils literal notranslate"><span class="pre">ffield</span></code> parameter field. Only the ‘cgene’ (GeneLab) database can be filtered.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict. Dictionary object representing the returned JSON data.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Find Gene studies in the cgene database related to 'mouse liver'</span>
<span class="n">n</span><span class="o">.</span><span class="n">genelab_search</span><span class="p">(</span><span class="n">term</span><span class="o">=</span><span class="s1">'mouse liver'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="techport">
<h3>Techport<a class="headerlink" href="#techport" title="Permalink to this headline">¶</a></h3>
<p>The NASA TechPort system provides an API to make technology project data available in a machine-readable format.
This API can be used to export TechPort data into either an XML or a JSON format.</p>
<dl class="method">
<dt id="Nasa.techport">
<code class="descclassname">Nasa.</code><code class="descname">techport</code><span class="sig-paren">(</span><em>[project_id=None][, last_updated=None][, return_format='json']</em><span class="sig-paren">)</span><a class="headerlink" href="#Nasa.techport" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves available NASA project data.</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>project_id</strong> – The ID of the project record. If not specified, all available projects will be returned.</li>
<li><strong>last_updated</strong> – Returns projects only updated after the specified date. Must be a string representing a date in ‘YYYY-MM-DD’ format or a datetime object.</li>
<li><strong>return_format</strong> – Specifies the return format of the data. Defaults to ‘json’, but ‘xml’ formatted data is also available.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict or str. If <code class="code docutils literal notranslate"><span class="pre">return_format</span></code> is ‘json’, a dictionary representing the JSON formatted data is returned. Otherwise, a string formatted for XML is returned.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="tle-two-line-element-set-data">
<h3>TLE (Two-Line Element Set Data)<a class="headerlink" href="#tle-two-line-element-set-data" title="Permalink to this headline">¶</a></h3>
<p>The TLE API provides up to date two line element set records, the data is updated daily from CelesTrak and served
in JSON format. A two-line element set (TLE) is a data format encoding a list of orbital elements of an
Earth-orbiting object for a given point in time.</p>
<dl class="method">
<dt id="tle">
<code class="descname">tle</code><span class="sig-paren">(</span><em>[search_satellite=None][, satellite_number=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#tle" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns two-line element set records provided by CelesTrak.</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>search_satellite</strong> – Searches satellites by name designation.</li>
<li><strong>satellite_number</strong> – Specfic satellite ID number.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict. Specfic satellite ID number.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">tle</span><span class="p">(</span><span class="n">satellite_number</span><span class="o">=</span><span class="mi">43553</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="nasa-image-and-video-library">
<h3>NASA Image and Video Library<a class="headerlink" href="#nasa-image-and-video-library" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="media_search">
<code class="descname">media_search</code><span class="sig-paren">(</span><em>[query=None][, center=None][, description=None][, keywords=None][, location=None][, media_type=None][, nasa_id=None][, page=1][, photographer=None][, secondary_creator=None][, title=None][, year_start=None][, year_end=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#media_search" title="Permalink to this definition">¶</a></dt>
<dd><p>Performs a general search for images from the images.nasa.gov API based on parameters and criteria specified.
At least one parameter must be provided.</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> – Query terms to search.</li>
<li><strong>center</strong> – NASA center that published the results.</li>
<li><strong>description</strong> – Search for specific terms in the ‘description’ field of the resulting data.</li>
<li><strong>keywords</strong> – Search and filter for specific terms in the ‘keywords’ field of the resulting data. Multiple values should be comma-separated.</li>
<li><strong>location</strong> – Filter terms in the ‘locations’ field of the resulting data.</li>
<li><strong>media_type</strong> – Filter results to specific media types. Options include ‘image’, ‘audio’, ‘image,audio’, ‘audio,image’. The default <code class="code docutils literal notranslate"><span class="pre">None</span></code> includes all media types.</li>
<li><strong>nasa_id</strong> – The media asset’s NASA ID.</li>
<li><strong>page</strong> – Page number of results to return. Starts at 1.</li>
<li><strong>photographer</strong> – The primary photographer’s name.</li>
<li><strong>secondary_creator</strong> – A secondary photographer/videographer’s name.</li>
<li><strong>title</strong> – Search terms in the ‘title’ field of the resulting data.</li>
<li><strong>year_start</strong> – The start year for results. If provided, must be a string representing a year in YYYY format or a datetime object.</li>
<li><strong>year_end</strong> – The end year for results. If provided, must be a string representing a year in YYYY format or a datetime object.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict. Dictionary containing matching search results.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Search for media related to 'apollo 11' with 'moon landing' in the description of the items.</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">media_search</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'apollo 11'</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s1">'moon landing'</span><span class="p">)</span>
<span class="c1"># Output the first returned media item from the resulting collection.</span>
<span class="n">r</span><span class="p">[</span><span class="s1">'items'</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="media_asset_manifest">
<code class="descname">media_asset_manifest</code><span class="sig-paren">(</span><em>nasa_id</em><span class="sig-paren">)</span><a class="headerlink" href="#media_asset_manifest" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the media asset’s manifest, which contains the available versions of the asset and it’s metadata
location.</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>nasa_id</strong> – The ID of the media asset.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list. List of dictionaries containing the media asset’s manifest.</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Get the manifest for the NASA media asset 'as11-40-5874'</span>
<span class="n">media_asset_manifest</span><span class="p">(</span><span class="n">nasa_id</span><span class="o">=</span><span class="s1">'as11-40-5874'</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="media_asset_metadata">
<code class="descname">media_asset_metadata</code><span class="sig-paren">(</span><em>nasa_id</em><span class="sig-paren">)</span><a class="headerlink" href="#media_asset_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the specified media asset’s metadata.</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>nasa_id</strong> – The ID of the media asset.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">dict. Dictionary containing the metadata of the provided media asset ID.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="media_asset_captions">
<code class="descname">media_asset_captions</code><span class="sig-paren">(</span><em>nasa_id</em><span class="sig-paren">)</span><a class="headerlink" href="#media_asset_captions" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the captions and location of the captions .srt file for a media asset from the NASA image API.</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>nasa_id</strong> – The ID of the media asset.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">dict. Dictionary object containing the resulting data from the API given the media asset ID. The dictionary will contain two keys, <code class="code docutils literal notranslate"><span class="pre">location</span></code> and <code class="code docutils literal notranslate"><span class="pre">captions</span></code>. The <code class="code docutils literal notranslate"><span class="pre">location</span></code> key can be used to download the .srt file directly while the <code class="code docutils literal notranslate"><span class="pre">captions</span></code> key can be used in conjunction with a library such as srt for parsing media asset captions.</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="solar-system-dynamics-ssd-and-center-for-near-earth-object-studies-cneos">
<h3>Solar System Dynamics (SSD) and Center for Near-Earth Object Studies (CNEOS)<a class="headerlink" href="#solar-system-dynamics-ssd-and-center-for-near-earth-object-studies-cneos" title="Permalink to this headline">¶</a></h3>
<p>The following functions provide a Pythonic interface for NASA’s <a class="reference external" href="https://ssd.jpl.nasa.gov/">Solar System Dynamics</a>
and <a class="reference external" href="https://cneos.jpl.nasa.gov/">Center for Near-Earth Object Studies</a> APIs.</p>
<dl class="method">
<dt id="close_approach">
<code class="descname">close_approach</code><span class="sig-paren">(</span><em>[date_min='now'][, date_max='+60'][, dist_min=None][, dist_max='0.05'][, h_min=None][, h_max=None][, v_inf_min=None][, v_inf_max=None][, v_rel_min=None][, v_rel_max=None][, orbit_class=None][, pha=False][, nea=False][, comet=False][, nea_comet=False][, neo=False][, kind=None][, spk=None][, des=None][, body='Earth'][, sort='date'][, limit=None][, fullname=False]</em><span class="sig-paren">)</span><a class="headerlink" href="#close_approach" title="Permalink to this definition">¶</a></dt>
<dd><p>Provides data for currently known close-approach data for all asteroids and comets in NASA’s Jet Propulsion
Laboratory’s (JPL) <a class="reference external" href="https://ssd.jpl.nasa.gov/sbdb.cgi">Small-Body Database</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>date_min</strong> – Excludes data earlier than the given date. Defaults to ‘now’, representing the current date, but can also be a string representing a date in ‘YYYY-MM-DD’ format or ‘YYYY-MM-DDThh:mm:ss’ format or a datetime object.</li>
<li><strong>date_max</strong> – Excludes data later than the given date. Defaults to ‘+60’, representing 60 days after the <code class="code docutils literal notranslate"><span class="pre">date_min</span></code> parameter. Accepts a string of ‘+D’ where D represents the number of days or a string representing a date in ‘YYYY-MM-DD’ format or ‘YYYY-MM-DDThh:mm:ss’ format or a datetime object. ‘now’ is also an acceptable value and will exclude date later than the current date.</li>
<li><strong>dist_min</strong> – Excludes data with an approach distance less than the given value (if provided). The default unit is AU (astronomical units), and LD (lunar distance) is also available. For example, ‘0.05’ or 0.05 would return AU units whereas ‘0.05LD’ would return LD units.</li>
<li><strong>dist_max</strong> – Excludes data with an approach distance greater than the given value (if specified). The default unit is AU (astronomical units), and LD (lunar distance) is also available. For example, ‘0.05’ would return AU units whereas ‘0.05LD’ would return LD units.</li>
<li><strong>h_min</strong> – Exclude data from objects with H-values less than the given value.</li>
<li><strong>h_max</strong> – Exclude data from objects with H-values greater than the given value.</li>
<li><strong>v_inf_min</strong> – Exclude data with V-infinity less than this positive value in km/s</li>
<li><strong>v_inf_max</strong> – Exclude data with V-infinity greater than this positive value in km/s</li>
<li><strong>v_rel_min</strong> – Exclude data with V-relative less than this positive value in km/s</li>
<li><strong>v_rel_max</strong> – Exclude data with V-relative greater than this positive value in km/s</li>
<li><strong>orbit_class</strong> – Limits data to specified orbit-class</li>
<li><strong>pha</strong> – If True, limits the resulting data to only PHA objects</li>
<li><strong>nea</strong> – If True, limits the returned data to only NEA objects</li>
<li><strong>comet</strong> – If True, limits the returned data to comet objects only</li>
<li><strong>nea_comet</strong> – If True, limits the returned data to NEA comet objects only</li>
<li><strong>neo</strong> – If True, limits the returned data to only NEO objects</li>
<li><strong>kind</strong> – Filters returned data to specified type of object. Available options include ‘a’=asteroid, ‘an’=numbered-asteroids, ‘au’=unnumbered-asteroids, ‘c’=comets, ‘cn’=numbered-comets, ‘cu’=unnumbered-comets, ‘n’=numbered-objects, and ‘u’=unnumbered-objects</li>
<li><strong>spk</strong> – Return data only for the matching SPK-ID.</li>
<li><strong>des</strong> – Filters data to objects matching the given destination.</li>
<li><strong>body</strong> – Filters data to close-approaches of the specified body. ‘ALL’ or ‘*’ returns all close-approaches to the available bodies.</li>
<li><strong>sort</strong> – Sorts the returned data by the specified field. Defaults to ‘date’ ascending. To sort by descending, add a ‘-‘ in front of the sort value, for example, ‘-date’.</li>
<li><strong>limit</strong> – Limit data to the first number of results specified by the parameter. Must be greater than 0.</li>
<li><strong>fullname</strong> – Includes the full-format object name/designation</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Get all close-approach object data in the year 2019 with a maximum approach distance of 0.01AU.</span>
<span class="n">nasapy</span><span class="o">.</span><span class="n">close_approach</span><span class="p">(</span><span class="n">date_min</span><span class="o">=</span><span class="s1">'2019-01-01'</span><span class="p">,</span> <span class="n">date_max</span><span class="o">=</span><span class="s1">'2019-12-31'</span><span class="p">,</span> <span class="n">dist_max</span><span class="o">=</span><span class="mf">0.01</span><span class="p">)</span>
<span class="c1"># Get close-approach data for asteroid 433 Eros within 0.2AU from the years 1900 to 2100.</span>
<span class="n">nasapy</span><span class="o">.</span><span class="n">close_approach</span><span class="p">(</span><span class="n">des</span><span class="o">=</span><span class="s1">'433'</span><span class="p">,</span> <span class="n">date_min</span><span class="o">=</span><span class="s1">'1900-01-01'</span><span class="p">,</span> <span class="n">date_max</span><span class="o">=</span><span class="s1">'2100-01-01'</span><span class="p">,</span> <span class="n">dist_max</span><span class="o">=</span><span class="mf">0.2</span><span class="p">)</span>
<span class="c1"># Return close-approach data from the beginning of 2000 to the beginning of 2020 as a pandas DataFrame.</span>
<span class="n">nasapy</span><span class="o">.</span><span class="n">close_approach</span><span class="p">(</span><span class="n">date_min</span><span class="o">=</span><span class="s1">'2000-01-01'</span><span class="p">,</span> <span class="n">date_max</span><span class="o">=</span><span class="s1">'2020-01-01'</span><span class="p">,</span> <span class="n">return_df</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
</pre></div>
</div>
<p>Each close-approach record is a list containing the following fields in the corresponding order:</p>
<ul class="simple">
<li>des - primary designation of the asteroid or comet (e.g., 443, 2000 SG344)</li>
<li>orbit_id - orbit ID</li>
<li>jd - time of close-approach (JD Ephemeris Time)</li>
<li>cd - time of close-approeach (formatted calendar date/time)</li>
<li>dist - nominal approach distance (au)</li>
<li>dist_min - minimum (3-sigma) approach distance (au)</li>
<li>dist_max - maximum (3-sigma) approach distance (au)</li>
<li>v_rel - velocity relative to the approach body at close approach (km/s)</li>
<li>v_inf - velocity relative to a massless body (km/s)</li>
<li>t_sigma_f - 3-sigma uncertainty in the time of close-approach (formatted in days, hours, and minutes; days are not included if zero; example “13:02” is 13 hours 2 minutes; example “2_09:08” is 2 days 9 hours 8 minutes)</li>
<li>body - name of the close-approach body (e.g., Earth)<ul>
<li>only output if the body query parameters is set to ALL</li>
</ul>
</li>
<li>h - absolute magnitude H (mag)</li>
<li>fullname - formatted full-name/designation of the asteroid or comet<ul>
<li>optional - only output if requested with the appropriate query flag</li>
<li>formatted with leading spaces for column alignment in monospaced font tables</li>
</ul>
</li>
</ul>
</dd></dl>
<dl class="method">
<dt id="fireballs">
<code class="descname">fireballs</code><span class="sig-paren">(</span><em>[date_min=None][, date_max=None][, energy_min=None][, energy_max=None][, impact_e_min=None][, impact_e_max=None][, vel_min=None][, vel_max=None][, alt_min=None][, alt_max=None][, req_loc=False][, req_alt=False][, req_vel=False][, req_vel_comp=False][, vel_comp=False][, sort='date'][, limit=None]</em><span class="sig-paren">)</span><a class="headerlink" href="#fireballs" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns available data on fireballs (objects that burn up in the upper atmosphere of Earth).</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>date_min</strong> – Excludes data earlier than the given date. Can be a string representing a date in ‘YYYY-MM-DD’ format or ‘YYYY-MM-DDThh:mm:ss’ format or a datetime object.</li>
<li><strong>date_max</strong> – Excludes data later than the given date. Can be a string representing a date in ‘YYYY-MM-DD’ format or ‘YYYY-MM-DDThh:mm:ss’ format or a datetime object.</li>
<li><strong>energy_min</strong> – Excludes data with total-radiated-energy less than the positive value of the specified value in joules <span class="math notranslate nohighlight">\(\times 10^{10}\)</span>.</li>
<li><strong>energy_max</strong> – Excludes data with total-radiated-energy greater than the positive value of the specified value in joules <span class="math notranslate nohighlight">\(\times 10^{10}\)</span>.</li>
<li><strong>impact_e_min</strong> – Excludes data with estimated impact energy less than the positive value of the specified value in kilotons (kt)</li>
<li><strong>impact_e_max</strong> – Excludes data with estimated impact energy greater than the positive value of the specified value in kilotons (kt)</li>
<li><strong>vel_min</strong> – Excludes data with velocity-at-peak-brightness less than the positive value of the specified value in km/s</li>
<li><strong>vel_max</strong> – Excludes data with velocity-at-peak-brightness greater than the positive value of the specified value in km/s</li>
<li><strong>alt_min</strong> – Excludes data from objects with an altitude less than the specified value</li>
<li><strong>alt_max</strong> – Excludes data from objects with an altitude greater than the specified value</li>
<li><strong>req_loc</strong> – If True, latitude and longitude required for object to be included in results.</li>
<li><strong>req_alt</strong> – If True, objects without an altitude are excluded.</li>
<li><strong>req_vel</strong> – If True, objects without a velocity are not included in results.</li>
<li><strong>req_vel_comp</strong> – If True, excludes objects without velocity components.</li>
<li><strong>vel_comp</strong> – If True, include velocity components</li>
<li><strong>sort</strong> – Sorts data on specified field. Default sort order is ascending, for descending, prepend a ‘-‘. For example, for date descending, the sort value would be ‘-date’.</li>
<li><strong>limit</strong> – Limits data to the first number of results specified. Must be greater than 0 if passed.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict.</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Get all available data in reverse chronological order</span>
<span class="n">nasapy</span><span class="o">.</span><span class="n">fireballs</span><span class="p">()</span>
<span class="c1"># Return the earlieset record</span>
<span class="n">nasapy</span><span class="o">.</span><span class="n">fireballs</span><span class="p">(</span><span class="n">limit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="c1"># Get data from the beginning of 2019</span>
<span class="n">nasapy</span><span class="o">.</span><span class="n">fireballs</span><span class="p">(</span><span class="n">date_min</span><span class="o">=</span><span class="s1">'2019-01-01'</span><span class="p">)</span>
<span class="c1"># Return fireball data from the beginning of the millennium to the beginning of 2020 as a pandas DataFrame.</span>
<span class="n">nasapy</span><span class="o">.</span><span class="n">fireballs</span><span class="p">(</span><span class="n">date_min</span><span class="o">=</span><span class="s1">'2000-01-01'</span><span class="p">,</span> <span class="n">date_max</span><span class="o">=</span><span class="s1">'2020-01-01'</span><span class="p">,</span> <span class="n">return_df</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="mission_design">