-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
1770 lines (1754 loc) · 64.1 KB
/
openapi.yaml
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
openapi: 3.0.3
info:
title: Market Data API
description: >-
Somos un centro de información que analiza el mercado bursátil, financiero y
econonómico.
version: 1.0.0
termsOfService: https://www.marketdata.app/terms/
contact:
email: support@marketdata.app
servers:
- url: https://api.marketdata.app
tags:
- name: v1
paths:
/v1/indices/candles/{resolution}/{symbol}:
get:
tags:
- v1
operationId: V1_indicesCandlesRetrieve
security:
- Api Authentication: []
- {}
description: Get historical price candles for an index.
parameters:
- description: >-
The format parameter is used to specify the format for your data. We
support JSON and CSV formats. The default format is JSON.
in: query
name: format
schema:
type: string
enum:
- csv
- json
- description: |-
The duration of each candle.
Minutely Resolutions: (1, 3, 5, 15, 30, 45, ...)
Hourly Resolutions: (H, 1H, 2H, ...)
Daily Resolutions: (D, 1D, 2D, ...)
Weekly Resolutions: (W, 1W, 2W, ...)
Monthly Resolutions: (M, 1M, 2M, ...)
Yearly Resolutions:(Y, 1Y, 2Y, ...)')
in: path
name: resolution
schema:
type: string
required: true
- description: >-
The index's ticker symbol. If no exchange is specified. You may
embed the exchange in the ticker symbol using the Yahoo Finance or
TradingView formats.
in: path
name: symbol
schema:
type: string
required: true
- description: >-
Use to lookup historical candles from a specific trading day.
Accepted date inputs: ISO 8601, unix, spreadsheet.
in: query
name: date
schema:
type: string
format: date
- description: >-
The leftmost candle on a chart (inclusive). If you use countback, to
is not required. Accepted timestamp inputs: ISO 8601, unix,
spreadsheet.
in: query
name: from
schema:
type: string
format: date
- description: >-
The rightmost candle on a chart (not inclusive). Accepted timestamp
inputs: ISO 8601, unix, spreadsheet.
in: query
name: to
schema:
type: string
format: date
- description: >-
Countback will fetch a number of candles before (to the left of) to
If you use from, countback is not required.
in: query
name: countback
schema:
type: integer
- description: >-
The dateformat parameter allows you specify the format you wish to
receive date and time information in.
in: query
name: dateformat
schema:
type: string
enum:
- spreadsheet
- timestamp
- unix
- description: >-
The limit parameter allows you to limit the number of results for a
particular API call or override an endpoint’s default limits to get
more data.
in: query
name: limit
schema:
type: integer
- description: >-
The offset parameter is used together with limit to allow you to
implement pagination in your application. Offset will allow you to
return values starting at a certain value.
in: query
name: offset
schema:
type: integer
- description: >-
The headers parameter is used to turn off headers when using CSV
output.
in: query
name: headers
schema:
type: boolean
- description: >-
The columns parameter is used to limit the results and only request
the columns you need. The most common use of this feature is to
embed a single numeric result from one of the end points in a
spreadsheet cell.
in: query
name: columns
schema:
type: string
- description: >-
Use human-readable attribute names in the JSON or CSV output instead
of the standard camelCase attribute names.
in: query
name: human
schema:
type: boolean
responses:
'200':
description: No response body
/v1/indices/quotes/{symbol}:
get:
tags:
- v1
operationId: V1_indicesQuotesGet
security:
- Api Authentication: []
- {}
description: Get last quote for an index.
parameters:
- description: >-
The format parameter is used to specify the format for your data. We
support JSON and CSV formats. The default format is JSON.
in: query
name: format
schema:
type: string
enum:
- csv
- json
- description: >-
The index's ticker symbol. If no exchange is specified. You may
embed the exchange in the ticker symbol using the Yahoo Finance or
TradingView formats.
in: path
name: symbol
schema:
type: string
required: true
- description: >-
The dateformat parameter allows you specify the format you wish to
receive date and time information in.
in: query
name: dateformat
schema:
type: string
enum:
- spreadsheet
- timestamp
- unix
- description: >-
The limit parameter allows you to limit the number of results for a
particular API call or override an endpoint's default limits to get
more data.
in: query
name: limit
schema:
type: integer
- description: >-
The offset parameter is used together with limit to allow you to
implement pagination in your application. Offset will allow you to
return values starting at a certain value.
in: query
name: offset
schema:
type: integer
- description: >-
The headers parameter is used to turn off headers when using CSV
output.
in: query
name: headers
schema:
type: boolean
- description: >-
The columns parameter is used to limit the results and only request
the columns you need. The most common use of this feature is to
embed a single numeric result from one of the end points in a
spreadsheet cell.
in: query
name: columns
schema:
type: string
- description: >-
Use human-readable attribute names in the JSON or CSV output instead
of the standard camelCase attribute names.
in: query
name: human
schema:
type: boolean
responses:
'200':
description: No response body
/v1/markets/status:
get:
tags:
- v1
operationId: V1_marketsStatusRetrieve
security:
- Api Authentication: []
- {}
description: Get market status ("open" or "closed") for a date or range of dates.
parameters:
- description: >-
The format parameter is used to specify the format for your data. We
support JSON and CSV formats. The default format is JSON.
in: query
name: format
schema:
type: string
enum:
- csv
- json
- description: >-
Use to lookup status from a specific trading day. Accepted date
inputs: ISO 8601, unix, spreadsheet.
in: query
name: date
schema:
type: string
format: date
- description: >-
Limit the status to dates after from (inclusive). Should be combined
with to to create a range. Accepted date inputs: ISO 8601, unix,
spreadsheet.
in: query
name: from
schema:
type: string
format: date
- description: >-
Limit the status to dates before to (inclusive). Should be combined
with from to create a range. Accepted date inputs: ISO 8601, unix,
spreadsheet.
in: query
name: to
schema:
type: string
format: date
- description: >-
Countback will fetch a number of dates before (to the left of) to.
If you use from, countback is not required.
in: query
name: countback
schema:
type: integer
- description: >-
Use to specify the country of the exchange. Use the two digit ISO
3166 country code. If no country is specified, US exchanges will be
assumed.
in: query
name: country
schema:
type: string
- description: >-
The dateformat parameter allows you specify the format you wish to
receive date and time information in.
in: query
name: dateformat
schema:
type: string
enum:
- spreadsheet
- timestamp
- unix
- description: >-
The limit parameter allows you to limit the number of results for a
particular API call or override an endpoint’s default limits to get
more data.
in: query
name: limit
schema:
type: integer
- description: >-
The offset parameter is used together with limit to allow you to
implement pagination in your application. Offset will allow you to
return values starting at a certain value.
in: query
name: offset
schema:
type: integer
- description: >-
The headers parameter is used to turn off headers when using CSV
output.
in: query
name: headers
schema:
type: boolean
- description: >-
The columns parameter is used to limit the results and only request
the columns you need. The most common use of this feature is to
embed a single numeric result from one of the end points in a
spreadsheet cell.
in: query
name: columns
schema:
type: string
- description: >-
Use human-readable attribute names in the JSON or CSV output instead
of the standard camelCase attribute names.
in: query
name: human
schema:
type: boolean
responses:
'200':
description: No response body
/v1/options/chain/{underlying}:
get:
tags:
- v1
operationId: V1_optionsChainRetrieve
security:
- Api Authentication: []
- {}
description: >-
Get a current or historical end of day options chain for an underlying
ticker symbol.
Optional parameters allow for extensive filtering of the chain.
Use the optionSymbol returned from this endpoint to get quotes, greeks,
or other information using the other endpoints.
parameters:
- description: >-
The format parameter is used to specify the format for your data. We
support JSON and CSV formats. The default format is JSON.
in: query
name: format
schema:
type: string
enum:
- csv
- json
- description: >-
The underlying ticker symbol for the options chain you wish to
lookup.
Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)
in: path
name: underlying
schema:
type: string
required: true
- description: >-
Use to lookup a historical end of day options chain from a specific
trading day. If no date is specified the chain will be the most
current chain available during market hours. When the market is
closed the chain will be from the last trading day. Accepted date
inputs: ISO 8601, unix, spreadsheet.
in: query
name: date
schema:
type: string
format: date
- description: >-
Limit the option chain to a specific expiration date. Accepted date
inputs: ISO 8601, unix, spreadsheet. If omitted all expirations will
be returned.
in: query
name: expiration
schema:
type: string
format: date
- description: >-
Limit the option chain to expiration dates after from (inclusive).
Should be combined with to to create a range. Accepted date inputs:
ISO 8601, unix, spreadsheet. If omitted all expirations will be
returned.
in: query
name: from
schema:
type: string
format: date
- description: >-
Limit the option chain to expiration dates before to (not
inclusive). Should be combined with from to create a range. Accepted
date inputs: ISO 8601, unix, spreadsheet. If omitted all expirations
will be returned.
in: query
name: to
schema:
type: string
format: date
- description: >-
Limit the option chain to options that expire in a specific month
(1-12).
in: query
name: month
schema:
type: integer
- description: Limit the option chain to options that expire in a specific year.
in: query
name: year
schema:
type: integer
- description: >-
Limit the option chain to weekly expirations by setting weekly to
true and omitting the monthly and quarterly parameters. If set to
false, no weekly expirations will be returned.
in: query
name: weekly
schema:
type: boolean
- description: >-
Limit the option chain to standard monthly expirations by setting
monthly to true and omitting the weekly and quarterly parameters. If
set to false, no monthly expirations will be returned.
in: query
name: monthly
schema:
type: boolean
- description: >-
Limit the option chain to quarterly expirations by setting quarterly
to true and omitting the weekly and monthly parameters. If set to
false, no quarterly expirations will be returned.
in: query
name: quarterly
schema:
type: boolean
- description: >-
Days to expiry. Limit the option chain to a single expiration date
closest to the dte provided. Should not be used together with from
and to. Take care before combining with weekly, monthly, quarterly,
since that will limit the expirations dte can return. If you are
using the date parameter, dte is relative to the date provided.
in: query
name: dte
schema:
type: integer
- description: >-
Limit the option chain to either call or put. If omitted, both sides
will be returned.
in: query
name: side
schema:
type: string
enum:
- call
- put
- description: >-
Limit the option chain to strikes that are in the money, out of the
money, or include all. If omitted all options will be returned.
Valid inputs: itm, otm, all.
in: query
name: range
schema:
type: string
enum:
- all
- itm
- otm
- description: >-
Limit the option chain to options with the specific strike
specified.
in: query
name: strike
schema:
type: number
format: float
- description: >-
Limit the option chain to options with an open interest greater than
or equal to the number provided. Can be combined with minVolume and
minLiquidity to further filter.
in: query
name: minOpenInterest
schema:
type: number
format: float
- description: >-
Limit the option chain to options with an volume transacted greater
than or equal to the number provided.
in: query
name: minVolume
schema:
type: integer
- description: >-
Limit the option chain to options with a bid-ask spread less than or
equal to the number provided.
in: query
name: maxBidAskSpread
schema:
type: number
format: float
- description: >-
Limit the option chain to options with a bid-ask spread less than or
equal to the percent provided (relative to the underlying). For
example, a value of 0.5% would exclude all options trading with a
bid-ask spread greater than $1.00 in an underlying that trades at
$200.
in: query
name: maxBidAskSpreadPct
schema:
type: number
format: float
- description: >-
Include non-standard contracts by nonstandard to true. If set to
false, no non-standard options expirations will be returned. If no
parameter is provided, the output will default to false.
in: query
name: nonstandard
schema:
type: boolean
- description: >-
The dateformat parameter allows you specify the format you wish to
receive date and time information in.
in: query
name: dateformat
schema:
type: string
enum:
- spreadsheet
- timestamp
- unix
- description: >-
The limit parameter allows you to limit the number of results for a
particular API call or override an endpoint’s default limits to get
more data.
in: query
name: limit
schema:
type: integer
- description: >-
The offset parameter is used together with limit to allow you to
implement pagination in your application. Offset will allow you to
return values starting at a certain value.
in: query
name: offset
schema:
type: integer
- description: >-
The headers parameter is used to turn off headers when using CSV
output.
in: query
name: headers
schema:
type: boolean
- description: >-
The columns parameter is used to limit the results and only request
the columns you need. The most common use of this feature is to
embed a single numeric result from one of the end points in a
spreadsheet cell.
in: query
name: columns
schema:
type: string
- in: query
name: symbol_lookup
schema:
type: boolean
- description: Include quotes
in: query
name: quote
schema:
type: boolean
- description: >-
Use human-readable attribute names in the JSON or CSV output instead
of the standard camelCase attribute names.
in: query
name: human
schema:
type: boolean
responses:
'200':
description: No response body
/v1/options/expirations/{underlying}:
get:
tags:
- v1
operationId: V1_optionsExpirationsList
security:
- Api Authentication: []
- {}
description: >-
Get a list of current or historical option expiration dates for an
underlying symbol.
If no optional parameters are used, the endpoint returns the expirations
for strike in the chain.
parameters:
- description: >-
The format parameter is used to specify the format for your data. We
support JSON and CSV formats. The default format is JSON.
in: query
name: format
schema:
type: string
enum:
- csv
- json
- description: >-
The underlying ticker symbol for the options chain you wish to
lookup.
Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)
in: path
name: underlying
schema:
type: string
required: true
- description: >-
Limit the lookup of expiration dates to the strike provide. This
will cause the endpoint to only return expiration dates that include
this strike.
in: query
name: strike
schema:
type: number
format: float
- description: >-
Use to lookup a historical list of expiration dates from a specific
previous trading day. If date is omitted the expiration dates will
be from the current trading day during market hours or from the last
trading day when the market is closed. Accepted date inputs: ISO
8601, unix, spreadsheet.
in: query
name: date
schema:
type: string
format: date
- description: >-
The dateformat parameter allows you specify the format you wish to
receive date and time information in.
in: query
name: dateformat
schema:
type: string
enum:
- spreadsheet
- timestamp
- unix
- description: >-
The limit parameter allows you to limit the number of results for a
particular API call or override an endpoint’s default limits to get
more data.
in: query
name: limit
schema:
type: integer
- description: >-
The offset parameter is used together with limit to allow you to
implement pagination in your application. Offset will allow you to
return values starting at a certain value.
in: query
name: offset
schema:
type: integer
- description: >-
The headers parameter is used to turn off headers when using CSV
output.
in: query
name: headers
schema:
type: boolean
- description: >-
The columns parameter is used to limit the results and only request
the columns you need. The most common use of this feature is to
embed a single numeric result from one of the end points in a
spreadsheet cell.
in: query
name: columns
schema:
type: string
- in: query
name: symbol_lookup
schema:
type: boolean
- description: >-
Use human-readable attribute names in the JSON or CSV output instead
of the standard camelCase attribute names.
in: query
name: human
schema:
type: boolean
responses:
'200':
description: No response body
/v1/options/lookup/{userInput}:
get:
tags:
- v1
operationId: V1_optionsSymbolGet
security:
- Api Authentication: []
- {}
description: >-
Generate a properly formatted OCC option symbol based on the user's
human-readable description of an option.
This endpoint converts text such as "AAPL 7/26/23 $200 Call" to OCC
option symbol format: AAPL230726C00200000.
The user input must be URL-encoded.
parameters:
- in: query
name: format
schema:
type: string
enum:
- csv
- json
- description: >-
The human-readable string input that contains (1) stock symbol (2)
strike (3) expiration date (4) option side (i.e. put or call). This
endpoint will translate the user's input into a valid OCC option
symbol.
in: path
name: userInput
schema:
type: string
required: true
responses:
'200':
description: No response body
/v1/options/quotes/{optionSymbol}:
get:
tags:
- v1
operationId: V1_optionsQuotesRetrieve
security:
- Api Authentication: []
- {}
description: >-
Get a current or historical end of day quote for a single or multiple
options contracts.
Separate multiple options symbols with a comma.
parameters:
- description: >-
The format parameter is used to specify the format for your data. We
support JSON and CSV formats. The default format is JSON.
in: query
name: format
schema:
type: string
enum:
- csv
- json
- description: >-
The option symbol (as defined by the OCC) for the option you wish to
lookup. Use the current OCC option symbol format, even for historic
options that quoted before the format change in 2010.
in: path
name: optionSymbol
schema:
type: string
required: true
- description: >-
Use to lookup a historical end of day quote from a specific trading
day. If no date is specified the quote will be the most current
price available during market hours. When the market is closed the
quote will be from the last trading day. Accepted date inputs: ISO
8601, unix, spreadsheet.
in: query
name: date
schema:
type: string
format: date
- description: >-
Use to lookup a series of end of day quotes. From is the oldest
(leftmost) date to return (inclusive). If from/to is not specified
the quote will be the most current price available during market
hours. When the market is closed the quote will be from the last
trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.
in: query
name: from
schema:
type: string
format: date
- description: >-
Use to lookup a series of end of day quotes. To is the newest
(rightmost) date to return (exclusive). If from/to is not specified
the quote will be the most current price available during market
hours. When the market is closed the quote will be from the last
trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.
in: query
name: to
schema:
type: string
format: date
- description: >-
Countback will fetch a number of quotes before (to the left of) to
If you use from, countback is not required.
in: query
name: countback
schema:
type: integer
- description: >-
The dateformat parameter allows you specify the format you wish to
receive date and time information in.
in: query
name: dateformat
schema:
type: string
enum:
- spreadsheet
- timestamp
- unix
- description: >-
The limit parameter allows you to limit the number of results for a
particular API call or override an endpoint’s default limits to get
more data.
in: query
name: limit
schema:
type: integer
- description: >-
The offset parameter is used together with limit to allow you to
implement pagination in your application. Offset will allow you to
return values starting at a certain value.
in: query
name: offset
schema:
type: integer
- description: >-
The headers parameter is used to turn off headers when using CSV
output.
in: query
name: headers
schema:
type: boolean
- description: >-
The columns parameter is used to limit the results and only request
the columns you need. The most common use of this feature is to
embed a single numeric result from one of the end points in a
spreadsheet cell.
in: query
name: columns
schema:
type: string
- description: >-
Use human-readable attribute names in the JSON or CSV output instead
of the standard camelCase attribute names.
in: query
name: human
schema:
type: boolean
responses:
'200':
description: No response body
/v1/options/strikes/{underlying}:
get:
tags:
- v1
operationId: V1_optionsStrikesGet
security:
- Api Authentication: []
- {}
description: >-
Get a list of current or historical options strikes for an underlying
symbol.
If no optional parameters are used, the endpoint returns the strikes for
every expiration in the chain.
parameters:
- description: >-
The format parameter is used to specify the format for your data. We
support JSON and CSV formats. The default format is JSON.
in: query
name: format
schema:
type: string
enum:
- csv
- json
- description: >-
The underlying ticker symbol for the options chain you wish to
lookup.
Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)
in: path
name: underlying
schema:
type: string
required: true
- description: >-
Use to lookup a historical list of strikes from a specific previous
trading day. If date is omitted the strikes will be from the current
trading day during market hours or from the last trading day when
the market is closed. Accepted date inputs: ISO 8601, unix,
spreadsheet.
in: query
name: date
schema:
type: string
format: date
- description: >-
imit the lookup of strikes to options that expire on a specific
expiration date. Accepted date inputs: ISO 8601, unix, spreadsheet.
in: query
name: expiration
schema:
type: string
format: date
- description: >-
The dateformat parameter allows you specify the format you wish to
receive date and time information in.
in: query
name: dateformat
schema:
type: string
enum:
- spreadsheet
- timestamp
- unix
- description: >-
The limit parameter allows you to limit the number of results for a
particular API call or override an endpoint’s default limits to get
more data.
in: query
name: limit
schema:
type: integer
- description: >-
The offset parameter is used together with limit to allow you to
implement pagination in your application. Offset will allow you to
return values starting at a certain value.
in: query
name: offset
schema:
type: integer
- description: >-
The headers parameter is used to turn off headers when using CSV
output.
in: query
name: headers
schema:
type: boolean
- description: >-
The columns parameter is used to limit the results and only request
the columns you need. The most common use of this feature is to
embed a single numeric result from one of the end points in a
spreadsheet cell.
in: query
name: columns
schema:
type: string
- in: query
name: symbol_lookup
schema:
type: boolean
- description: >-
Use human-readable attribute names in the JSON or CSV output instead
of the standard camelCase attribute names.
in: query
name: human
schema:
type: boolean
responses:
'200':
description: No response body
/v1/stocks/bulkcandles/{resolution}:
get:
tags:
- v1
operationId: V1_stocksBulkcandlesGet
security:
- Api Authentication: []
- {}
description: >-
Get bulk candle data for stocks. This endpoint returns bulk daily candle
data for multiple stocks.
parameters:
- description: >-
The format parameter is used to specify the format for your data. We
support JSON and CSV formats. The default format is JSON.
in: query
name: format
schema: