-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathfinance_api.html
More file actions
1032 lines (986 loc) · 50.9 KB
/
finance_api.html
File metadata and controls
1032 lines (986 loc) · 50.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>finance — Matplotlib 2.1.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.1.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 2.1.0 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="font_manager" href="font_manager_api.html" />
<link rel="prev" title="matplotlib.figure.figaspect" href="_as_gen/matplotlib.figure.figaspect.html" />
<link rel="canonical" href="https://matplotlib.org/2.1.2/api/finance_api.html" />
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.1.0). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="font_manager_api.html" title="font_manager"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="_as_gen/matplotlib.figure.figaspect.html" title="matplotlib.figure.figaspect"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><a href="https://www.numfocus.org">
<image src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A">
</a>
<br/>
<a href="http://depsy.org/package/python/matplotlib">
<img src="../_static/depsy_badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">finance</a><ul>
<li><a class="reference internal" href="#module-matplotlib.finance"><code class="docutils literal"><span class="pre">matplotlib.finance</span></code></a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib API</a><ul>
<li>Previous: <a href="_as_gen/matplotlib.figure.figaspect.html" title="previous chapter">matplotlib.figure.figaspect</a></li>
<li>Next: <a href="font_manager_api.html" title="next chapter">font_manager</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/finance_api.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="finance">
<h1>finance<a class="headerlink" href="#finance" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.finance">
<span id="matplotlib-finance"></span><h2><a class="reference internal" href="#module-matplotlib.finance" title="matplotlib.finance"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.finance</span></code></a><a class="headerlink" href="#module-matplotlib.finance" title="Permalink to this headline">¶</a></h2>
<p>A collection of functions for collecting, analyzing and plotting
financial data.</p>
<p>This module is deprecated in 2.0 and has been moved to a module called
<code class="xref py py-obj docutils literal"><span class="pre">mpl_finance</span></code>.</p>
<dl class="function">
<dt id="matplotlib.finance.candlestick2_ochl">
<code class="descclassname">matplotlib.finance.</code><code class="descname">candlestick2_ochl</code><span class="sig-paren">(</span><em>ax</em>, <em>opens</em>, <em>closes</em>, <em>highs</em>, <em>lows</em>, <em>width=4</em>, <em>colorup='k'</em>, <em>colordown='r'</em>, <em>alpha=0.75</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.candlestick2_ochl" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent the open, close as a bar line and high low range as a
vertical line.</p>
<p>Preserves the original argument order.</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"><p class="first"><strong>ax</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code></p>
<blockquote>
<div><p>an Axes instance to plot to</p>
</div></blockquote>
<p><strong>opens</strong> : sequence</p>
<blockquote>
<div><p>sequence of opening values</p>
</div></blockquote>
<p><strong>closes</strong> : sequence</p>
<blockquote>
<div><p>sequence of closing values</p>
</div></blockquote>
<p><strong>highs</strong> : sequence</p>
<blockquote>
<div><p>sequence of high values</p>
</div></blockquote>
<p><strong>lows</strong> : sequence</p>
<blockquote>
<div><p>sequence of low values</p>
</div></blockquote>
<p><strong>ticksize</strong> : int</p>
<blockquote>
<div><p>size of open and close ticks in points</p>
</div></blockquote>
<p><strong>colorup</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close >= open</p>
</div></blockquote>
<p><strong>colordown</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close < open</p>
</div></blockquote>
<p><strong>alpha</strong> : float</p>
<blockquote>
<div><p>bar transparency</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ret</strong> : tuple</p>
<blockquote class="last">
<div><p>(lineCollection, barCollection)</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.candlestick2_ohlc">
<code class="descclassname">matplotlib.finance.</code><code class="descname">candlestick2_ohlc</code><span class="sig-paren">(</span><em>ax</em>, <em>opens</em>, <em>highs</em>, <em>lows</em>, <em>closes</em>, <em>width=4</em>, <em>colorup='k'</em>, <em>colordown='r'</em>, <em>alpha=0.75</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.candlestick2_ohlc" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent the open, close as a bar line and high low range as a
vertical line.</p>
<p>NOTE: this code assumes if any value open, low, high, close is
missing they all are missing</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"><p class="first"><strong>ax</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code></p>
<blockquote>
<div><p>an Axes instance to plot to</p>
</div></blockquote>
<p><strong>opens</strong> : sequence</p>
<blockquote>
<div><p>sequence of opening values</p>
</div></blockquote>
<p><strong>highs</strong> : sequence</p>
<blockquote>
<div><p>sequence of high values</p>
</div></blockquote>
<p><strong>lows</strong> : sequence</p>
<blockquote>
<div><p>sequence of low values</p>
</div></blockquote>
<p><strong>closes</strong> : sequence</p>
<blockquote>
<div><p>sequence of closing values</p>
</div></blockquote>
<p><strong>ticksize</strong> : int</p>
<blockquote>
<div><p>size of open and close ticks in points</p>
</div></blockquote>
<p><strong>colorup</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close >= open</p>
</div></blockquote>
<p><strong>colordown</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close < open</p>
</div></blockquote>
<p><strong>alpha</strong> : float</p>
<blockquote>
<div><p>bar transparency</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ret</strong> : tuple</p>
<blockquote class="last">
<div><p>(lineCollection, barCollection)</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.candlestick_ochl">
<code class="descclassname">matplotlib.finance.</code><code class="descname">candlestick_ochl</code><span class="sig-paren">(</span><em>ax</em>, <em>quotes</em>, <em>width=0.2</em>, <em>colorup='k'</em>, <em>colordown='r'</em>, <em>alpha=1.0</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.candlestick_ochl" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot the time, open, close, high, low as a vertical line ranging
from low to high. Use a rectangular bar to represent the
open-close span. If close >= open, use colorup to color the bar,
otherwise use colordown</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"><p class="first"><strong>ax</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code></p>
<blockquote>
<div><p>an Axes instance to plot to</p>
</div></blockquote>
<p><strong>quotes</strong> : sequence of (time, open, close, high, low, …) sequences</p>
<blockquote>
<div><p>As long as the first 5 elements are these values,
the record can be as long as you want (e.g., it may store volume).</p>
<p>time must be in float days format - see date2num</p>
</div></blockquote>
<p><strong>width</strong> : float</p>
<blockquote>
<div><p>fraction of a day for the rectangle width</p>
</div></blockquote>
<p><strong>colorup</strong> : color</p>
<blockquote>
<div><p>the color of the rectangle where close >= open</p>
</div></blockquote>
<p><strong>colordown</strong> : color</p>
<blockquote>
<div><p>the color of the rectangle where close < open</p>
</div></blockquote>
<p><strong>alpha</strong> : float</p>
<blockquote>
<div><p>the rectangle alpha level</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ret</strong> : tuple</p>
<blockquote class="last">
<div><p>returns (lines, patches) where lines is a list of lines
added and patches is a list of the rectangle patches added</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.candlestick_ohlc">
<code class="descclassname">matplotlib.finance.</code><code class="descname">candlestick_ohlc</code><span class="sig-paren">(</span><em>ax</em>, <em>quotes</em>, <em>width=0.2</em>, <em>colorup='k'</em>, <em>colordown='r'</em>, <em>alpha=1.0</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.candlestick_ohlc" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot the time, open, high, low, close as a vertical line ranging
from low to high. Use a rectangular bar to represent the
open-close span. If close >= open, use colorup to color the bar,
otherwise use colordown</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"><p class="first"><strong>ax</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code></p>
<blockquote>
<div><p>an Axes instance to plot to</p>
</div></blockquote>
<p><strong>quotes</strong> : sequence of (time, open, high, low, close, …) sequences</p>
<blockquote>
<div><p>As long as the first 5 elements are these values,
the record can be as long as you want (e.g., it may store volume).</p>
<p>time must be in float days format - see date2num</p>
</div></blockquote>
<p><strong>width</strong> : float</p>
<blockquote>
<div><p>fraction of a day for the rectangle width</p>
</div></blockquote>
<p><strong>colorup</strong> : color</p>
<blockquote>
<div><p>the color of the rectangle where close >= open</p>
</div></blockquote>
<p><strong>colordown</strong> : color</p>
<blockquote>
<div><p>the color of the rectangle where close < open</p>
</div></blockquote>
<p><strong>alpha</strong> : float</p>
<blockquote>
<div><p>the rectangle alpha level</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ret</strong> : tuple</p>
<blockquote class="last">
<div><p>returns (lines, patches) where lines is a list of lines
added and patches is a list of the rectangle patches added</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.fetch_historical_yahoo">
<code class="descclassname">matplotlib.finance.</code><code class="descname">fetch_historical_yahoo</code><span class="sig-paren">(</span><em>ticker</em>, <em>date1</em>, <em>date2</em>, <em>cachename=None</em>, <em>dividends=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.fetch_historical_yahoo" title="Permalink to this definition">¶</a></dt>
<dd><p>Fetch historical data for ticker between date1 and date2. date1 and
date2 are date or datetime instances, or (year, month, day) sequences.</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"><p class="first"><strong>ticker</strong> : str</p>
<blockquote>
<div><p>ticker</p>
</div></blockquote>
<p><strong>date1</strong> : sequence of form (year, month, day), <a class="reference external" href="https://docs.python.org/2/library/datetime.html#module-datetime" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">datetime</span></code></a>, or <code class="xref py py-obj docutils literal"><span class="pre">date</span></code></p>
<blockquote>
<div><p>start date</p>
</div></blockquote>
<p><strong>date2</strong> : sequence of form (year, month, day), <a class="reference external" href="https://docs.python.org/2/library/datetime.html#module-datetime" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">datetime</span></code></a>, or <code class="xref py py-obj docutils literal"><span class="pre">date</span></code></p>
<blockquote>
<div><p>end date</p>
</div></blockquote>
<p><strong>cachename</strong> : str</p>
<blockquote>
<div><p>cachename is the name of the local file cache. If None, will
default to the md5 hash or the url (which incorporates the ticker
and date range)</p>
</div></blockquote>
<p><strong>dividends</strong> : bool</p>
<blockquote>
<div><p>set dividends=True to return dividends instead of price data. With
this option set, parse functions will not work</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>file_handle</strong> : file handle</p>
<blockquote class="last">
<div><p>a file handle is returned</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fh</span> <span class="o">=</span> <span class="n">fetch_historical_yahoo</span><span class="p">(</span><span class="s1">'^GSPC'</span><span class="p">,</span> <span class="p">(</span><span class="mi">2000</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span> <span class="p">(</span><span class="mi">2001</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">31</span><span class="p">))</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.index_bar">
<code class="descclassname">matplotlib.finance.</code><code class="descname">index_bar</code><span class="sig-paren">(</span><em>ax</em>, <em>vals</em>, <em>facecolor='b'</em>, <em>edgecolor='l'</em>, <em>width=4</em>, <em>alpha=1.0</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.index_bar" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a bar collection graph with height vals (-1 is missing).</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"><p class="first"><strong>ax</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code></p>
<blockquote>
<div><p>an Axes instance to plot to</p>
</div></blockquote>
<p><strong>vals</strong> : sequence</p>
<blockquote>
<div><p>a sequence of values</p>
</div></blockquote>
<p><strong>facecolor</strong> : color</p>
<blockquote>
<div><p>the color of the bar face</p>
</div></blockquote>
<p><strong>edgecolor</strong> : color</p>
<blockquote>
<div><p>the color of the bar edges</p>
</div></blockquote>
<p><strong>width</strong> : int</p>
<blockquote>
<div><p>the bar width in points</p>
</div></blockquote>
<p><strong>alpha</strong> : float</p>
<blockquote>
<div><p>bar transparency</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ret</strong> : <code class="xref py py-obj docutils literal"><span class="pre">barCollection</span></code></p>
<blockquote class="last">
<div><p>The <code class="xref py py-obj docutils literal"><span class="pre">barrCollection</span></code> added to the axes</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.md5">
<code class="descclassname">matplotlib.finance.</code><code class="descname">md5</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.md5" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.finance.parse_yahoo_historical_ochl">
<code class="descclassname">matplotlib.finance.</code><code class="descname">parse_yahoo_historical_ochl</code><span class="sig-paren">(</span><em>fh</em>, <em>adjusted=True</em>, <em>asobject=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.parse_yahoo_historical_ochl" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse the historical data in file handle fh from yahoo finance.</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"><p class="first"><strong>adjusted</strong> : bool</p>
<blockquote>
<div><p>If True (default) replace open, close, high, low prices with
their adjusted values. The adjustment is by a scale factor, S =
adjusted_close/close. Adjusted prices are actual prices
multiplied by S.</p>
<p>Volume is not adjusted as it is already backward split adjusted
by Yahoo. If you want to compute dollars traded, multiply volume
by the adjusted close, regardless of whether you choose adjusted
= True|False.</p>
</div></blockquote>
<p><strong>asobject</strong> : bool or None</p>
<blockquote class="last">
<div><p>If False (default for compatibility with earlier versions)
return a list of tuples containing</p>
<blockquote>
<div><p>d, open, close, high, low, volume</p>
</div></blockquote>
<p>If None (preferred alternative to False), return
a 2-D ndarray corresponding to the list of tuples.</p>
<p>Otherwise return a numpy recarray with</p>
<blockquote>
<div><p>date, year, month, day, d, open, close, high, low,
volume, adjusted_close</p>
</div></blockquote>
<p>where d is a floating poing representation of date,
as returned by date2num, and date is a python standard
library datetime.date instance.</p>
<p>The name of this kwarg is a historical artifact. Formerly,
True returned a cbook Bunch
holding 1-D ndarrays. The behavior of a numpy recarray is
very similar to the Bunch.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.parse_yahoo_historical_ohlc">
<code class="descclassname">matplotlib.finance.</code><code class="descname">parse_yahoo_historical_ohlc</code><span class="sig-paren">(</span><em>fh</em>, <em>adjusted=True</em>, <em>asobject=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.parse_yahoo_historical_ohlc" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse the historical data in file handle fh from yahoo finance.</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"><p class="first"><strong>adjusted</strong> : bool</p>
<blockquote>
<div><p>If True (default) replace open, high, low, close prices with
their adjusted values. The adjustment is by a scale factor, S =
adjusted_close/close. Adjusted prices are actual prices
multiplied by S.</p>
<p>Volume is not adjusted as it is already backward split adjusted
by Yahoo. If you want to compute dollars traded, multiply volume
by the adjusted close, regardless of whether you choose adjusted
= True|False.</p>
</div></blockquote>
<p><strong>asobject</strong> : bool or None</p>
<blockquote class="last">
<div><p>If False (default for compatibility with earlier versions)
return a list of tuples containing</p>
<blockquote>
<div><p>d, open, high, low, close, volume</p>
</div></blockquote>
<p>If None (preferred alternative to False), return
a 2-D ndarray corresponding to the list of tuples.</p>
<p>Otherwise return a numpy recarray with</p>
<blockquote>
<div><p>date, year, month, day, d, open, high, low, close,
volume, adjusted_close</p>
</div></blockquote>
<p>where d is a floating poing representation of date,
as returned by date2num, and date is a python standard
library datetime.date instance.</p>
<p>The name of this kwarg is a historical artifact. Formerly,
True returned a cbook Bunch
holding 1-D ndarrays. The behavior of a numpy recarray is
very similar to the Bunch.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.plot_day_summary2_ochl">
<code class="descclassname">matplotlib.finance.</code><code class="descname">plot_day_summary2_ochl</code><span class="sig-paren">(</span><em>ax</em>, <em>opens</em>, <em>closes</em>, <em>highs</em>, <em>lows</em>, <em>ticksize=4</em>, <em>colorup='k'</em>, <em>colordown='r'</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.plot_day_summary2_ochl" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent the time, open, close, high, low, as a vertical line
ranging from low to high. The left tick is the open and the right
tick is the close.</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"><p class="first"><strong>ax</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code></p>
<blockquote>
<div><p>an Axes instance to plot to</p>
</div></blockquote>
<p><strong>opens</strong> : sequence</p>
<blockquote>
<div><p>sequence of opening values</p>
</div></blockquote>
<p><strong>closes</strong> : sequence</p>
<blockquote>
<div><p>sequence of closing values</p>
</div></blockquote>
<p><strong>highs</strong> : sequence</p>
<blockquote>
<div><p>sequence of high values</p>
</div></blockquote>
<p><strong>lows</strong> : sequence</p>
<blockquote>
<div><p>sequence of low values</p>
</div></blockquote>
<p><strong>ticksize</strong> : int</p>
<blockquote>
<div><p>size of open and close ticks in points</p>
</div></blockquote>
<p><strong>colorup</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close >= open</p>
</div></blockquote>
<p><strong>colordown</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close < open</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ret</strong> : list</p>
<blockquote class="last">
<div><p>a list of lines added to the axes</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.plot_day_summary2_ohlc">
<code class="descclassname">matplotlib.finance.</code><code class="descname">plot_day_summary2_ohlc</code><span class="sig-paren">(</span><em>ax</em>, <em>opens</em>, <em>highs</em>, <em>lows</em>, <em>closes</em>, <em>ticksize=4</em>, <em>colorup='k'</em>, <em>colordown='r'</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.plot_day_summary2_ohlc" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent the time, open, high, low, close as a vertical line
ranging from low to high. The left tick is the open and the right
tick is the close.
<em>opens</em>, <em>highs</em>, <em>lows</em> and <em>closes</em> must have the same length.
NOTE: this code assumes if any value open, high, low, close is
missing (<em>-1</em>) they all are missing</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"><p class="first"><strong>ax</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code></p>
<blockquote>
<div><p>an Axes instance to plot to</p>
</div></blockquote>
<p><strong>opens</strong> : sequence</p>
<blockquote>
<div><p>sequence of opening values</p>
</div></blockquote>
<p><strong>highs</strong> : sequence</p>
<blockquote>
<div><p>sequence of high values</p>
</div></blockquote>
<p><strong>lows</strong> : sequence</p>
<blockquote>
<div><p>sequence of low values</p>
</div></blockquote>
<p><strong>closes</strong> : sequence</p>
<blockquote>
<div><p>sequence of closing values</p>
</div></blockquote>
<p><strong>ticksize</strong> : int</p>
<blockquote>
<div><p>size of open and close ticks in points</p>
</div></blockquote>
<p><strong>colorup</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close >= open</p>
</div></blockquote>
<p><strong>colordown</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close < open</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ret</strong> : list</p>
<blockquote class="last">
<div><p>a list of lines added to the axes</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.plot_day_summary_oclh">
<code class="descclassname">matplotlib.finance.</code><code class="descname">plot_day_summary_oclh</code><span class="sig-paren">(</span><em>ax</em>, <em>quotes</em>, <em>ticksize=3</em>, <em>colorup='k'</em>, <em>colordown='r'</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.plot_day_summary_oclh" title="Permalink to this definition">¶</a></dt>
<dd><p>Plots day summary</p>
<blockquote>
<div>Represent the time, open, close, high, low as a vertical line
ranging from low to high. The left tick is the open and the right
tick is the close.</div></blockquote>
<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"><p class="first"><strong>ax</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code></p>
<blockquote>
<div><p>an <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code> instance to plot to</p>
</div></blockquote>
<p><strong>quotes</strong> : sequence of (time, open, close, high, low, …) sequences</p>
<blockquote>
<div><p>data to plot. time must be in float date format - see date2num</p>
</div></blockquote>
<p><strong>ticksize</strong> : int</p>
<blockquote>
<div><p>open/close tick marker in points</p>
</div></blockquote>
<p><strong>colorup</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close >= open</p>
</div></blockquote>
<p><strong>colordown</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close < open</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>lines</strong> : list</p>
<blockquote class="last">
<div><p>list of tuples of the lines added (one tuple per quote)</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.plot_day_summary_ohlc">
<code class="descclassname">matplotlib.finance.</code><code class="descname">plot_day_summary_ohlc</code><span class="sig-paren">(</span><em>ax</em>, <em>quotes</em>, <em>ticksize=3</em>, <em>colorup='k'</em>, <em>colordown='r'</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.plot_day_summary_ohlc" title="Permalink to this definition">¶</a></dt>
<dd><p>Plots day summary</p>
<blockquote>
<div>Represent the time, open, high, low, close as a vertical line
ranging from low to high. The left tick is the open and the right
tick is the close.</div></blockquote>
<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"><p class="first"><strong>ax</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code></p>
<blockquote>
<div><p>an <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code> instance to plot to</p>
</div></blockquote>
<p><strong>quotes</strong> : sequence of (time, open, high, low, close, …) sequences</p>
<blockquote>
<div><p>data to plot. time must be in float date format - see date2num</p>
</div></blockquote>
<p><strong>ticksize</strong> : int</p>
<blockquote>
<div><p>open/close tick marker in points</p>
</div></blockquote>
<p><strong>colorup</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close >= open</p>
</div></blockquote>
<p><strong>colordown</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close < open</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>lines</strong> : list</p>
<blockquote class="last">
<div><p>list of tuples of the lines added (one tuple per quote)</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.quotes_historical_yahoo_ochl">
<code class="descclassname">matplotlib.finance.</code><code class="descname">quotes_historical_yahoo_ochl</code><span class="sig-paren">(</span><em>ticker</em>, <em>date1</em>, <em>date2</em>, <em>asobject=False</em>, <em>adjusted=True</em>, <em>cachename=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.quotes_historical_yahoo_ochl" title="Permalink to this definition">¶</a></dt>
<dd><p>Get historical data for ticker between date1 and date2.</p>
<p>See <code class="xref py py-func docutils literal"><span class="pre">parse_yahoo_historical()</span></code> for explanation of output formats
and the <em>asobject</em> and <em>adjusted</em> kwargs.</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"><p class="first"><strong>ticker</strong> : str</p>
<blockquote>
<div><p>stock ticker</p>
</div></blockquote>
<p><strong>date1</strong> : sequence of form (year, month, day), <a class="reference external" href="https://docs.python.org/2/library/datetime.html#module-datetime" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">datetime</span></code></a>, or <code class="xref py py-obj docutils literal"><span class="pre">date</span></code></p>
<blockquote>
<div><p>start date</p>
</div></blockquote>
<p><strong>date2</strong> : sequence of form (year, month, day), <a class="reference external" href="https://docs.python.org/2/library/datetime.html#module-datetime" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">datetime</span></code></a>, or <code class="xref py py-obj docutils literal"><span class="pre">date</span></code></p>
<blockquote>
<div><p>end date</p>
</div></blockquote>
<p><strong>cachename</strong> : str or <a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></a></p>
<blockquote class="last">
<div><p>is the name of the local file cache. If None, will
default to the md5 hash or the url (which incorporates the ticker
and date range)</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">sp</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">quotes_historical_yahoo_ochl</span><span class="p">(</span><span class="s1">'^GSPC'</span><span class="p">,</span> <span class="n">d1</span><span class="p">,</span> <span class="n">d2</span><span class="p">,</span>
<span class="go"> asobject=True, adjusted=True)</span>
<span class="gp">>>> </span><span class="n">returns</span> <span class="o">=</span> <span class="p">(</span><span class="n">sp</span><span class="o">.</span><span class="n">open</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="o">-</span> <span class="n">sp</span><span class="o">.</span><span class="n">open</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span><span class="o">/</span><span class="n">sp</span><span class="o">.</span><span class="n">open</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="gp">>>> </span><span class="p">[</span><span class="n">n</span><span class="p">,</span><span class="n">bins</span><span class="p">,</span><span class="n">patches</span><span class="p">]</span> <span class="o">=</span> <span class="n">hist</span><span class="p">(</span><span class="n">returns</span><span class="p">,</span> <span class="mi">100</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">mu</span> <span class="o">=</span> <span class="n">mean</span><span class="p">(</span><span class="n">returns</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">sigma</span> <span class="o">=</span> <span class="n">std</span><span class="p">(</span><span class="n">returns</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">x</span> <span class="o">=</span> <span class="n">normpdf</span><span class="p">(</span><span class="n">bins</span><span class="p">,</span> <span class="n">mu</span><span class="p">,</span> <span class="n">sigma</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">plot</span><span class="p">(</span><span class="n">bins</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s1">'red'</span><span class="p">,</span> <span class="n">lw</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.quotes_historical_yahoo_ohlc">
<code class="descclassname">matplotlib.finance.</code><code class="descname">quotes_historical_yahoo_ohlc</code><span class="sig-paren">(</span><em>ticker</em>, <em>date1</em>, <em>date2</em>, <em>asobject=False</em>, <em>adjusted=True</em>, <em>cachename=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.quotes_historical_yahoo_ohlc" title="Permalink to this definition">¶</a></dt>
<dd><p>Get historical data for ticker between date1 and date2.</p>
<p>See <code class="xref py py-func docutils literal"><span class="pre">parse_yahoo_historical()</span></code> for explanation of output formats
and the <em>asobject</em> and <em>adjusted</em> kwargs.</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"><p class="first"><strong>ticker</strong> : str</p>
<blockquote>
<div><p>stock ticker</p>
</div></blockquote>
<p><strong>date1</strong> : sequence of form (year, month, day), <a class="reference external" href="https://docs.python.org/2/library/datetime.html#module-datetime" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">datetime</span></code></a>, or <code class="xref py py-obj docutils literal"><span class="pre">date</span></code></p>
<blockquote>
<div><p>start date</p>
</div></blockquote>
<p><strong>date2</strong> : sequence of form (year, month, day), <a class="reference external" href="https://docs.python.org/2/library/datetime.html#module-datetime" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">datetime</span></code></a>, or <code class="xref py py-obj docutils literal"><span class="pre">date</span></code></p>
<blockquote>
<div><p>end date</p>
</div></blockquote>
<p><strong>cachename</strong> : str or <a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></a></p>
<blockquote class="last">
<div><p>is the name of the local file cache. If None, will
default to the md5 hash or the url (which incorporates the ticker
and date range)</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">sp</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">quotes_historical_yahoo_ohlc</span><span class="p">(</span><span class="s1">'^GSPC'</span><span class="p">,</span> <span class="n">d1</span><span class="p">,</span> <span class="n">d2</span><span class="p">,</span>
<span class="go"> asobject=True, adjusted=True)</span>
<span class="gp">>>> </span><span class="n">returns</span> <span class="o">=</span> <span class="p">(</span><span class="n">sp</span><span class="o">.</span><span class="n">open</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="o">-</span> <span class="n">sp</span><span class="o">.</span><span class="n">open</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span><span class="o">/</span><span class="n">sp</span><span class="o">.</span><span class="n">open</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="gp">>>> </span><span class="p">[</span><span class="n">n</span><span class="p">,</span><span class="n">bins</span><span class="p">,</span><span class="n">patches</span><span class="p">]</span> <span class="o">=</span> <span class="n">hist</span><span class="p">(</span><span class="n">returns</span><span class="p">,</span> <span class="mi">100</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">mu</span> <span class="o">=</span> <span class="n">mean</span><span class="p">(</span><span class="n">returns</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">sigma</span> <span class="o">=</span> <span class="n">std</span><span class="p">(</span><span class="n">returns</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">x</span> <span class="o">=</span> <span class="n">normpdf</span><span class="p">(</span><span class="n">bins</span><span class="p">,</span> <span class="n">mu</span><span class="p">,</span> <span class="n">sigma</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">plot</span><span class="p">(</span><span class="n">bins</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s1">'red'</span><span class="p">,</span> <span class="n">lw</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.volume_overlay">
<code class="descclassname">matplotlib.finance.</code><code class="descname">volume_overlay</code><span class="sig-paren">(</span><em>ax</em>, <em>opens</em>, <em>closes</em>, <em>volumes</em>, <em>colorup='k'</em>, <em>colordown='r'</em>, <em>width=4</em>, <em>alpha=1.0</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.volume_overlay" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a volume overlay to the current axes. The opens and closes
are used to determine the color of the bar. -1 is missing. If a
value is missing on one it must be missing on all</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"><p class="first"><strong>ax</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code></p>
<blockquote>
<div><p>an Axes instance to plot to</p>
</div></blockquote>
<p><strong>opens</strong> : sequence</p>
<blockquote>
<div><p>a sequence of opens</p>
</div></blockquote>
<p><strong>closes</strong> : sequence</p>
<blockquote>
<div><p>a sequence of closes</p>
</div></blockquote>
<p><strong>volumes</strong> : sequence</p>
<blockquote>
<div><p>a sequence of volumes</p>
</div></blockquote>
<p><strong>width</strong> : int</p>
<blockquote>
<div><p>the bar width in points</p>
</div></blockquote>
<p><strong>colorup</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close >= open</p>
</div></blockquote>
<p><strong>colordown</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close < open</p>
</div></blockquote>
<p><strong>alpha</strong> : float</p>
<blockquote>
<div><p>bar transparency</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ret</strong> : <code class="xref py py-obj docutils literal"><span class="pre">barCollection</span></code></p>
<blockquote class="last">
<div><p>The <code class="xref py py-obj docutils literal"><span class="pre">barrCollection</span></code> added to the axes</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.volume_overlay2">
<code class="descclassname">matplotlib.finance.</code><code class="descname">volume_overlay2</code><span class="sig-paren">(</span><em>ax</em>, <em>closes</em>, <em>volumes</em>, <em>colorup='k'</em>, <em>colordown='r'</em>, <em>width=4</em>, <em>alpha=1.0</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.volume_overlay2" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a volume overlay to the current axes. The closes are used to
determine the color of the bar. -1 is missing. If a value is
missing on one it must be missing on all</p>
<p>nb: first point is not displayed - it is used only for choosing the
right color</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"><p class="first"><strong>ax</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code></p>
<blockquote>
<div><p>an Axes instance to plot to</p>
</div></blockquote>
<p><strong>closes</strong> : sequence</p>
<blockquote>
<div><p>a sequence of closes</p>
</div></blockquote>
<p><strong>volumes</strong> : sequence</p>
<blockquote>
<div><p>a sequence of volumes</p>
</div></blockquote>
<p><strong>width</strong> : int</p>
<blockquote>
<div><p>the bar width in points</p>
</div></blockquote>
<p><strong>colorup</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close >= open</p>
</div></blockquote>
<p><strong>colordown</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close < open</p>
</div></blockquote>
<p><strong>alpha</strong> : float</p>
<blockquote>
<div><p>bar transparency</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ret</strong> : <code class="xref py py-obj docutils literal"><span class="pre">barCollection</span></code></p>
<blockquote class="last">
<div><p>The <code class="xref py py-obj docutils literal"><span class="pre">barrCollection</span></code> added to the axes</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.finance.volume_overlay3">
<code class="descclassname">matplotlib.finance.</code><code class="descname">volume_overlay3</code><span class="sig-paren">(</span><em>ax</em>, <em>quotes</em>, <em>colorup='k'</em>, <em>colordown='r'</em>, <em>width=4</em>, <em>alpha=1.0</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.finance.volume_overlay3" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a volume overlay to the current axes. quotes is a list of (d,
open, high, low, close, volume) and close-open is used to
determine the color of the bar</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"><p class="first"><strong>ax</strong> : <code class="xref py py-obj docutils literal"><span class="pre">Axes</span></code></p>
<blockquote>
<div><p>an Axes instance to plot to</p>
</div></blockquote>
<p><strong>quotes</strong> : sequence of (time, open, high, low, close, …) sequences</p>
<blockquote>
<div><p>data to plot. time must be in float date format - see date2num</p>
</div></blockquote>
<p><strong>width</strong> : int</p>
<blockquote>
<div><p>the bar width in points</p>
</div></blockquote>
<p><strong>colorup</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close1 >= close0</p>
</div></blockquote>
<p><strong>colordown</strong> : color</p>
<blockquote>
<div><p>the color of the lines where close1 < close0</p>
</div></blockquote>
<p><strong>alpha</strong> : float</p>
<blockquote>
<div><p>bar transparency</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ret</strong> : <code class="xref py py-obj docutils literal"><span class="pre">barCollection</span></code></p>
<blockquote class="last">
<div><p>The <code class="xref py py-obj docutils literal"><span class="pre">barrCollection</span></code> added to the axes</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>